diff options
Diffstat (limited to 'doc/classes/Camera3D.xml')
| -rw-r--r-- | doc/classes/Camera3D.xml | 243 |
1 files changed, 243 insertions, 0 deletions
diff --git a/doc/classes/Camera3D.xml b/doc/classes/Camera3D.xml new file mode 100644 index 0000000000..598b4bd685 --- /dev/null +++ b/doc/classes/Camera3D.xml @@ -0,0 +1,243 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Camera3D" inherits="Node3D" version="4.0"> + <brief_description> + Camera node, displays from a point of view. + </brief_description> + <description> + [Camera3D] is a special node that displays what is visible from its current location. Cameras register themselves in the nearest [Viewport] node (when ascending the tree). Only one camera can be active per viewport. If no viewport is available ascending the tree, the camera will register in the global viewport. In other words, a camera just provides 3D display capabilities to a [Viewport], and, without one, a scene registered in that [Viewport] (or higher viewports) can't be displayed. + </description> + <tutorials> + </tutorials> + <methods> + <method name="clear_current"> + <return type="void"> + </return> + <argument index="0" name="enable_next" type="bool" default="true"> + </argument> + <description> + If this is the current camera, remove it from being current. If [code]enable_next[/code] is [code]true[/code], request to make the next camera current, if any. + </description> + </method> + <method name="get_camera_rid" qualifiers="const"> + <return type="RID"> + </return> + <description> + Returns the camera's RID from the [RenderingServer]. + </description> + </method> + <method name="get_camera_transform" qualifiers="const"> + <return type="Transform"> + </return> + <description> + Gets the camera transform. Subclassed cameras such as [ClippedCamera3D] may provide different transforms than the [Node] transform. + </description> + </method> + <method name="get_cull_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> + Returns [code]true[/code] if the given [code]layer[/code] in the [member cull_mask] is enabled, [code]false[/code] otherwise. + </description> + </method> + <method name="get_frustum" qualifiers="const"> + <return type="Array"> + </return> + <description> + Returns the camera's frustum planes in world-space units as an array of [Plane]s in the following order: near, far, left, top, right, bottom. Not to be confused with [member frustum_offset]. + </description> + </method> + <method name="is_position_behind" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="world_point" type="Vector3"> + </argument> + <description> + Returns [code]true[/code] if the given position is behind the camera. + [b]Note:[/b] A position which returns [code]false[/code] may still be outside the camera's field of view. + </description> + </method> + <method name="make_current"> + <return type="void"> + </return> + <description> + Makes this camera the current camera for the [Viewport] (see class description). If the camera node is outside the scene tree, it will attempt to become current once it's added. + </description> + </method> + <method name="project_local_ray_normal" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="screen_point" type="Vector2"> + </argument> + <description> + Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc. + </description> + </method> + <method name="project_position" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="screen_point" type="Vector2"> + </argument> + <argument index="1" name="z_depth" type="float"> + </argument> + <description> + Returns the 3D point in worldspace that maps to the given 2D coordinate in the [Viewport] rectangle on a plane that is the given [code]z_depth[/code] distance into the scene away from the camera. + </description> + </method> + <method name="project_ray_normal" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="screen_point" type="Vector2"> + </argument> + <description> + Returns a normal vector in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. + </description> + </method> + <method name="project_ray_origin" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="screen_point" type="Vector2"> + </argument> + <description> + Returns a 3D position in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. + </description> + </method> + <method name="set_cull_mask_bit"> + <return type="void"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + Enables or disables the given [code]layer[/code] in the [member cull_mask]. + </description> + </method> + <method name="set_frustum"> + <return type="void"> + </return> + <argument index="0" name="size" type="float"> + </argument> + <argument index="1" name="offset" type="Vector2"> + </argument> + <argument index="2" name="z_near" type="float"> + </argument> + <argument index="3" name="z_far" type="float"> + </argument> + <description> + Sets the camera projection to frustum mode (see [constant PROJECTION_FRUSTUM]), by specifying a [code]size[/code], an [code]offset[/code], and the [code]z_near[/code] and [code]z_far[/code] clip planes in world-space units. + </description> + </method> + <method name="set_orthogonal"> + <return type="void"> + </return> + <argument index="0" name="size" type="float"> + </argument> + <argument index="1" name="z_near" type="float"> + </argument> + <argument index="2" name="z_far" type="float"> + </argument> + <description> + Sets the camera projection to orthogonal mode (see [constant PROJECTION_ORTHOGONAL]), by specifying a [code]size[/code], and the [code]z_near[/code] and [code]z_far[/code] clip planes in world-space units. (As a hint, 2D games often use this projection, with values specified in pixels.) + </description> + </method> + <method name="set_perspective"> + <return type="void"> + </return> + <argument index="0" name="fov" type="float"> + </argument> + <argument index="1" name="z_near" type="float"> + </argument> + <argument index="2" name="z_far" type="float"> + </argument> + <description> + Sets the camera projection to perspective mode (see [constant PROJECTION_PERSPECTIVE]), by specifying a [code]fov[/code] (field of view) angle in degrees, and the [code]z_near[/code] and [code]z_far[/code] clip planes in world-space units. + </description> + </method> + <method name="unproject_position" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="world_point" type="Vector3"> + </argument> + <description> + Returns the 2D coordinate in the [Viewport] rectangle that maps to the given 3D point in worldspace. + </description> + </method> + </methods> + <members> + <member name="cull_mask" type="int" setter="set_cull_mask" getter="get_cull_mask" default="1048575"> + The culling mask that describes which 3D render layers are rendered by this camera. + </member> + <member name="current" type="bool" setter="set_current" getter="is_current" default="false"> + If [code]true[/code], the ancestor [Viewport] is currently using this camera. + </member> + <member name="doppler_tracking" type="int" setter="set_doppler_tracking" getter="get_doppler_tracking" enum="Camera3D.DopplerTracking" default="0"> + If not [constant DOPPLER_TRACKING_DISABLED], this camera will simulate the [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] for objects changed in particular [code]_process[/code] methods. See [enum DopplerTracking] for possible values. + </member> + <member name="effects" type="CameraEffects" setter="set_effects" getter="get_effects"> + The [CameraEffects] to use for this camera. + </member> + <member name="environment" type="Environment" setter="set_environment" getter="get_environment"> + The [Environment] to use for this camera. + </member> + <member name="far" type="float" setter="set_zfar" getter="get_zfar" default="100.0"> + The distance to the far culling boundary for this camera relative to its local Z axis. + </member> + <member name="fov" type="float" setter="set_fov" getter="get_fov" default="75.0"> + The camera's field of view angle (in degrees). Only applicable in perspective mode. Since [member keep_aspect] locks one axis, [code]fov[/code] sets the other axis' field of view angle. + For reference, the default vertical field of view value ([code]75.0[/code]) is equivalent to an horizontal FOV of: + - ~91.31 degrees in a 4:3 viewport + - ~101.67 degrees in a 16:10 viewport + - ~107.51 degrees in a 16:9 viewport + - ~121.63 degrees in a 21:9 viewport + </member> + <member name="frustum_offset" type="Vector2" setter="set_frustum_offset" getter="get_frustum_offset" default="Vector2( 0, 0 )"> + The camera's frustum offset. This can be changed from the default to create "tilted frustum" effects such as [url=https://zdoom.org/wiki/Y-shearing]Y-shearing[/url]. + </member> + <member name="h_offset" type="float" setter="set_h_offset" getter="get_h_offset" default="0.0"> + The horizontal (X) offset of the camera viewport. + </member> + <member name="keep_aspect" type="int" setter="set_keep_aspect_mode" getter="get_keep_aspect_mode" enum="Camera3D.KeepAspect" default="1"> + The axis to lock during [member fov]/[member size] adjustments. Can be either [constant KEEP_WIDTH] or [constant KEEP_HEIGHT]. + </member> + <member name="near" type="float" setter="set_znear" getter="get_znear" default="0.05"> + The distance to the near culling boundary for this camera relative to its local Z axis. + </member> + <member name="projection" type="int" setter="set_projection" getter="get_projection" enum="Camera3D.Projection" default="0"> + The camera's projection mode. In [constant PROJECTION_PERSPECTIVE] mode, objects' Z distance from the camera's local space scales their perceived size. + </member> + <member name="size" type="float" setter="set_size" getter="get_size" default="1.0"> + The camera's size measured as 1/2 the width or height. Only applicable in orthogonal mode. Since [member keep_aspect] locks on axis, [code]size[/code] sets the other axis' size length. + </member> + <member name="v_offset" type="float" setter="set_v_offset" getter="get_v_offset" default="0.0"> + The vertical (Y) offset of the camera viewport. + </member> + </members> + <constants> + <constant name="PROJECTION_PERSPECTIVE" value="0" enum="Projection"> + Perspective projection. Objects on the screen becomes smaller when they are far away. + </constant> + <constant name="PROJECTION_ORTHOGONAL" value="1" enum="Projection"> + Orthogonal projection, also known as orthographic projection. Objects remain the same size on the screen no matter how far away they are. + </constant> + <constant name="PROJECTION_FRUSTUM" value="2" enum="Projection"> + Frustum projection. This mode allows adjusting [member frustum_offset] to create "tilted frustum" effects. + </constant> + <constant name="KEEP_WIDTH" value="0" enum="KeepAspect"> + Preserves the horizontal aspect ratio; also known as Vert- scaling. This is usually the best option for projects running in portrait mode, as taller aspect ratios will benefit from a wider vertical FOV. + </constant> + <constant name="KEEP_HEIGHT" value="1" enum="KeepAspect"> + Preserves the vertical aspect ratio; also known as Hor+ scaling. This is usually the best option for projects running in landscape mode, as wider aspect ratios will automatically benefit from a wider horizontal FOV. + </constant> + <constant name="DOPPLER_TRACKING_DISABLED" value="0" enum="DopplerTracking"> + Disables [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] simulation (default). + </constant> + <constant name="DOPPLER_TRACKING_IDLE_STEP" value="1" enum="DopplerTracking"> + Simulate [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] by tracking positions of objects that are changed in [code]_process[/code]. Changes in the relative velocity of this camera compared to those objects affect how Audio is perceived (changing the Audio's [code]pitch shift[/code]). + </constant> + <constant name="DOPPLER_TRACKING_PHYSICS_STEP" value="2" enum="DopplerTracking"> + Simulate [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] by tracking positions of objects that are changed in [code]_physics_process[/code]. Changes in the relative velocity of this camera compared to those objects affect how Audio is perceived (changing the Audio's [code]pitch shift[/code]). + </constant> + </constants> +</class> |