godot-docs/classes/class_spatial.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Spatial.xml.

.. _class_Spatial:

Spatial
=======

**Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Inherited By:** :ref:`ARVRAnchor<class_ARVRAnchor>`, :ref:`ARVRController<class_ARVRController>`, :ref:`ARVROrigin<class_ARVROrigin>`, :ref:`AudioStreamPlayer3D<class_AudioStreamPlayer3D>`, :ref:`BoneAttachment<class_BoneAttachment>`, :ref:`Camera<class_Camera>`, :ref:`CollisionObject<class_CollisionObject>`, :ref:`CollisionPolygon<class_CollisionPolygon>`, :ref:`CollisionShape<class_CollisionShape>`, :ref:`CullInstance<class_CullInstance>`, :ref:`GridMap<class_GridMap>`, :ref:`Joint<class_Joint>`, :ref:`Listener<class_Listener>`, :ref:`LOD<class_LOD>`, :ref:`MergeGroup<class_MergeGroup>`, :ref:`Navigation<class_Navigation>`, :ref:`NavigationMeshInstance<class_NavigationMeshInstance>`, :ref:`Occluder<class_Occluder>`, :ref:`Path<class_Path>`, :ref:`PathFollow<class_PathFollow>`, :ref:`Portal<class_Portal>`, :ref:`Position3D<class_Position3D>`, :ref:`ProximityGroup<class_ProximityGroup>`, :ref:`RayCast<class_RayCast>`, :ref:`RemoteTransform<class_RemoteTransform>`, :ref:`Room<class_Room>`, :ref:`RoomGroup<class_RoomGroup>`, :ref:`RoomManager<class_RoomManager>`, :ref:`ShapeCast<class_ShapeCast>`, :ref:`Skeleton<class_Skeleton>`, :ref:`SpringArm<class_SpringArm>`, :ref:`VehicleWheel<class_VehicleWheel>`

Most basic 3D game object, parent of all 3D-related nodes.

.. rst-class:: classref-introduction-group

Description
-----------

Most basic 3D game object, with a 3D :ref:`Transform<class_Transform>` and visibility settings. All other 3D game objects inherit from Spatial. Use **Spatial** as a parent node to move, scale, rotate and show/hide children in a 3D project.

Affine operations (rotate, scale, translate) happen in parent's local coordinate system, unless the **Spatial** object is set as top-level. Affine operations in this coordinate system correspond to direct affine operations on the **Spatial**'s transform. The word local below refers to this coordinate system. The coordinate system that is attached to the **Spatial** object itself is referred to as object-local coordinate system.

\ **Note:** Unless otherwise specified, all methods that have angle parameters must have angles specified as *radians*. To convert degrees to radians, use :ref:`@GDScript.deg2rad<class_@GDScript_method_deg2rad>`.

.. rst-class:: classref-introduction-group

Tutorials
---------

- :doc:`Introduction to 3D <../tutorials/3d/introduction_to_3d>`

- `All 3D Demos <https://github.com/godotengine/godot-demo-projects/tree/master/3d>`__

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+
   | :ref:`SpatialGizmo<class_SpatialGizmo>`      | :ref:`gizmo<class_Spatial_property_gizmo>`                           |                                                     |
   +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+
   | :ref:`Vector3<class_Vector3>`                | :ref:`global_position<class_Spatial_property_global_position>`       |                                                     |
   +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+
   | :ref:`Vector3<class_Vector3>`                | :ref:`global_rotation<class_Spatial_property_global_rotation>`       |                                                     |
   +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+
   | :ref:`Transform<class_Transform>`            | :ref:`global_transform<class_Spatial_property_global_transform>`     |                                                     |
   +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+
   | :ref:`Vector3<class_Vector3>`                | :ref:`global_translation<class_Spatial_property_global_translation>` |                                                     |
   +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+
   | :ref:`float<class_float>`                    | :ref:`lod_range<class_Spatial_property_lod_range>`                   | ``10.0``                                            |
   +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+
   | :ref:`MergingMode<enum_Spatial_MergingMode>` | :ref:`merging_mode<class_Spatial_property_merging_mode>`             | ``0``                                               |
   +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+
   | :ref:`Vector3<class_Vector3>`                | :ref:`position<class_Spatial_property_position>`                     |                                                     |
   +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+
   | :ref:`Vector3<class_Vector3>`                | :ref:`rotation<class_Spatial_property_rotation>`                     |                                                     |
   +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+
   | :ref:`Vector3<class_Vector3>`                | :ref:`rotation_degrees<class_Spatial_property_rotation_degrees>`     | ``Vector3( 0, 0, 0 )``                              |
   +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+
   | :ref:`Vector3<class_Vector3>`                | :ref:`scale<class_Spatial_property_scale>`                           | ``Vector3( 1, 1, 1 )``                              |
   +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+
   | :ref:`Transform<class_Transform>`            | :ref:`transform<class_Spatial_property_transform>`                   | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` |
   +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+
   | :ref:`Vector3<class_Vector3>`                | :ref:`translation<class_Spatial_property_translation>`               | ``Vector3( 0, 0, 0 )``                              |
   +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`visible<class_Spatial_property_visible>`                       | ``true``                                            |
   +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`force_update_transform<class_Spatial_method_force_update_transform>` **(** **)**                                                                                                              |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Transform<class_Transform>` | :ref:`get_global_transform_interpolated<class_Spatial_method_get_global_transform_interpolated>` **(** **)**                                                                                        |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Spatial<class_Spatial>`     | :ref:`get_parent_spatial<class_Spatial_method_get_parent_spatial>` **(** **)** |const|                                                                                                              |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`World<class_World>`         | :ref:`get_world<class_Spatial_method_get_world>` **(** **)** |const|                                                                                                                                |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`global_rotate<class_Spatial_method_global_rotate>` **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` angle **)**                                                            |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`global_scale<class_Spatial_method_global_scale>` **(** :ref:`Vector3<class_Vector3>` scale **)**                                                                                              |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`global_translate<class_Spatial_method_global_translate>` **(** :ref:`Vector3<class_Vector3>` offset **)**                                                                                     |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`hide<class_Spatial_method_hide>` **(** **)**                                                                                                                                                  |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`           | :ref:`is_local_transform_notification_enabled<class_Spatial_method_is_local_transform_notification_enabled>` **(** **)** |const|                                                                    |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`           | :ref:`is_scale_disabled<class_Spatial_method_is_scale_disabled>` **(** **)** |const|                                                                                                                |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`           | :ref:`is_set_as_toplevel<class_Spatial_method_is_set_as_toplevel>` **(** **)** |const|                                                                                                              |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`           | :ref:`is_transform_notification_enabled<class_Spatial_method_is_transform_notification_enabled>` **(** **)** |const|                                                                                |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`           | :ref:`is_visible_in_tree<class_Spatial_method_is_visible_in_tree>` **(** **)** |const|                                                                                                              |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`look_at<class_Spatial_method_look_at>` **(** :ref:`Vector3<class_Vector3>` target, :ref:`Vector3<class_Vector3>` up **)**                                                                     |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`look_at_from_position<class_Spatial_method_look_at_from_position>` **(** :ref:`Vector3<class_Vector3>` position, :ref:`Vector3<class_Vector3>` target, :ref:`Vector3<class_Vector3>` up **)** |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`orthonormalize<class_Spatial_method_orthonormalize>` **(** **)**                                                                                                                              |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`rotate<class_Spatial_method_rotate>` **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` angle **)**                                                                          |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`rotate_object_local<class_Spatial_method_rotate_object_local>` **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` angle **)**                                                |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`rotate_x<class_Spatial_method_rotate_x>` **(** :ref:`float<class_float>` angle **)**                                                                                                          |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`rotate_y<class_Spatial_method_rotate_y>` **(** :ref:`float<class_float>` angle **)**                                                                                                          |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`rotate_z<class_Spatial_method_rotate_z>` **(** :ref:`float<class_float>` angle **)**                                                                                                          |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`scale_object_local<class_Spatial_method_scale_object_local>` **(** :ref:`Vector3<class_Vector3>` scale **)**                                                                                  |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`set_as_toplevel<class_Spatial_method_set_as_toplevel>` **(** :ref:`bool<class_bool>` enable **)**                                                                                             |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`set_disable_scale<class_Spatial_method_set_disable_scale>` **(** :ref:`bool<class_bool>` disable **)**                                                                                        |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`set_identity<class_Spatial_method_set_identity>` **(** **)**                                                                                                                                  |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`set_ignore_transform_notification<class_Spatial_method_set_ignore_transform_notification>` **(** :ref:`bool<class_bool>` enabled **)**                                                        |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`set_notify_local_transform<class_Spatial_method_set_notify_local_transform>` **(** :ref:`bool<class_bool>` enable **)**                                                                       |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`set_notify_transform<class_Spatial_method_set_notify_transform>` **(** :ref:`bool<class_bool>` enable **)**                                                                                   |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`show<class_Spatial_method_show>` **(** **)**                                                                                                                                                  |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector3<class_Vector3>`     | :ref:`to_global<class_Spatial_method_to_global>` **(** :ref:`Vector3<class_Vector3>` local_point **)** |const|                                                                                      |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector3<class_Vector3>`     | :ref:`to_local<class_Spatial_method_to_local>` **(** :ref:`Vector3<class_Vector3>` global_point **)** |const|                                                                                       |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`translate<class_Spatial_method_translate>` **(** :ref:`Vector3<class_Vector3>` offset **)**                                                                                                   |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`translate_object_local<class_Spatial_method_translate_object_local>` **(** :ref:`Vector3<class_Vector3>` offset **)**                                                                         |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`update_gizmo<class_Spatial_method_update_gizmo>` **(** **)**                                                                                                                                  |
   +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Signals
-------

.. _class_Spatial_signal_gameplay_entered:

.. rst-class:: classref-signal

**gameplay_entered** **(** **)**

Emitted by portal system gameplay monitor when a node enters the gameplay area.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_signal_gameplay_exited:

.. rst-class:: classref-signal

**gameplay_exited** **(** **)**

Emitted by portal system gameplay monitor when a node exits the gameplay area.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_signal_visibility_changed:

.. rst-class:: classref-signal

**visibility_changed** **(** **)**

Emitted when node visibility changes.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Enumerations
------------

.. _enum_Spatial_MergingMode:

.. rst-class:: classref-enumeration

enum **MergingMode**:

.. _class_Spatial_constant_MERGING_MODE_INHERIT:

.. rst-class:: classref-enumeration-constant

:ref:`MergingMode<enum_Spatial_MergingMode>` **MERGING_MODE_INHERIT** = ``0``

Inherits merging mode from the node's parent. For the root node, it is equivalent to :ref:`MERGING_MODE_ON<class_Spatial_constant_MERGING_MODE_ON>`. Default.

.. _class_Spatial_constant_MERGING_MODE_OFF:

.. rst-class:: classref-enumeration-constant

:ref:`MergingMode<enum_Spatial_MergingMode>` **MERGING_MODE_OFF** = ``1``

Turn off merging in this node and children set to :ref:`MERGING_MODE_INHERIT<class_Spatial_constant_MERGING_MODE_INHERIT>`.

.. _class_Spatial_constant_MERGING_MODE_ON:

.. rst-class:: classref-enumeration-constant

:ref:`MergingMode<enum_Spatial_MergingMode>` **MERGING_MODE_ON** = ``2``

Turn on merging in this node and children set to :ref:`MERGING_MODE_INHERIT<class_Spatial_constant_MERGING_MODE_INHERIT>`.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Constants
---------

.. _class_Spatial_constant_NOTIFICATION_TRANSFORM_CHANGED:

.. rst-class:: classref-constant

**NOTIFICATION_TRANSFORM_CHANGED** = ``2000``

Spatial nodes receives this notification when their global transform changes. This means that either the current or a parent node changed its transform.

In order for :ref:`NOTIFICATION_TRANSFORM_CHANGED<class_Spatial_constant_NOTIFICATION_TRANSFORM_CHANGED>` to work, users first need to ask for it, with :ref:`set_notify_transform<class_Spatial_method_set_notify_transform>`. The notification is also sent if the node is in the editor context and it has a valid gizmo.

.. _class_Spatial_constant_NOTIFICATION_ENTER_WORLD:

.. rst-class:: classref-constant

**NOTIFICATION_ENTER_WORLD** = ``41``

Spatial nodes receives this notification when they are registered to new :ref:`World<class_World>` resource.

.. _class_Spatial_constant_NOTIFICATION_EXIT_WORLD:

.. rst-class:: classref-constant

**NOTIFICATION_EXIT_WORLD** = ``42``

Spatial nodes receives this notification when they are unregistered from current :ref:`World<class_World>` resource.

.. _class_Spatial_constant_NOTIFICATION_VISIBILITY_CHANGED:

.. rst-class:: classref-constant

**NOTIFICATION_VISIBILITY_CHANGED** = ``43``

Spatial nodes receives this notification when their visibility changes.

.. _class_Spatial_constant_NOTIFICATION_ENTER_GAMEPLAY:

.. rst-class:: classref-constant

**NOTIFICATION_ENTER_GAMEPLAY** = ``45``

Spatial nodes receives this notification if the portal system gameplay monitor detects they have entered the gameplay area.

.. _class_Spatial_constant_NOTIFICATION_EXIT_GAMEPLAY:

.. rst-class:: classref-constant

**NOTIFICATION_EXIT_GAMEPLAY** = ``46``

Spatial nodes receives this notification if the portal system gameplay monitor detects they have exited the gameplay area.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_Spatial_property_gizmo:

.. rst-class:: classref-property

:ref:`SpatialGizmo<class_SpatialGizmo>` **gizmo**

.. rst-class:: classref-property-setget

- void **set_gizmo** **(** :ref:`SpatialGizmo<class_SpatialGizmo>` value **)**
- :ref:`SpatialGizmo<class_SpatialGizmo>` **get_gizmo** **(** **)**

The :ref:`SpatialGizmo<class_SpatialGizmo>` for this node. Used for example in :ref:`EditorSpatialGizmo<class_EditorSpatialGizmo>` as custom visualization and editing handles in Editor.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_property_global_position:

.. rst-class:: classref-property

:ref:`Vector3<class_Vector3>` **global_position**

.. rst-class:: classref-property-setget

- void **set_global_translation** **(** :ref:`Vector3<class_Vector3>` value **)**
- :ref:`Vector3<class_Vector3>` **get_global_translation** **(** **)**

Global position of this node. This is a forward-compatible alias for :ref:`global_translation<class_Spatial_property_global_translation>`.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_property_global_rotation:

.. rst-class:: classref-property

:ref:`Vector3<class_Vector3>` **global_rotation**

.. rst-class:: classref-property-setget

- void **set_global_rotation** **(** :ref:`Vector3<class_Vector3>` value **)**
- :ref:`Vector3<class_Vector3>` **get_global_rotation** **(** **)**

Rotation part of the global transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).

\ **Note:** In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a :ref:`Vector3<class_Vector3>` data structure not because the rotation is a vector, but only because :ref:`Vector3<class_Vector3>` exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_property_global_transform:

.. rst-class:: classref-property

:ref:`Transform<class_Transform>` **global_transform**

.. rst-class:: classref-property-setget

- void **set_global_transform** **(** :ref:`Transform<class_Transform>` value **)**
- :ref:`Transform<class_Transform>` **get_global_transform** **(** **)**

World space (global) :ref:`Transform<class_Transform>` of this node.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_property_global_translation:

.. rst-class:: classref-property

:ref:`Vector3<class_Vector3>` **global_translation**

.. rst-class:: classref-property-setget

- void **set_global_translation** **(** :ref:`Vector3<class_Vector3>` value **)**
- :ref:`Vector3<class_Vector3>` **get_global_translation** **(** **)**

Global position of this node. This is equivalent to ``global_transform.origin``.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_property_lod_range:

.. rst-class:: classref-property

:ref:`float<class_float>` **lod_range** = ``10.0``

.. rst-class:: classref-property-setget

- void **set_lod_range** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_lod_range** **(** **)**

Determines the threshold distance at which this node will be shown or hidden when this node is parented by a :ref:`LOD<class_LOD>` node.

For example, a first child with a range of ``2`` will be shown from distance 0 to 2. A second child with a range of ``5`` will be shown from distance 2 to 7, etc.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_property_merging_mode:

.. rst-class:: classref-property

:ref:`MergingMode<enum_Spatial_MergingMode>` **merging_mode** = ``0``

.. rst-class:: classref-property-setget

- void **set_merging_mode** **(** :ref:`MergingMode<enum_Spatial_MergingMode>` value **)**
- :ref:`MergingMode<enum_Spatial_MergingMode>` **get_merging_mode** **(** **)**

The merging mode determines whether merging features of the engine (:ref:`MergeGroup<class_MergeGroup>` and :ref:`RoomManager<class_RoomManager>`) will attempt to operate on branches of the scene tree.

The default mode inherited from the scene tree root is :ref:`MERGING_MODE_ON<class_Spatial_constant_MERGING_MODE_ON>`.

\ **Note:** Merging mode determines whether the merging is **allowed** to be performed. It does not guarantee that merging will occur, which depends on whether there are suitable matching objects.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_property_position:

.. rst-class:: classref-property

:ref:`Vector3<class_Vector3>` **position**

.. rst-class:: classref-property-setget

- void **set_translation** **(** :ref:`Vector3<class_Vector3>` value **)**
- :ref:`Vector3<class_Vector3>` **get_translation** **(** **)**

Local position of this node. This is a forward-compatible alias for :ref:`translation<class_Spatial_property_translation>`.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_property_rotation:

.. rst-class:: classref-property

:ref:`Vector3<class_Vector3>` **rotation**

.. rst-class:: classref-property-setget

- void **set_rotation** **(** :ref:`Vector3<class_Vector3>` value **)**
- :ref:`Vector3<class_Vector3>` **get_rotation** **(** **)**

Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).

\ **Note:** In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a :ref:`Vector3<class_Vector3>` data structure not because the rotation is a vector, but only because :ref:`Vector3<class_Vector3>` exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_property_rotation_degrees:

.. rst-class:: classref-property

:ref:`Vector3<class_Vector3>` **rotation_degrees** = ``Vector3( 0, 0, 0 )``

.. rst-class:: classref-property-setget

- void **set_rotation_degrees** **(** :ref:`Vector3<class_Vector3>` value **)**
- :ref:`Vector3<class_Vector3>` **get_rotation_degrees** **(** **)**

Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).

.. rst-class:: classref-item-separator

----

.. _class_Spatial_property_scale:

.. rst-class:: classref-property

:ref:`Vector3<class_Vector3>` **scale** = ``Vector3( 1, 1, 1 )``

.. rst-class:: classref-property-setget

- void **set_scale** **(** :ref:`Vector3<class_Vector3>` value **)**
- :ref:`Vector3<class_Vector3>` **get_scale** **(** **)**

Scale part of the local transformation.

\ **Note:** Mixed negative scales in 3D are not decomposable from the transformation matrix. Due to the way scale is represented with transformation matrices in Godot, the scale values will either be all positive or all negative.

\ **Note:** Not all nodes are visually scaled by the :ref:`scale<class_Spatial_property_scale>` property. For example, :ref:`Light<class_Light>`\ s are not visually affected by :ref:`scale<class_Spatial_property_scale>`.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_property_transform:

.. rst-class:: classref-property

:ref:`Transform<class_Transform>` **transform** = ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )``

.. rst-class:: classref-property-setget

- void **set_transform** **(** :ref:`Transform<class_Transform>` value **)**
- :ref:`Transform<class_Transform>` **get_transform** **(** **)**

Local space :ref:`Transform<class_Transform>` of this node, with respect to the parent node.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_property_translation:

.. rst-class:: classref-property

:ref:`Vector3<class_Vector3>` **translation** = ``Vector3( 0, 0, 0 )``

.. rst-class:: classref-property-setget

- void **set_translation** **(** :ref:`Vector3<class_Vector3>` value **)**
- :ref:`Vector3<class_Vector3>` **get_translation** **(** **)**

Local translation of this node.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_property_visible:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **visible** = ``true``

.. rst-class:: classref-property-setget

- void **set_visible** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_visible** **(** **)**

If ``true``, this node is drawn. The node is only visible if all of its ancestors are visible as well (in other words, :ref:`is_visible_in_tree<class_Spatial_method_is_visible_in_tree>` must return ``true``).

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_Spatial_method_force_update_transform:

.. rst-class:: classref-method

void **force_update_transform** **(** **)**

Forces the transform to update. Transform changes in physics are not instant for performance reasons. Transforms are accumulated and then set. Use this if you need an up-to-date transform when doing physics operations.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_get_global_transform_interpolated:

.. rst-class:: classref-method

:ref:`Transform<class_Transform>` **get_global_transform_interpolated** **(** **)**

When using physics interpolation, there will be circumstances in which you want to know the interpolated (displayed) transform of a node rather than the standard transform (which may only be accurate to the most recent physics tick).

This is particularly important for frame-based operations that take place in :ref:`Node._process<class_Node_method__process>`, rather than :ref:`Node._physics_process<class_Node_method__physics_process>`. Examples include :ref:`Camera<class_Camera>`\ s focusing on a node, or finding where to fire lasers from on a frame rather than physics tick.

\ **Note:** This function creates an interpolation pump on the **Spatial** the first time it is called, which can respond to physics interpolation resets. If you get problems with "streaking" when initially following a **Spatial**, be sure to call :ref:`get_global_transform_interpolated<class_Spatial_method_get_global_transform_interpolated>` at least once *before* resetting the **Spatial** physics interpolation.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_get_parent_spatial:

.. rst-class:: classref-method

:ref:`Spatial<class_Spatial>` **get_parent_spatial** **(** **)** |const|

Returns the parent **Spatial**, or an empty :ref:`Object<class_Object>` if no parent exists or parent is not of type **Spatial**.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_get_world:

.. rst-class:: classref-method

:ref:`World<class_World>` **get_world** **(** **)** |const|

Returns the current :ref:`World<class_World>` resource this **Spatial** node is registered to.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_global_rotate:

.. rst-class:: classref-method

void **global_rotate** **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` angle **)**

Rotates the global (world) transformation around axis, a unit :ref:`Vector3<class_Vector3>`, by specified angle in radians. The rotation axis is in global coordinate system.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_global_scale:

.. rst-class:: classref-method

void **global_scale** **(** :ref:`Vector3<class_Vector3>` scale **)**

Scales the global (world) transformation by the given :ref:`Vector3<class_Vector3>` scale factors.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_global_translate:

.. rst-class:: classref-method

void **global_translate** **(** :ref:`Vector3<class_Vector3>` offset **)**

Moves the global (world) transformation by :ref:`Vector3<class_Vector3>` offset. The offset is in global coordinate system.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_hide:

.. rst-class:: classref-method

void **hide** **(** **)**

Disables rendering of this node. Changes :ref:`visible<class_Spatial_property_visible>` to ``false``.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_is_local_transform_notification_enabled:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_local_transform_notification_enabled** **(** **)** |const|

Returns whether node notifies about its local transformation changes. **Spatial** will not propagate this by default.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_is_scale_disabled:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_scale_disabled** **(** **)** |const|

Returns whether this node uses a scale of ``(1, 1, 1)`` or its local transformation scale.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_is_set_as_toplevel:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_set_as_toplevel** **(** **)** |const|

Returns whether this node is set as Toplevel, that is whether it ignores its parent nodes transformations.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_is_transform_notification_enabled:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_transform_notification_enabled** **(** **)** |const|

Returns whether the node notifies about its global and local transformation changes. **Spatial** will not propagate this by default.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_is_visible_in_tree:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_visible_in_tree** **(** **)** |const|

Returns ``true`` if the node is present in the :ref:`SceneTree<class_SceneTree>`, its :ref:`visible<class_Spatial_property_visible>` property is ``true`` and all its ancestors are also visible. If any ancestor is hidden, this node will not be visible in the scene tree.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_look_at:

.. rst-class:: classref-method

void **look_at** **(** :ref:`Vector3<class_Vector3>` target, :ref:`Vector3<class_Vector3>` up **)**

Rotates the node so that the local forward axis (-Z) points toward the ``target`` position.

The local up axis (+Y) points as close to the ``up`` vector as possible while staying perpendicular to the local forward axis. The resulting transform is orthogonal, and the scale is preserved. Non-uniform scaling may not work correctly.

The ``target`` position cannot be the same as the node's position, the ``up`` vector cannot be zero, and the direction from the node's position to the ``target`` vector cannot be parallel to the ``up`` vector.

Operations take place in global space.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_look_at_from_position:

.. rst-class:: classref-method

void **look_at_from_position** **(** :ref:`Vector3<class_Vector3>` position, :ref:`Vector3<class_Vector3>` target, :ref:`Vector3<class_Vector3>` up **)**

Moves the node to the specified ``position``, and then rotates itself to point toward the ``target`` as per :ref:`look_at<class_Spatial_method_look_at>`. Operations take place in global space.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_orthonormalize:

.. rst-class:: classref-method

void **orthonormalize** **(** **)**

Resets this node's transformations (like scale, skew and taper) preserving its rotation and translation by performing Gram-Schmidt orthonormalization on this node's :ref:`Transform<class_Transform>`.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_rotate:

.. rst-class:: classref-method

void **rotate** **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` angle **)**

Rotates the local transformation around axis, a unit :ref:`Vector3<class_Vector3>`, by specified angle in radians.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_rotate_object_local:

.. rst-class:: classref-method

void **rotate_object_local** **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` angle **)**

Rotates the local transformation around axis, a unit :ref:`Vector3<class_Vector3>`, by specified angle in radians. The rotation axis is in object-local coordinate system.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_rotate_x:

.. rst-class:: classref-method

void **rotate_x** **(** :ref:`float<class_float>` angle **)**

Rotates the local transformation around the X axis by angle in radians.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_rotate_y:

.. rst-class:: classref-method

void **rotate_y** **(** :ref:`float<class_float>` angle **)**

Rotates the local transformation around the Y axis by angle in radians.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_rotate_z:

.. rst-class:: classref-method

void **rotate_z** **(** :ref:`float<class_float>` angle **)**

Rotates the local transformation around the Z axis by angle in radians.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_scale_object_local:

.. rst-class:: classref-method

void **scale_object_local** **(** :ref:`Vector3<class_Vector3>` scale **)**

Scales the local transformation by given 3D scale factors in object-local coordinate system.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_set_as_toplevel:

.. rst-class:: classref-method

void **set_as_toplevel** **(** :ref:`bool<class_bool>` enable **)**

Makes the node ignore its parents transformations. Node transformations are only in global space.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_set_disable_scale:

.. rst-class:: classref-method

void **set_disable_scale** **(** :ref:`bool<class_bool>` disable **)**

Sets whether the node uses a scale of ``(1, 1, 1)`` or its local transformation scale. Changes to the local transformation scale are preserved.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_set_identity:

.. rst-class:: classref-method

void **set_identity** **(** **)**

Reset all transformations for this node (sets its :ref:`Transform<class_Transform>` to the identity matrix).

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_set_ignore_transform_notification:

.. rst-class:: classref-method

void **set_ignore_transform_notification** **(** :ref:`bool<class_bool>` enabled **)**

Sets whether the node ignores notification that its transformation (global or local) changed.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_set_notify_local_transform:

.. rst-class:: classref-method

void **set_notify_local_transform** **(** :ref:`bool<class_bool>` enable **)**

Sets whether the node notifies about its local transformation changes. **Spatial** will not propagate this by default.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_set_notify_transform:

.. rst-class:: classref-method

void **set_notify_transform** **(** :ref:`bool<class_bool>` enable **)**

Sets whether the node notifies about its global and local transformation changes. **Spatial** will not propagate this by default, unless it is in the editor context and it has a valid gizmo.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_show:

.. rst-class:: classref-method

void **show** **(** **)**

Enables rendering of this node. Changes :ref:`visible<class_Spatial_property_visible>` to ``true``.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_to_global:

.. rst-class:: classref-method

:ref:`Vector3<class_Vector3>` **to_global** **(** :ref:`Vector3<class_Vector3>` local_point **)** |const|

Transforms ``local_point`` from this node's local space to world space.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_to_local:

.. rst-class:: classref-method

:ref:`Vector3<class_Vector3>` **to_local** **(** :ref:`Vector3<class_Vector3>` global_point **)** |const|

Transforms ``global_point`` from world space to this node's local space.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_translate:

.. rst-class:: classref-method

void **translate** **(** :ref:`Vector3<class_Vector3>` offset **)**

Changes the node's position by the given offset :ref:`Vector3<class_Vector3>`.

Note that the translation ``offset`` is affected by the node's scale, so if scaled by e.g. ``(10, 1, 1)``, a translation by an offset of ``(2, 0, 0)`` would actually add 20 (``2 * 10``) to the X coordinate.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_translate_object_local:

.. rst-class:: classref-method

void **translate_object_local** **(** :ref:`Vector3<class_Vector3>` offset **)**

Changes the node's position by the given offset :ref:`Vector3<class_Vector3>` in local space.

.. rst-class:: classref-item-separator

----

.. _class_Spatial_method_update_gizmo:

.. rst-class:: classref-method

void **update_gizmo** **(** **)**

Updates the :ref:`SpatialGizmo<class_SpatialGizmo>` of this node.

.. |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.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`