.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/Camera3D.xml. .. _class_Camera3D: Camera3D ======== **Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`XRCamera3D` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`CameraAttributes` | :ref:`attributes` | | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`Compositor` | :ref:`compositor` | | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`int` | :ref:`cull_mask` | ``1048575`` | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`bool` | :ref:`current` | ``false`` | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`DopplerTracking` | :ref:`doppler_tracking` | ``0`` | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`Environment` | :ref:`environment` | | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`float` | :ref:`far` | ``4000.0`` | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`float` | :ref:`fov` | ``75.0`` | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`frustum_offset` | ``Vector2(0, 0)`` | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`float` | :ref:`h_offset` | ``0.0`` | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`KeepAspect` | :ref:`keep_aspect` | ``1`` | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`float` | :ref:`near` | ``0.05`` | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`ProjectionType` | :ref:`projection` | ``0`` | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`float` | :ref:`size` | ``1.0`` | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`float` | :ref:`v_offset` | ``0.0`` | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_current` **(** :ref:`bool` enable_next=true **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Projection` | :ref:`get_camera_projection` **(** **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_camera_rid` **(** **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`get_camera_transform` **(** **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_cull_mask_value` **(** :ref:`int` layer_number **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Plane[]` | :ref:`get_frustum` **(** **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_pyramid_shape_rid` **(** **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_position_behind` **(** :ref:`Vector3` world_point **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_position_in_frustum` **(** :ref:`Vector3` world_point **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_current` **(** **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`project_local_ray_normal` **(** :ref:`Vector2` screen_point **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`project_position` **(** :ref:`Vector2` screen_point, :ref:`float` z_depth **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`project_ray_normal` **(** :ref:`Vector2` screen_point **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`project_ray_origin` **(** :ref:`Vector2` screen_point **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cull_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_frustum` **(** :ref:`float` size, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_orthogonal` **(** :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_perspective` **(** :ref:`float` fov, :ref:`float` z_near, :ref:`float` z_far **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`unproject_position` **(** :ref:`Vector3` world_point **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_Camera3D_ProjectionType: .. rst-class:: classref-enumeration enum **ProjectionType**: .. _class_Camera3D_constant_PROJECTION_PERSPECTIVE: .. rst-class:: classref-enumeration-constant :ref:`ProjectionType` **PROJECTION_PERSPECTIVE** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Camera3D_constant_PROJECTION_ORTHOGONAL: .. rst-class:: classref-enumeration-constant :ref:`ProjectionType` **PROJECTION_ORTHOGONAL** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Camera3D_constant_PROJECTION_FRUSTUM: .. rst-class:: classref-enumeration-constant :ref:`ProjectionType` **PROJECTION_FRUSTUM** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_Camera3D_KeepAspect: .. rst-class:: classref-enumeration enum **KeepAspect**: .. _class_Camera3D_constant_KEEP_WIDTH: .. rst-class:: classref-enumeration-constant :ref:`KeepAspect` **KEEP_WIDTH** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Camera3D_constant_KEEP_HEIGHT: .. rst-class:: classref-enumeration-constant :ref:`KeepAspect` **KEEP_HEIGHT** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_Camera3D_DopplerTracking: .. rst-class:: classref-enumeration enum **DopplerTracking**: .. _class_Camera3D_constant_DOPPLER_TRACKING_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`DopplerTracking` **DOPPLER_TRACKING_DISABLED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Camera3D_constant_DOPPLER_TRACKING_IDLE_STEP: .. rst-class:: classref-enumeration-constant :ref:`DopplerTracking` **DOPPLER_TRACKING_IDLE_STEP** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Camera3D_constant_DOPPLER_TRACKING_PHYSICS_STEP: .. rst-class:: classref-enumeration-constant :ref:`DopplerTracking` **DOPPLER_TRACKING_PHYSICS_STEP** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_Camera3D_property_attributes: .. rst-class:: classref-property :ref:`CameraAttributes` **attributes** .. rst-class:: classref-property-setget - void **set_attributes** **(** :ref:`CameraAttributes` value **)** - :ref:`CameraAttributes` **get_attributes** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_property_compositor: .. rst-class:: classref-property :ref:`Compositor` **compositor** .. rst-class:: classref-property-setget - void **set_compositor** **(** :ref:`Compositor` value **)** - :ref:`Compositor` **get_compositor** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_property_cull_mask: .. rst-class:: classref-property :ref:`int` **cull_mask** = ``1048575`` .. rst-class:: classref-property-setget - void **set_cull_mask** **(** :ref:`int` value **)** - :ref:`int` **get_cull_mask** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_property_current: .. rst-class:: classref-property :ref:`bool` **current** = ``false`` .. rst-class:: classref-property-setget - void **set_current** **(** :ref:`bool` value **)** - :ref:`bool` **is_current** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_property_doppler_tracking: .. rst-class:: classref-property :ref:`DopplerTracking` **doppler_tracking** = ``0`` .. rst-class:: classref-property-setget - void **set_doppler_tracking** **(** :ref:`DopplerTracking` value **)** - :ref:`DopplerTracking` **get_doppler_tracking** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_property_environment: .. rst-class:: classref-property :ref:`Environment` **environment** .. rst-class:: classref-property-setget - void **set_environment** **(** :ref:`Environment` value **)** - :ref:`Environment` **get_environment** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_property_far: .. rst-class:: classref-property :ref:`float` **far** = ``4000.0`` .. rst-class:: classref-property-setget - void **set_far** **(** :ref:`float` value **)** - :ref:`float` **get_far** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_property_fov: .. rst-class:: classref-property :ref:`float` **fov** = ``75.0`` .. rst-class:: classref-property-setget - void **set_fov** **(** :ref:`float` value **)** - :ref:`float` **get_fov** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_property_frustum_offset: .. rst-class:: classref-property :ref:`Vector2` **frustum_offset** = ``Vector2(0, 0)`` .. rst-class:: classref-property-setget - void **set_frustum_offset** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_frustum_offset** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_property_h_offset: .. rst-class:: classref-property :ref:`float` **h_offset** = ``0.0`` .. rst-class:: classref-property-setget - void **set_h_offset** **(** :ref:`float` value **)** - :ref:`float` **get_h_offset** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_property_keep_aspect: .. rst-class:: classref-property :ref:`KeepAspect` **keep_aspect** = ``1`` .. rst-class:: classref-property-setget - void **set_keep_aspect_mode** **(** :ref:`KeepAspect` value **)** - :ref:`KeepAspect` **get_keep_aspect_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_property_near: .. rst-class:: classref-property :ref:`float` **near** = ``0.05`` .. rst-class:: classref-property-setget - void **set_near** **(** :ref:`float` value **)** - :ref:`float` **get_near** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_property_projection: .. rst-class:: classref-property :ref:`ProjectionType` **projection** = ``0`` .. rst-class:: classref-property-setget - void **set_projection** **(** :ref:`ProjectionType` value **)** - :ref:`ProjectionType` **get_projection** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_property_size: .. rst-class:: classref-property :ref:`float` **size** = ``1.0`` .. rst-class:: classref-property-setget - void **set_size** **(** :ref:`float` value **)** - :ref:`float` **get_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_property_v_offset: .. rst-class:: classref-property :ref:`float` **v_offset** = ``0.0`` .. rst-class:: classref-property-setget - void **set_v_offset** **(** :ref:`float` value **)** - :ref:`float` **get_v_offset** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Camera3D_method_clear_current: .. rst-class:: classref-method void **clear_current** **(** :ref:`bool` enable_next=true **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_method_get_camera_projection: .. rst-class:: classref-method :ref:`Projection` **get_camera_projection** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_method_get_camera_rid: .. rst-class:: classref-method :ref:`RID` **get_camera_rid** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_method_get_camera_transform: .. rst-class:: classref-method :ref:`Transform3D` **get_camera_transform** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_method_get_cull_mask_value: .. rst-class:: classref-method :ref:`bool` **get_cull_mask_value** **(** :ref:`int` layer_number **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_method_get_frustum: .. rst-class:: classref-method :ref:`Plane[]` **get_frustum** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_method_get_pyramid_shape_rid: .. rst-class:: classref-method :ref:`RID` **get_pyramid_shape_rid** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_method_is_position_behind: .. rst-class:: classref-method :ref:`bool` **is_position_behind** **(** :ref:`Vector3` world_point **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_method_is_position_in_frustum: .. rst-class:: classref-method :ref:`bool` **is_position_in_frustum** **(** :ref:`Vector3` world_point **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_method_make_current: .. rst-class:: classref-method void **make_current** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_method_project_local_ray_normal: .. rst-class:: classref-method :ref:`Vector3` **project_local_ray_normal** **(** :ref:`Vector2` screen_point **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_method_project_position: .. rst-class:: classref-method :ref:`Vector3` **project_position** **(** :ref:`Vector2` screen_point, :ref:`float` z_depth **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_method_project_ray_normal: .. rst-class:: classref-method :ref:`Vector3` **project_ray_normal** **(** :ref:`Vector2` screen_point **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_method_project_ray_origin: .. rst-class:: classref-method :ref:`Vector3` **project_ray_origin** **(** :ref:`Vector2` screen_point **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_method_set_cull_mask_value: .. rst-class:: classref-method void **set_cull_mask_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_method_set_frustum: .. rst-class:: classref-method void **set_frustum** **(** :ref:`float` size, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_method_set_orthogonal: .. rst-class:: classref-method void **set_orthogonal** **(** :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_method_set_perspective: .. rst-class:: classref-method void **set_perspective** **(** :ref:`float` fov, :ref:`float` z_near, :ref:`float` z_far **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Camera3D_method_unproject_position: .. rst-class:: classref-method :ref:`Vector2` **unproject_position** **(** :ref:`Vector3` world_point **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`