godot/doc/classes/Camera3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Camera3D" inherits="Node3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<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>
		<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
	</tutorials>
	<methods>
		<method name="clear_current">
			<return type="void" />
			<param index="0" name="enable_next" type="bool" default="true" />
			<description>
				If this is the current camera, remove it from being current. If [param enable_next] is [code]true[/code], request to make the next camera current, if any.
			</description>
		</method>
		<method name="get_camera_projection" qualifiers="const">
			<return type="Projection" />
			<description>
				Returns the projection matrix that this camera uses to render to its associated viewport. The camera must be part of the scene tree to function.
			</description>
		</method>
		<method name="get_camera_rid" qualifiers="const">
			<return type="RID" />
			<description>
				Returns the camera's RID from the [RenderingServer].
			</description>
		</method>
		<method name="get_camera_transform" qualifiers="const">
			<return type="Transform3D" />
			<description>
				Returns the transform of the camera plus the vertical ([member v_offset]) and horizontal ([member h_offset]) offsets; and any other adjustments made to the position and orientation of the camera by subclassed cameras such as [XRCamera3D].
			</description>
		</method>
		<method name="get_cull_mask_value" qualifiers="const">
			<return type="bool" />
			<param index="0" name="layer_number" type="int" />
			<description>
				Returns whether or not the specified layer of the [member cull_mask] is enabled, given a [param layer_number] between 1 and 20.
			</description>
		</method>
		<method name="get_frustum" qualifiers="const">
			<return type="Plane[]" />
			<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="get_pyramid_shape_rid">
			<return type="RID" />
			<description>
				Returns the RID of a pyramid shape encompassing the camera's view frustum, ignoring the camera's near plane. The tip of the pyramid represents the position of the camera.
			</description>
		</method>
		<method name="is_position_behind" qualifiers="const">
			<return type="bool" />
			<param index="0" name="world_point" type="Vector3" />
			<description>
				Returns [code]true[/code] if the given position is behind the camera (the blue part of the linked diagram). [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/camera3d_position_frustum.png]See this diagram[/url] for an overview of position query methods.
				[b]Note:[/b] A position which returns [code]false[/code] may still be outside the camera's field of view.
			</description>
		</method>
		<method name="is_position_in_frustum" qualifiers="const">
			<return type="bool" />
			<param index="0" name="world_point" type="Vector3" />
			<description>
				Returns [code]true[/code] if the given position is inside the camera's frustum (the green part of the linked diagram). [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/camera3d_position_frustum.png]See this diagram[/url] for an overview of position query methods.
			</description>
		</method>
		<method name="make_current">
			<return type="void" />
			<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" />
			<param index="0" name="screen_point" type="Vector2" />
			<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" />
			<param index="0" name="screen_point" type="Vector2" />
			<param index="1" name="z_depth" type="float" />
			<description>
				Returns the 3D point in world space that maps to the given 2D coordinate in the [Viewport] rectangle on a plane that is the given [param z_depth] distance into the scene away from the camera.
			</description>
		</method>
		<method name="project_ray_normal" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="screen_point" type="Vector2" />
			<description>
				Returns a normal vector in world space, that is the result of projecting a point on the [Viewport] rectangle by the inverse 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" />
			<param index="0" name="screen_point" type="Vector2" />
			<description>
				Returns a 3D position in world space, that is the result of projecting a point on the [Viewport] rectangle by the inverse 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_value">
			<return type="void" />
			<param index="0" name="layer_number" type="int" />
			<param index="1" name="value" type="bool" />
			<description>
				Based on [param value], enables or disables the specified layer in the [member cull_mask], given a [param layer_number] between 1 and 20.
			</description>
		</method>
		<method name="set_frustum">
			<return type="void" />
			<param index="0" name="size" type="float" />
			<param index="1" name="offset" type="Vector2" />
			<param index="2" name="z_near" type="float" />
			<param index="3" name="z_far" type="float" />
			<description>
				Sets the camera projection to frustum mode (see [constant PROJECTION_FRUSTUM]), by specifying a [param size], an [param offset], and the [param z_near] and [param z_far] clip planes in world space units. See also [member frustum_offset].
			</description>
		</method>
		<method name="set_orthogonal">
			<return type="void" />
			<param index="0" name="size" type="float" />
			<param index="1" name="z_near" type="float" />
			<param index="2" name="z_far" type="float" />
			<description>
				Sets the camera projection to orthogonal mode (see [constant PROJECTION_ORTHOGONAL]), by specifying a [param size], and the [param z_near] and [param z_far] 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" />
			<param index="0" name="fov" type="float" />
			<param index="1" name="z_near" type="float" />
			<param index="2" name="z_far" type="float" />
			<description>
				Sets the camera projection to perspective mode (see [constant PROJECTION_PERSPECTIVE]), by specifying a [param fov] (field of view) angle in degrees, and the [param z_near] and [param z_far] clip planes in world space units.
			</description>
		</method>
		<method name="unproject_position" qualifiers="const">
			<return type="Vector2" />
			<param index="0" name="world_point" type="Vector3" />
			<description>
				Returns the 2D coordinate in the [Viewport] rectangle that maps to the given 3D point in world space.
				[b]Note:[/b] When using this to position GUI elements over a 3D viewport, use [method is_position_behind] to prevent them from appearing if the 3D point is behind the camera:
				[codeblock]
				# This code block is part of a script that inherits from Node3D.
				# `control` is a reference to a node inheriting from Control.
				control.visible = not get_viewport().get_camera_3d().is_position_behind(global_transform.origin)
				control.position = get_viewport().get_camera_3d().unproject_position(global_transform.origin)
				[/codeblock]
			</description>
		</method>
	</methods>
	<members>
		<member name="attributes" type="CameraAttributes" setter="set_attributes" getter="get_attributes">
			The [CameraAttributes] to use for this camera.
		</member>
		<member name="cull_mask" type="int" setter="set_cull_mask" getter="get_cull_mask" default="1048575">
			The culling mask that describes which [member VisualInstance3D.layers] are rendered by this camera. By default, all 20 user-visible layers are rendered.
			[b]Note:[/b] Since the [member cull_mask] allows for 32 layers to be stored in total, there are an additional 12 layers that are only used internally by the engine and aren't exposed in the editor. Setting [member cull_mask] using a script allows you to toggle those reserved layers, which can be useful for editor plugins.
			To adjust [member cull_mask] more easily using a script, use [method get_cull_mask_value] and [method set_cull_mask_value].
			[b]Note:[/b] [VoxelGI], SDFGI and [LightmapGI] will always take all layers into account to determine what contributes to global illumination. If this is an issue, set [member GeometryInstance3D.gi_mode] to [constant GeometryInstance3D.GI_MODE_DISABLED] for meshes and [member Light3D.light_bake_mode] to [constant Light3D.BAKE_DISABLED] for lights to exclude them from global illumination.
		</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.
			If multiple cameras are in the scene, one will always be made current. For example, if two [Camera3D] nodes are present in the scene and only one is current, setting one camera's [member current] to [code]false[/code] will cause the other camera to be made current.
		</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="environment" type="Environment" setter="set_environment" getter="get_environment">
			The [Environment] to use for this camera.
		</member>
		<member name="far" type="float" setter="set_far" getter="get_far" default="4000.0">
			The distance to the far culling boundary for this camera relative to its local Z axis. Higher values allow the camera to see further away, while decreasing [member far] can improve performance if it results in objects being partially or fully culled.
		</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 a 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].
			[b]Note:[/b] Only effective if [member projection] is [constant PROJECTION_FRUSTUM].
		</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_near" getter="get_near" default="0.05">
			The distance to the near culling boundary for this camera relative to its local Z axis. Lower values allow the camera to see objects more up close to its origin, at the cost of lower precision across the [i]entire[/i] range. Values lower than the default can lead to increased Z-fighting.
		</member>
		<member name="projection" type="int" setter="set_projection" getter="get_projection" enum="Camera3D.ProjectionType" 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 in meters measured as the diameter of the width or height, depending on [member keep_aspect]. Only applicable in orthogonal and frustum modes.
		</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="ProjectionType">
			Perspective projection. Objects on the screen becomes smaller when they are far away.
		</constant>
		<constant name="PROJECTION_ORTHOGONAL" value="1" enum="ProjectionType">
			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="ProjectionType">
			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 [member AudioStreamPlayer3D.pitch_scale]).
		</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 [member AudioStreamPlayer3D.pitch_scale]).
		</constant>
	</constants>
</class>