Camera3D
Hereda: Node3D < Node < Object
Heredado por: XRCamera3D
Nodo de cámara, muestra desde un punto de vista.
Descripción
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.
Tutoriales
Propiedades
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Métodos
void |
clear_current(enable_next: bool = true) |
get_camera_projection() const |
|
get_camera_rid() const |
|
get_camera_transform() const |
|
get_cull_mask_value(layer_number: int) const |
|
get_frustum() const |
|
is_position_behind(world_point: Vector3) const |
|
is_position_in_frustum(world_point: Vector3) const |
|
void |
|
project_local_ray_normal(screen_point: Vector2) const |
|
project_position(screen_point: Vector2, z_depth: float) const |
|
project_ray_normal(screen_point: Vector2) const |
|
project_ray_origin(screen_point: Vector2) const |
|
void |
set_cull_mask_value(layer_number: int, value: bool) |
void |
set_frustum(size: float, offset: Vector2, z_near: float, z_far: float) |
void |
set_orthogonal(size: float, z_near: float, z_far: float) |
void |
set_perspective(fov: float, z_near: float, z_far: float) |
unproject_position(world_point: Vector3) const |
Enumeraciones
enum ProjectionType: 🔗
ProjectionType PROJECTION_PERSPECTIVE = 0
Proyección de la perspectiva. Los objetos en la pantalla se hacen más pequeños cuando están lejos.
ProjectionType PROJECTION_ORTHOGONAL = 1
Proyección ortogonal, también conocida como proyección ortográfica. Los objetos permanecen del mismo tamaño en la pantalla sin importar lo lejos que estén.
ProjectionType PROJECTION_FRUSTUM = 2
Proyección de Frustum. Este modo permite ajustar frustum_offset para crear efectos de "frustum inclinado".
enum KeepAspect: 🔗
KeepAspect KEEP_WIDTH = 0
Preserva la relación de aspecto horizontal; también conocida como escala de Vert-. Esta suele ser la mejor opción para los proyectos que se ejecutan en modo de retrato, ya que las proporciones de aspecto más altas se beneficiarán de un mayor FOV vertical.
KeepAspect KEEP_HEIGHT = 1
Preserva la relación de aspecto vertical; también conocida como escala Hor+. Esta suele ser la mejor opción para los proyectos que se ejecutan en modo paisaje, ya que las relaciones de aspecto más amplias se beneficiarán automáticamente de un FOV horizontal más amplio.
enum DopplerTracking: 🔗
DopplerTracking DOPPLER_TRACKING_DISABLED = 0
Desactiva la simulación del efecto Doppler (por defecto).
DopplerTracking DOPPLER_TRACKING_IDLE_STEP = 1
Simulate Doppler effect by tracking positions of objects that are changed in _process. Changes in the relative velocity of this camera compared to those objects affect how audio is perceived (changing the audio's AudioStreamPlayer3D.pitch_scale).
DopplerTracking DOPPLER_TRACKING_PHYSICS_STEP = 2
Simulate Doppler effect by tracking positions of objects that are changed in _physics_process. Changes in the relative velocity of this camera compared to those objects affect how audio is perceived (changing the audio's AudioStreamPlayer3D.pitch_scale).
Descripciones de Propiedades
CameraAttributes attributes 🔗
void set_attributes(value: CameraAttributes)
CameraAttributes get_attributes()
Los CameraAttributes que se utilizarán para esta cámara.
Compositor compositor 🔗
void set_compositor(value: Compositor)
Compositor get_compositor()
El Compositor a utilizar para esta cámara.
The culling mask that describes which VisualInstance3D.layers are rendered by this camera. By default, all 20 user-visible layers are rendered.
Note: Since the 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 cull_mask using a script allows you to toggle those reserved layers, which can be useful for editor plugins.
To adjust cull_mask more easily using a script, use get_cull_mask_value() and set_cull_mask_value().
Note: VoxelGI, SDFGI and LightmapGI will always take all layers into account to determine what contributes to global illumination. If this is an issue, set GeometryInstance3D.gi_mode to GeometryInstance3D.GI_MODE_DISABLED for meshes and Light3D.light_bake_mode to Light3D.BAKE_DISABLED for lights to exclude them from global illumination.
If true, 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 current to false will cause the other camera to be made current.
DopplerTracking doppler_tracking = 0 🔗
void set_doppler_tracking(value: DopplerTracking)
DopplerTracking get_doppler_tracking()
If not DOPPLER_TRACKING_DISABLED, this camera will simulate the Doppler effect for objects changed in particular _process methods.
Note: The Doppler effect will only be heard on AudioStreamPlayer3Ds if AudioStreamPlayer3D.doppler_tracking is not set to AudioStreamPlayer3D.DOPPLER_TRACKING_DISABLED.
Environment environment 🔗
void set_environment(value: Environment)
Environment get_environment()
El Environment a utilizar para esta cámara.
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 far can improve performance if it results in objects being partially or fully culled.
The camera's field of view angle (in degrees). Only applicable in perspective mode. Since keep_aspect locks one axis, fov sets the other axis' field of view angle.
For reference, the default vertical field of view value (75.0) 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
Vector2 frustum_offset = Vector2(0, 0) 🔗
The camera's frustum offset. This can be changed from the default to create "tilted frustum" effects such as Y-shearing.
Note: Only effective if projection is PROJECTION_FRUSTUM.
El desplazamiento horizontal (X) de la vista de la cámara.
KeepAspect keep_aspect = 1 🔗
void set_keep_aspect_mode(value: KeepAspect)
KeepAspect get_keep_aspect_mode()
El eje a bloquear durante los ajustes de fov/size. Puede ser KEEP_WIDTH o KEEP_HEIGHT.
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 entire range. Values lower than the default can lead to increased Z-fighting.
ProjectionType projection = 0 🔗
void set_projection(value: ProjectionType)
ProjectionType get_projection()
El modo de proyección de la cámara. En el modo PROJECTION_PERSPECTIVE, la distancia Z de los objetos al espacio local de la cámara escala su tamaño percibido.
The camera's size in meters measured as the diameter of the width or height, depending on keep_aspect. Only applicable in orthogonal and frustum modes.
El desplazamiento vertical (Y) del viewport de la cámara.
Descripciones de Métodos
void clear_current(enable_next: bool = true) 🔗
Si esta es la cámara actual, dejar de usarla. Si enable_next es true, se solicitará usar la siguiente cámara, si existe.
Projection get_camera_projection() const 🔗
Devuelve la matriz de proyección que esta cámara utiliza para renderizar a su viewport asociado. La cámara debe ser parte del árbol de la escena para funcionar.
Devuelve el RID de la cámara desde el RenderingServer.
Transform3D get_camera_transform() const 🔗
Devuelve la transformación de la cámara más los desplazamientos verticales (v_offset) y horizontales (h_offset); y cualquier otro ajuste realizado a la posición y orientación de la cámara por las cámaras subclasificadas como XRCamera3D.
bool get_cull_mask_value(layer_number: int) const 🔗
Devuelve si la capa especificada de cull_mask está habilitada, dado un layer_number entre 1 y 20.
Array[Plane] get_frustum() const 🔗
Devuelve los planos del frustum de la cámara en unidades del espacio mundial como un array de Planes en el siguiente orden: cerca, lejos, izquierda, arriba, derecha, abajo. No confundir con frustum_offset.
Devuelve el RID de una forma piramidal que abarca el frustum de visión de la cámara, ignorando el plano cercano de la cámara. La punta de la pirámide representa la posición de la cámara.
bool is_position_behind(world_point: Vector3) const 🔗
Devuelve true si la posición dada está detrás de la cámara (la parte azul del diagrama enlazado). Consulta este diagrama para obtener una visión general de los métodos de consulta de posición.
Nota: Una posición que devuelva false aún puede estar fuera del campo de visión de la cámara.
bool is_position_in_frustum(world_point: Vector3) const 🔗
Devuelve true si la posición dada está dentro del frustum de la cámara (la parte verde del diagrama enlazado). Consulta este diagrama para obtener una visión general de los métodos de consulta de posición.
void make_current() 🔗
Hace que esta cámara sea la cámara actual para el Viewport (ver descripción de la clase). Si el nodo de la cámara está fuera del árbol de escenas, intentará convertirse en actual una vez que se añada.
Vector3 project_local_ray_normal(screen_point: Vector2) const 🔗
Devuelve un vector normal de la ubicación del punto de la pantalla dirigido a lo largo de la cámara. Las cámaras ortogonales están normalizadas. Las cámaras de perspectiva tienen en cuenta la perspectiva, la anchura y la altura de la pantalla, etc.
Vector3 project_position(screen_point: Vector2, z_depth: float) const 🔗
Devuelve el punto 3D en el espacio mundial que se corresponde con la coordenada 2D dada en el rectángulo del Viewport, en un plano que está a la distancia z_depth en la escena, alejado de la cámara.
Vector3 project_ray_normal(screen_point: Vector2) const 🔗
Devuelve un vector normal en el espacio mundial, que es el resultado de proyectar un punto en el rectángulo del Viewport mediante la proyección inversa de la cámara. Esto es útil para lanzar rayos en forma de (origen, normal) para la intersección o selección de objetos.
Vector3 project_ray_origin(screen_point: Vector2) const 🔗
Devuelve una posición 3D en el espacio mundial, que es el resultado de proyectar un punto en el rectángulo del Viewport mediante la proyección inversa de la cámara. Esto es útil para lanzar rayos en forma de (origen, normal) para la intersección o selección de objetos.
void set_cull_mask_value(layer_number: int, value: bool) 🔗
Según value, activa o desactiva la capa especificada en el cull_mask, dado un layer_number entre 1 y 20.
void set_frustum(size: float, offset: Vector2, z_near: float, z_far: float) 🔗
Establece la proyección de la cámara en modo frustum (véase PROJECTION_FRUSTUM), especificando un size, un offset, y los planos de recorte z_near y z_far en unidades del espacio mundial. Véase también frustum_offset.
void set_orthogonal(size: float, z_near: float, z_far: float) 🔗
Establece la proyección de la cámara en modo ortogonal (véase PROJECTION_ORTHOGONAL), especificando un size, y los planos de recorte z_near y z_far en unidades del espacio mundial.
Como sugerencia, los juegos 3D que parecen 2D a menudo usan esta proyección, con size especificado en píxeles.
void set_perspective(fov: float, z_near: float, z_far: float) 🔗
Establece la proyección de la cámara en modo de perspectiva (véase PROJECTION_PERSPECTIVE), especificando un ángulo fov (campo de visión) en grados, y los planos de recorte z_near y z_far en unidades del espacio mundial.
Vector2 unproject_position(world_point: Vector3) const 🔗
Returns the 2D coordinate in the Viewport rectangle that maps to the given 3D point in world space.
Note: When using this to position GUI elements over a 3D viewport, use is_position_behind() to prevent them from appearing if the 3D point is behind the camera:
# 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)