59 lines
3.3 KiB
XML
59 lines
3.3 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="GLTFCamera" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
|
<brief_description>
|
|
Represents a GLTF camera.
|
|
</brief_description>
|
|
<description>
|
|
Represents a camera as defined by the base GLTF spec.
|
|
</description>
|
|
<tutorials>
|
|
<link title="Runtime file loading and saving">$DOCS_URL/tutorials/io/runtime_file_loading_and_saving.html</link>
|
|
<link title="GLTF camera detailed specification">https://registry.khronos.org/glTF/specs/2.0/glTF-2.0.html#reference-camera</link>
|
|
<link title="GLTF camera spec and example file">https://github.com/KhronosGroup/glTF-Tutorials/blob/master/gltfTutorial/gltfTutorial_015_SimpleCameras.md</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="from_dictionary" qualifiers="static">
|
|
<return type="GLTFCamera" />
|
|
<param index="0" name="dictionary" type="Dictionary" />
|
|
<description>
|
|
Creates a new GLTFCamera instance by parsing the given [Dictionary].
|
|
</description>
|
|
</method>
|
|
<method name="from_node" qualifiers="static">
|
|
<return type="GLTFCamera" />
|
|
<param index="0" name="camera_node" type="Camera3D" />
|
|
<description>
|
|
Create a new GLTFCamera instance from the given Godot [Camera3D] node.
|
|
</description>
|
|
</method>
|
|
<method name="to_dictionary" qualifiers="const">
|
|
<return type="Dictionary" />
|
|
<description>
|
|
Serializes this GLTFCamera instance into a [Dictionary].
|
|
</description>
|
|
</method>
|
|
<method name="to_node" qualifiers="const">
|
|
<return type="Camera3D" />
|
|
<description>
|
|
Converts this GLTFCamera instance into a Godot [Camera3D] node.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="depth_far" type="float" setter="set_depth_far" getter="get_depth_far" default="4000.0">
|
|
The distance to the far culling boundary for this camera relative to its local Z axis, in meters. This maps to GLTF's [code]zfar[/code] property.
|
|
</member>
|
|
<member name="depth_near" type="float" setter="set_depth_near" getter="get_depth_near" default="0.05">
|
|
The distance to the near culling boundary for this camera relative to its local Z axis, in meters. This maps to GLTF's [code]znear[/code] property.
|
|
</member>
|
|
<member name="fov" type="float" setter="set_fov" getter="get_fov" default="1.309">
|
|
The FOV of the camera. This class and GLTF define the camera FOV in radians, while Godot uses degrees. This maps to GLTF's [code]yfov[/code] property. This value is only used for perspective cameras, when [member perspective] is true.
|
|
</member>
|
|
<member name="perspective" type="bool" setter="set_perspective" getter="get_perspective" default="true">
|
|
Whether or not the camera is in perspective mode. If false, the camera is in orthographic/orthogonal mode. This maps to GLTF's camera [code]type[/code] property. See [member Camera3D.projection] and the GLTF spec for more information.
|
|
</member>
|
|
<member name="size_mag" type="float" setter="set_size_mag" getter="get_size_mag" default="0.5">
|
|
The size of the camera. This class and GLTF define the camera size magnitude as a radius in meters, while Godot defines it as a diameter in meters. This maps to GLTF's [code]ymag[/code] property. This value is only used for orthographic/orthogonal cameras, when [member perspective] is false.
|
|
</member>
|
|
</members>
|
|
</class>
|