class_node3d.rst 66 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Node3D.xml.
  6. .. _class_Node3D:
  7. Node3D
  8. ======
  9. **Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`AudioListener3D<class_AudioListener3D>`, :ref:`AudioStreamPlayer3D<class_AudioStreamPlayer3D>`, :ref:`BoneAttachment3D<class_BoneAttachment3D>`, :ref:`Camera3D<class_Camera3D>`, :ref:`CollisionObject3D<class_CollisionObject3D>`, :ref:`CollisionPolygon3D<class_CollisionPolygon3D>`, :ref:`CollisionShape3D<class_CollisionShape3D>`, :ref:`GridMap<class_GridMap>`, :ref:`ImporterMeshInstance3D<class_ImporterMeshInstance3D>`, :ref:`Joint3D<class_Joint3D>`, :ref:`LightmapProbe<class_LightmapProbe>`, :ref:`Marker3D<class_Marker3D>`, :ref:`NavigationLink3D<class_NavigationLink3D>`, :ref:`NavigationObstacle3D<class_NavigationObstacle3D>`, :ref:`NavigationRegion3D<class_NavigationRegion3D>`, :ref:`OpenXRCompositionLayer<class_OpenXRCompositionLayer>`, :ref:`OpenXRHand<class_OpenXRHand>`, :ref:`Path3D<class_Path3D>`, :ref:`PathFollow3D<class_PathFollow3D>`, :ref:`RayCast3D<class_RayCast3D>`, :ref:`RemoteTransform3D<class_RemoteTransform3D>`, :ref:`ShapeCast3D<class_ShapeCast3D>`, :ref:`Skeleton3D<class_Skeleton3D>`, :ref:`SkeletonModifier3D<class_SkeletonModifier3D>`, :ref:`SpringArm3D<class_SpringArm3D>`, :ref:`VehicleWheel3D<class_VehicleWheel3D>`, :ref:`VisualInstance3D<class_VisualInstance3D>`, :ref:`XRFaceModifier3D<class_XRFaceModifier3D>`, :ref:`XRNode3D<class_XRNode3D>`, :ref:`XROrigin3D<class_XROrigin3D>`
  11. Most basic 3D game object, parent of all 3D-related nodes.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. Most basic 3D game object, with a :ref:`Transform3D<class_Transform3D>` and visibility settings. All other 3D game objects inherit from **Node3D**. Use **Node3D** as a parent node to move, scale, rotate and show/hide children in a 3D project.
  16. Affine operations (rotate, scale, translate) happen in parent's local coordinate system, unless the **Node3D** object is set as top-level. Affine operations in this coordinate system correspond to direct affine operations on the **Node3D**'s transform. The word local below refers to this coordinate system. The coordinate system that is attached to the **Node3D** object itself is referred to as object-local coordinate system.
  17. \ **Note:** Unless otherwise specified, all methods that have angle parameters must have angles specified as *radians*. To convert degrees to radians, use :ref:`@GlobalScope.deg_to_rad<class_@GlobalScope_method_deg_to_rad>`.
  18. \ **Note:** Be aware that "Spatial" nodes are now called "Node3D" starting with Godot 4. Any Godot 3.x references to "Spatial" nodes refer to "Node3D" in Godot 4.
  19. .. rst-class:: classref-introduction-group
  20. Tutorials
  21. ---------
  22. - :doc:`Introduction to 3D <../tutorials/3d/introduction_to_3d>`
  23. - `All 3D Demos <https://github.com/godotengine/godot-demo-projects/tree/master/3d>`__
  24. .. rst-class:: classref-reftable-group
  25. Properties
  26. ----------
  27. .. table::
  28. :widths: auto
  29. +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+
  30. | :ref:`Basis<class_Basis>` | :ref:`basis<class_Node3D_property_basis>` | |
  31. +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+
  32. | :ref:`Basis<class_Basis>` | :ref:`global_basis<class_Node3D_property_global_basis>` | |
  33. +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+
  34. | :ref:`Vector3<class_Vector3>` | :ref:`global_position<class_Node3D_property_global_position>` | |
  35. +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+
  36. | :ref:`Vector3<class_Vector3>` | :ref:`global_rotation<class_Node3D_property_global_rotation>` | |
  37. +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+
  38. | :ref:`Vector3<class_Vector3>` | :ref:`global_rotation_degrees<class_Node3D_property_global_rotation_degrees>` | |
  39. +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+
  40. | :ref:`Transform3D<class_Transform3D>` | :ref:`global_transform<class_Node3D_property_global_transform>` | |
  41. +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+
  42. | :ref:`Vector3<class_Vector3>` | :ref:`position<class_Node3D_property_position>` | ``Vector3(0, 0, 0)`` |
  43. +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+
  44. | :ref:`Quaternion<class_Quaternion>` | :ref:`quaternion<class_Node3D_property_quaternion>` | |
  45. +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+
  46. | :ref:`Vector3<class_Vector3>` | :ref:`rotation<class_Node3D_property_rotation>` | ``Vector3(0, 0, 0)`` |
  47. +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+
  48. | :ref:`Vector3<class_Vector3>` | :ref:`rotation_degrees<class_Node3D_property_rotation_degrees>` | |
  49. +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+
  50. | :ref:`RotationEditMode<enum_Node3D_RotationEditMode>` | :ref:`rotation_edit_mode<class_Node3D_property_rotation_edit_mode>` | ``0`` |
  51. +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+
  52. | :ref:`EulerOrder<enum_@GlobalScope_EulerOrder>` | :ref:`rotation_order<class_Node3D_property_rotation_order>` | ``2`` |
  53. +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+
  54. | :ref:`Vector3<class_Vector3>` | :ref:`scale<class_Node3D_property_scale>` | ``Vector3(1, 1, 1)`` |
  55. +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+
  56. | :ref:`bool<class_bool>` | :ref:`top_level<class_Node3D_property_top_level>` | ``false`` |
  57. +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+
  58. | :ref:`Transform3D<class_Transform3D>` | :ref:`transform<class_Node3D_property_transform>` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` |
  59. +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+
  60. | :ref:`NodePath<class_NodePath>` | :ref:`visibility_parent<class_Node3D_property_visibility_parent>` | ``NodePath("")`` |
  61. +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+
  62. | :ref:`bool<class_bool>` | :ref:`visible<class_Node3D_property_visible>` | ``true`` |
  63. +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+
  64. .. rst-class:: classref-reftable-group
  65. Methods
  66. -------
  67. .. table::
  68. :widths: auto
  69. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | |void| | :ref:`add_gizmo<class_Node3D_method_add_gizmo>`\ (\ gizmo\: :ref:`Node3DGizmo<class_Node3DGizmo>`\ ) |
  71. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | |void| | :ref:`clear_gizmos<class_Node3D_method_clear_gizmos>`\ (\ ) |
  73. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | |void| | :ref:`clear_subgizmo_selection<class_Node3D_method_clear_subgizmo_selection>`\ (\ ) |
  75. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | |void| | :ref:`force_update_transform<class_Node3D_method_force_update_transform>`\ (\ ) |
  77. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | :ref:`Array<class_Array>`\[:ref:`Node3DGizmo<class_Node3DGizmo>`\] | :ref:`get_gizmos<class_Node3D_method_get_gizmos>`\ (\ ) |const| |
  79. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | :ref:`Transform3D<class_Transform3D>` | :ref:`get_global_transform_interpolated<class_Node3D_method_get_global_transform_interpolated>`\ (\ ) |
  81. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | :ref:`Node3D<class_Node3D>` | :ref:`get_parent_node_3d<class_Node3D_method_get_parent_node_3d>`\ (\ ) |const| |
  83. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | :ref:`World3D<class_World3D>` | :ref:`get_world_3d<class_Node3D_method_get_world_3d>`\ (\ ) |const| |
  85. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | |void| | :ref:`global_rotate<class_Node3D_method_global_rotate>`\ (\ axis\: :ref:`Vector3<class_Vector3>`, angle\: :ref:`float<class_float>`\ ) |
  87. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | |void| | :ref:`global_scale<class_Node3D_method_global_scale>`\ (\ scale\: :ref:`Vector3<class_Vector3>`\ ) |
  89. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | |void| | :ref:`global_translate<class_Node3D_method_global_translate>`\ (\ offset\: :ref:`Vector3<class_Vector3>`\ ) |
  91. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | |void| | :ref:`hide<class_Node3D_method_hide>`\ (\ ) |
  93. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | :ref:`bool<class_bool>` | :ref:`is_local_transform_notification_enabled<class_Node3D_method_is_local_transform_notification_enabled>`\ (\ ) |const| |
  95. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | :ref:`bool<class_bool>` | :ref:`is_scale_disabled<class_Node3D_method_is_scale_disabled>`\ (\ ) |const| |
  97. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | :ref:`bool<class_bool>` | :ref:`is_transform_notification_enabled<class_Node3D_method_is_transform_notification_enabled>`\ (\ ) |const| |
  99. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | :ref:`bool<class_bool>` | :ref:`is_visible_in_tree<class_Node3D_method_is_visible_in_tree>`\ (\ ) |const| |
  101. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | |void| | :ref:`look_at<class_Node3D_method_look_at>`\ (\ target\: :ref:`Vector3<class_Vector3>`, up\: :ref:`Vector3<class_Vector3>` = Vector3(0, 1, 0), use_model_front\: :ref:`bool<class_bool>` = false\ ) |
  103. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | |void| | :ref:`look_at_from_position<class_Node3D_method_look_at_from_position>`\ (\ position\: :ref:`Vector3<class_Vector3>`, target\: :ref:`Vector3<class_Vector3>`, up\: :ref:`Vector3<class_Vector3>` = Vector3(0, 1, 0), use_model_front\: :ref:`bool<class_bool>` = false\ ) |
  105. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | |void| | :ref:`orthonormalize<class_Node3D_method_orthonormalize>`\ (\ ) |
  107. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | |void| | :ref:`rotate<class_Node3D_method_rotate>`\ (\ axis\: :ref:`Vector3<class_Vector3>`, angle\: :ref:`float<class_float>`\ ) |
  109. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | |void| | :ref:`rotate_object_local<class_Node3D_method_rotate_object_local>`\ (\ axis\: :ref:`Vector3<class_Vector3>`, angle\: :ref:`float<class_float>`\ ) |
  111. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. | |void| | :ref:`rotate_x<class_Node3D_method_rotate_x>`\ (\ angle\: :ref:`float<class_float>`\ ) |
  113. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  114. | |void| | :ref:`rotate_y<class_Node3D_method_rotate_y>`\ (\ angle\: :ref:`float<class_float>`\ ) |
  115. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  116. | |void| | :ref:`rotate_z<class_Node3D_method_rotate_z>`\ (\ angle\: :ref:`float<class_float>`\ ) |
  117. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  118. | |void| | :ref:`scale_object_local<class_Node3D_method_scale_object_local>`\ (\ scale\: :ref:`Vector3<class_Vector3>`\ ) |
  119. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  120. | |void| | :ref:`set_disable_scale<class_Node3D_method_set_disable_scale>`\ (\ disable\: :ref:`bool<class_bool>`\ ) |
  121. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  122. | |void| | :ref:`set_identity<class_Node3D_method_set_identity>`\ (\ ) |
  123. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  124. | |void| | :ref:`set_ignore_transform_notification<class_Node3D_method_set_ignore_transform_notification>`\ (\ enabled\: :ref:`bool<class_bool>`\ ) |
  125. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  126. | |void| | :ref:`set_notify_local_transform<class_Node3D_method_set_notify_local_transform>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
  127. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  128. | |void| | :ref:`set_notify_transform<class_Node3D_method_set_notify_transform>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
  129. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  130. | |void| | :ref:`set_subgizmo_selection<class_Node3D_method_set_subgizmo_selection>`\ (\ gizmo\: :ref:`Node3DGizmo<class_Node3DGizmo>`, id\: :ref:`int<class_int>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  131. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  132. | |void| | :ref:`show<class_Node3D_method_show>`\ (\ ) |
  133. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  134. | :ref:`Vector3<class_Vector3>` | :ref:`to_global<class_Node3D_method_to_global>`\ (\ local_point\: :ref:`Vector3<class_Vector3>`\ ) |const| |
  135. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  136. | :ref:`Vector3<class_Vector3>` | :ref:`to_local<class_Node3D_method_to_local>`\ (\ global_point\: :ref:`Vector3<class_Vector3>`\ ) |const| |
  137. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  138. | |void| | :ref:`translate<class_Node3D_method_translate>`\ (\ offset\: :ref:`Vector3<class_Vector3>`\ ) |
  139. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  140. | |void| | :ref:`translate_object_local<class_Node3D_method_translate_object_local>`\ (\ offset\: :ref:`Vector3<class_Vector3>`\ ) |
  141. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  142. | |void| | :ref:`update_gizmos<class_Node3D_method_update_gizmos>`\ (\ ) |
  143. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  144. .. rst-class:: classref-section-separator
  145. ----
  146. .. rst-class:: classref-descriptions-group
  147. Signals
  148. -------
  149. .. _class_Node3D_signal_visibility_changed:
  150. .. rst-class:: classref-signal
  151. **visibility_changed**\ (\ ) :ref:`๐Ÿ”—<class_Node3D_signal_visibility_changed>`
  152. Emitted when node visibility changes.
  153. .. rst-class:: classref-section-separator
  154. ----
  155. .. rst-class:: classref-descriptions-group
  156. Enumerations
  157. ------------
  158. .. _enum_Node3D_RotationEditMode:
  159. .. rst-class:: classref-enumeration
  160. enum **RotationEditMode**: :ref:`๐Ÿ”—<enum_Node3D_RotationEditMode>`
  161. .. _class_Node3D_constant_ROTATION_EDIT_MODE_EULER:
  162. .. rst-class:: classref-enumeration-constant
  163. :ref:`RotationEditMode<enum_Node3D_RotationEditMode>` **ROTATION_EDIT_MODE_EULER** = ``0``
  164. The rotation is edited using :ref:`Vector3<class_Vector3>` Euler angles.
  165. .. _class_Node3D_constant_ROTATION_EDIT_MODE_QUATERNION:
  166. .. rst-class:: classref-enumeration-constant
  167. :ref:`RotationEditMode<enum_Node3D_RotationEditMode>` **ROTATION_EDIT_MODE_QUATERNION** = ``1``
  168. The rotation is edited using a :ref:`Quaternion<class_Quaternion>`.
  169. .. _class_Node3D_constant_ROTATION_EDIT_MODE_BASIS:
  170. .. rst-class:: classref-enumeration-constant
  171. :ref:`RotationEditMode<enum_Node3D_RotationEditMode>` **ROTATION_EDIT_MODE_BASIS** = ``2``
  172. The rotation is edited using a :ref:`Basis<class_Basis>`. In this mode, :ref:`scale<class_Node3D_property_scale>` can't be edited separately.
  173. .. rst-class:: classref-section-separator
  174. ----
  175. .. rst-class:: classref-descriptions-group
  176. Constants
  177. ---------
  178. .. _class_Node3D_constant_NOTIFICATION_TRANSFORM_CHANGED:
  179. .. rst-class:: classref-constant
  180. **NOTIFICATION_TRANSFORM_CHANGED** = ``2000`` :ref:`๐Ÿ”—<class_Node3D_constant_NOTIFICATION_TRANSFORM_CHANGED>`
  181. **Node3D** nodes receive this notification when their global transform changes. This means that either the current or a parent node changed its transform.
  182. In order for :ref:`NOTIFICATION_TRANSFORM_CHANGED<class_Node3D_constant_NOTIFICATION_TRANSFORM_CHANGED>` to work, users first need to ask for it, with :ref:`set_notify_transform<class_Node3D_method_set_notify_transform>`. The notification is also sent if the node is in the editor context and it has at least one valid gizmo.
  183. .. _class_Node3D_constant_NOTIFICATION_ENTER_WORLD:
  184. .. rst-class:: classref-constant
  185. **NOTIFICATION_ENTER_WORLD** = ``41`` :ref:`๐Ÿ”—<class_Node3D_constant_NOTIFICATION_ENTER_WORLD>`
  186. **Node3D** nodes receive this notification when they are registered to new :ref:`World3D<class_World3D>` resource.
  187. .. _class_Node3D_constant_NOTIFICATION_EXIT_WORLD:
  188. .. rst-class:: classref-constant
  189. **NOTIFICATION_EXIT_WORLD** = ``42`` :ref:`๐Ÿ”—<class_Node3D_constant_NOTIFICATION_EXIT_WORLD>`
  190. **Node3D** nodes receive this notification when they are unregistered from current :ref:`World3D<class_World3D>` resource.
  191. .. _class_Node3D_constant_NOTIFICATION_VISIBILITY_CHANGED:
  192. .. rst-class:: classref-constant
  193. **NOTIFICATION_VISIBILITY_CHANGED** = ``43`` :ref:`๐Ÿ”—<class_Node3D_constant_NOTIFICATION_VISIBILITY_CHANGED>`
  194. **Node3D** nodes receive this notification when their visibility changes.
  195. .. _class_Node3D_constant_NOTIFICATION_LOCAL_TRANSFORM_CHANGED:
  196. .. rst-class:: classref-constant
  197. **NOTIFICATION_LOCAL_TRANSFORM_CHANGED** = ``44`` :ref:`๐Ÿ”—<class_Node3D_constant_NOTIFICATION_LOCAL_TRANSFORM_CHANGED>`
  198. **Node3D** nodes receive this notification when their local transform changes. This is not received when the transform of a parent node is changed.
  199. In order for :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED<class_Node3D_constant_NOTIFICATION_LOCAL_TRANSFORM_CHANGED>` to work, users first need to ask for it, with :ref:`set_notify_local_transform<class_Node3D_method_set_notify_local_transform>`.
  200. .. rst-class:: classref-section-separator
  201. ----
  202. .. rst-class:: classref-descriptions-group
  203. Property Descriptions
  204. ---------------------
  205. .. _class_Node3D_property_basis:
  206. .. rst-class:: classref-property
  207. :ref:`Basis<class_Basis>` **basis** :ref:`๐Ÿ”—<class_Node3D_property_basis>`
  208. .. rst-class:: classref-property-setget
  209. - |void| **set_basis**\ (\ value\: :ref:`Basis<class_Basis>`\ )
  210. - :ref:`Basis<class_Basis>` **get_basis**\ (\ )
  211. Basis of the :ref:`transform<class_Node3D_property_transform>` property. Represents the rotation, scale, and shear of this node.
  212. .. rst-class:: classref-item-separator
  213. ----
  214. .. _class_Node3D_property_global_basis:
  215. .. rst-class:: classref-property
  216. :ref:`Basis<class_Basis>` **global_basis** :ref:`๐Ÿ”—<class_Node3D_property_global_basis>`
  217. .. rst-class:: classref-property-setget
  218. - |void| **set_global_basis**\ (\ value\: :ref:`Basis<class_Basis>`\ )
  219. - :ref:`Basis<class_Basis>` **get_global_basis**\ (\ )
  220. Global basis of this node. This is equivalent to ``global_transform.basis``.
  221. .. rst-class:: classref-item-separator
  222. ----
  223. .. _class_Node3D_property_global_position:
  224. .. rst-class:: classref-property
  225. :ref:`Vector3<class_Vector3>` **global_position** :ref:`๐Ÿ”—<class_Node3D_property_global_position>`
  226. .. rst-class:: classref-property-setget
  227. - |void| **set_global_position**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  228. - :ref:`Vector3<class_Vector3>` **get_global_position**\ (\ )
  229. Global position of this node. This is equivalent to ``global_transform.origin``.
  230. .. rst-class:: classref-item-separator
  231. ----
  232. .. _class_Node3D_property_global_rotation:
  233. .. rst-class:: classref-property
  234. :ref:`Vector3<class_Vector3>` **global_rotation** :ref:`๐Ÿ”—<class_Node3D_property_global_rotation>`
  235. .. rst-class:: classref-property-setget
  236. - |void| **set_global_rotation**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  237. - :ref:`Vector3<class_Vector3>` **get_global_rotation**\ (\ )
  238. Rotation part of the global transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).
  239. \ **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.
  240. .. rst-class:: classref-item-separator
  241. ----
  242. .. _class_Node3D_property_global_rotation_degrees:
  243. .. rst-class:: classref-property
  244. :ref:`Vector3<class_Vector3>` **global_rotation_degrees** :ref:`๐Ÿ”—<class_Node3D_property_global_rotation_degrees>`
  245. .. rst-class:: classref-property-setget
  246. - |void| **set_global_rotation_degrees**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  247. - :ref:`Vector3<class_Vector3>` **get_global_rotation_degrees**\ (\ )
  248. Helper property to access :ref:`global_rotation<class_Node3D_property_global_rotation>` in degrees instead of radians.
  249. .. rst-class:: classref-item-separator
  250. ----
  251. .. _class_Node3D_property_global_transform:
  252. .. rst-class:: classref-property
  253. :ref:`Transform3D<class_Transform3D>` **global_transform** :ref:`๐Ÿ”—<class_Node3D_property_global_transform>`
  254. .. rst-class:: classref-property-setget
  255. - |void| **set_global_transform**\ (\ value\: :ref:`Transform3D<class_Transform3D>`\ )
  256. - :ref:`Transform3D<class_Transform3D>` **get_global_transform**\ (\ )
  257. World3D space (global) :ref:`Transform3D<class_Transform3D>` of this node.
  258. .. rst-class:: classref-item-separator
  259. ----
  260. .. _class_Node3D_property_position:
  261. .. rst-class:: classref-property
  262. :ref:`Vector3<class_Vector3>` **position** = ``Vector3(0, 0, 0)`` :ref:`๐Ÿ”—<class_Node3D_property_position>`
  263. .. rst-class:: classref-property-setget
  264. - |void| **set_position**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  265. - :ref:`Vector3<class_Vector3>` **get_position**\ (\ )
  266. Local position or translation of this node relative to the parent. This is equivalent to ``transform.origin``.
  267. .. rst-class:: classref-item-separator
  268. ----
  269. .. _class_Node3D_property_quaternion:
  270. .. rst-class:: classref-property
  271. :ref:`Quaternion<class_Quaternion>` **quaternion** :ref:`๐Ÿ”—<class_Node3D_property_quaternion>`
  272. .. rst-class:: classref-property-setget
  273. - |void| **set_quaternion**\ (\ value\: :ref:`Quaternion<class_Quaternion>`\ )
  274. - :ref:`Quaternion<class_Quaternion>` **get_quaternion**\ (\ )
  275. Access to the node rotation as a :ref:`Quaternion<class_Quaternion>`. This property is ideal for tweening complex rotations.
  276. .. rst-class:: classref-item-separator
  277. ----
  278. .. _class_Node3D_property_rotation:
  279. .. rst-class:: classref-property
  280. :ref:`Vector3<class_Vector3>` **rotation** = ``Vector3(0, 0, 0)`` :ref:`๐Ÿ”—<class_Node3D_property_rotation>`
  281. .. rst-class:: classref-property-setget
  282. - |void| **set_rotation**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  283. - :ref:`Vector3<class_Vector3>` **get_rotation**\ (\ )
  284. Rotation part of the local transformation in radians, specified in terms of Euler angles. The angles construct a rotation in the order specified by the :ref:`rotation_order<class_Node3D_property_rotation_order>` property.
  285. \ **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.
  286. \ **Note:** This property is edited in the inspector in degrees. If you want to use degrees in a script, use :ref:`rotation_degrees<class_Node3D_property_rotation_degrees>`.
  287. .. rst-class:: classref-item-separator
  288. ----
  289. .. _class_Node3D_property_rotation_degrees:
  290. .. rst-class:: classref-property
  291. :ref:`Vector3<class_Vector3>` **rotation_degrees** :ref:`๐Ÿ”—<class_Node3D_property_rotation_degrees>`
  292. .. rst-class:: classref-property-setget
  293. - |void| **set_rotation_degrees**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  294. - :ref:`Vector3<class_Vector3>` **get_rotation_degrees**\ (\ )
  295. Helper property to access :ref:`rotation<class_Node3D_property_rotation>` in degrees instead of radians.
  296. .. rst-class:: classref-item-separator
  297. ----
  298. .. _class_Node3D_property_rotation_edit_mode:
  299. .. rst-class:: classref-property
  300. :ref:`RotationEditMode<enum_Node3D_RotationEditMode>` **rotation_edit_mode** = ``0`` :ref:`๐Ÿ”—<class_Node3D_property_rotation_edit_mode>`
  301. .. rst-class:: classref-property-setget
  302. - |void| **set_rotation_edit_mode**\ (\ value\: :ref:`RotationEditMode<enum_Node3D_RotationEditMode>`\ )
  303. - :ref:`RotationEditMode<enum_Node3D_RotationEditMode>` **get_rotation_edit_mode**\ (\ )
  304. Specify how rotation (and scale) will be presented in the editor.
  305. .. rst-class:: classref-item-separator
  306. ----
  307. .. _class_Node3D_property_rotation_order:
  308. .. rst-class:: classref-property
  309. :ref:`EulerOrder<enum_@GlobalScope_EulerOrder>` **rotation_order** = ``2`` :ref:`๐Ÿ”—<class_Node3D_property_rotation_order>`
  310. .. rst-class:: classref-property-setget
  311. - |void| **set_rotation_order**\ (\ value\: :ref:`EulerOrder<enum_@GlobalScope_EulerOrder>`\ )
  312. - :ref:`EulerOrder<enum_@GlobalScope_EulerOrder>` **get_rotation_order**\ (\ )
  313. Specify the axis rotation order of the :ref:`rotation<class_Node3D_property_rotation>` property. The final orientation is constructed by rotating the Euler angles in the order specified by this property.
  314. .. rst-class:: classref-item-separator
  315. ----
  316. .. _class_Node3D_property_scale:
  317. .. rst-class:: classref-property
  318. :ref:`Vector3<class_Vector3>` **scale** = ``Vector3(1, 1, 1)`` :ref:`๐Ÿ”—<class_Node3D_property_scale>`
  319. .. rst-class:: classref-property-setget
  320. - |void| **set_scale**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  321. - :ref:`Vector3<class_Vector3>` **get_scale**\ (\ )
  322. Scale part of the local transformation.
  323. \ **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.
  324. \ **Note:** Not all nodes are visually scaled by the :ref:`scale<class_Node3D_property_scale>` property. For example, :ref:`Light3D<class_Light3D>`\ s are not visually affected by :ref:`scale<class_Node3D_property_scale>`.
  325. .. rst-class:: classref-item-separator
  326. ----
  327. .. _class_Node3D_property_top_level:
  328. .. rst-class:: classref-property
  329. :ref:`bool<class_bool>` **top_level** = ``false`` :ref:`๐Ÿ”—<class_Node3D_property_top_level>`
  330. .. rst-class:: classref-property-setget
  331. - |void| **set_as_top_level**\ (\ value\: :ref:`bool<class_bool>`\ )
  332. - :ref:`bool<class_bool>` **is_set_as_top_level**\ (\ )
  333. If ``true``, the node will not inherit its transformations from its parent. Node transformations are only in global space.
  334. .. rst-class:: classref-item-separator
  335. ----
  336. .. _class_Node3D_property_transform:
  337. .. rst-class:: classref-property
  338. :ref:`Transform3D<class_Transform3D>` **transform** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` :ref:`๐Ÿ”—<class_Node3D_property_transform>`
  339. .. rst-class:: classref-property-setget
  340. - |void| **set_transform**\ (\ value\: :ref:`Transform3D<class_Transform3D>`\ )
  341. - :ref:`Transform3D<class_Transform3D>` **get_transform**\ (\ )
  342. Local space :ref:`Transform3D<class_Transform3D>` of this node, with respect to the parent node.
  343. .. rst-class:: classref-item-separator
  344. ----
  345. .. _class_Node3D_property_visibility_parent:
  346. .. rst-class:: classref-property
  347. :ref:`NodePath<class_NodePath>` **visibility_parent** = ``NodePath("")`` :ref:`๐Ÿ”—<class_Node3D_property_visibility_parent>`
  348. .. rst-class:: classref-property-setget
  349. - |void| **set_visibility_parent**\ (\ value\: :ref:`NodePath<class_NodePath>`\ )
  350. - :ref:`NodePath<class_NodePath>` **get_visibility_parent**\ (\ )
  351. Defines the visibility range parent for this node and its subtree. The visibility parent must be a GeometryInstance3D. Any visual instance will only be visible if the visibility parent (and all of its visibility ancestors) is hidden by being closer to the camera than its own :ref:`GeometryInstance3D.visibility_range_begin<class_GeometryInstance3D_property_visibility_range_begin>`. Nodes hidden via the :ref:`visible<class_Node3D_property_visible>` property are essentially removed from the visibility dependency tree, so dependent instances will not take the hidden node or its ancestors into account.
  352. .. rst-class:: classref-item-separator
  353. ----
  354. .. _class_Node3D_property_visible:
  355. .. rst-class:: classref-property
  356. :ref:`bool<class_bool>` **visible** = ``true`` :ref:`๐Ÿ”—<class_Node3D_property_visible>`
  357. .. rst-class:: classref-property-setget
  358. - |void| **set_visible**\ (\ value\: :ref:`bool<class_bool>`\ )
  359. - :ref:`bool<class_bool>` **is_visible**\ (\ )
  360. 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_Node3D_method_is_visible_in_tree>` must return ``true``).
  361. .. rst-class:: classref-section-separator
  362. ----
  363. .. rst-class:: classref-descriptions-group
  364. Method Descriptions
  365. -------------------
  366. .. _class_Node3D_method_add_gizmo:
  367. .. rst-class:: classref-method
  368. |void| **add_gizmo**\ (\ gizmo\: :ref:`Node3DGizmo<class_Node3DGizmo>`\ ) :ref:`๐Ÿ”—<class_Node3D_method_add_gizmo>`
  369. Attach an editor gizmo to this **Node3D**.
  370. \ **Note:** The gizmo object would typically be an instance of :ref:`EditorNode3DGizmo<class_EditorNode3DGizmo>`, but the argument type is kept generic to avoid creating a dependency on editor classes in **Node3D**.
  371. .. rst-class:: classref-item-separator
  372. ----
  373. .. _class_Node3D_method_clear_gizmos:
  374. .. rst-class:: classref-method
  375. |void| **clear_gizmos**\ (\ ) :ref:`๐Ÿ”—<class_Node3D_method_clear_gizmos>`
  376. Clear all gizmos attached to this **Node3D**.
  377. .. rst-class:: classref-item-separator
  378. ----
  379. .. _class_Node3D_method_clear_subgizmo_selection:
  380. .. rst-class:: classref-method
  381. |void| **clear_subgizmo_selection**\ (\ ) :ref:`๐Ÿ”—<class_Node3D_method_clear_subgizmo_selection>`
  382. Clears subgizmo selection for this node in the editor. Useful when subgizmo IDs become invalid after a property change.
  383. .. rst-class:: classref-item-separator
  384. ----
  385. .. _class_Node3D_method_force_update_transform:
  386. .. rst-class:: classref-method
  387. |void| **force_update_transform**\ (\ ) :ref:`๐Ÿ”—<class_Node3D_method_force_update_transform>`
  388. 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.
  389. .. rst-class:: classref-item-separator
  390. ----
  391. .. _class_Node3D_method_get_gizmos:
  392. .. rst-class:: classref-method
  393. :ref:`Array<class_Array>`\[:ref:`Node3DGizmo<class_Node3DGizmo>`\] **get_gizmos**\ (\ ) |const| :ref:`๐Ÿ”—<class_Node3D_method_get_gizmos>`
  394. Returns all the gizmos attached to this **Node3D**.
  395. .. rst-class:: classref-item-separator
  396. ----
  397. .. _class_Node3D_method_get_global_transform_interpolated:
  398. .. rst-class:: classref-method
  399. :ref:`Transform3D<class_Transform3D>` **get_global_transform_interpolated**\ (\ ) :ref:`๐Ÿ”—<class_Node3D_method_get_global_transform_interpolated>`
  400. 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).
  401. This is particularly important for frame-based operations that take place in :ref:`Node._process<class_Node_private_method__process>`, rather than :ref:`Node._physics_process<class_Node_private_method__physics_process>`. Examples include :ref:`Camera3D<class_Camera3D>`\ s focusing on a node, or finding where to fire lasers from on a frame rather than physics tick.
  402. \ **Note:** This function creates an interpolation pump on the **Node3D** the first time it is called, which can respond to physics interpolation resets. If you get problems with "streaking" when initially following a **Node3D**, be sure to call :ref:`get_global_transform_interpolated<class_Node3D_method_get_global_transform_interpolated>` at least once *before* resetting the **Node3D** physics interpolation.
  403. .. rst-class:: classref-item-separator
  404. ----
  405. .. _class_Node3D_method_get_parent_node_3d:
  406. .. rst-class:: classref-method
  407. :ref:`Node3D<class_Node3D>` **get_parent_node_3d**\ (\ ) |const| :ref:`๐Ÿ”—<class_Node3D_method_get_parent_node_3d>`
  408. Returns the parent **Node3D**, or ``null`` if no parent exists, the parent is not of type **Node3D**, or :ref:`top_level<class_Node3D_property_top_level>` is ``true``.
  409. \ **Note:** Calling this method is not equivalent to ``get_parent() as Node3D``, which does not take :ref:`top_level<class_Node3D_property_top_level>` into account.
  410. .. rst-class:: classref-item-separator
  411. ----
  412. .. _class_Node3D_method_get_world_3d:
  413. .. rst-class:: classref-method
  414. :ref:`World3D<class_World3D>` **get_world_3d**\ (\ ) |const| :ref:`๐Ÿ”—<class_Node3D_method_get_world_3d>`
  415. Returns the current :ref:`World3D<class_World3D>` resource this **Node3D** node is registered to.
  416. .. rst-class:: classref-item-separator
  417. ----
  418. .. _class_Node3D_method_global_rotate:
  419. .. rst-class:: classref-method
  420. |void| **global_rotate**\ (\ axis\: :ref:`Vector3<class_Vector3>`, angle\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_Node3D_method_global_rotate>`
  421. 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.
  422. .. rst-class:: classref-item-separator
  423. ----
  424. .. _class_Node3D_method_global_scale:
  425. .. rst-class:: classref-method
  426. |void| **global_scale**\ (\ scale\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_Node3D_method_global_scale>`
  427. Scales the global (world) transformation by the given :ref:`Vector3<class_Vector3>` scale factors.
  428. .. rst-class:: classref-item-separator
  429. ----
  430. .. _class_Node3D_method_global_translate:
  431. .. rst-class:: classref-method
  432. |void| **global_translate**\ (\ offset\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_Node3D_method_global_translate>`
  433. Moves the global (world) transformation by :ref:`Vector3<class_Vector3>` offset. The offset is in global coordinate system.
  434. .. rst-class:: classref-item-separator
  435. ----
  436. .. _class_Node3D_method_hide:
  437. .. rst-class:: classref-method
  438. |void| **hide**\ (\ ) :ref:`๐Ÿ”—<class_Node3D_method_hide>`
  439. Disables rendering of this node. Changes :ref:`visible<class_Node3D_property_visible>` to ``false``.
  440. .. rst-class:: classref-item-separator
  441. ----
  442. .. _class_Node3D_method_is_local_transform_notification_enabled:
  443. .. rst-class:: classref-method
  444. :ref:`bool<class_bool>` **is_local_transform_notification_enabled**\ (\ ) |const| :ref:`๐Ÿ”—<class_Node3D_method_is_local_transform_notification_enabled>`
  445. Returns whether node notifies about its local transformation changes. **Node3D** will not propagate this by default.
  446. .. rst-class:: classref-item-separator
  447. ----
  448. .. _class_Node3D_method_is_scale_disabled:
  449. .. rst-class:: classref-method
  450. :ref:`bool<class_bool>` **is_scale_disabled**\ (\ ) |const| :ref:`๐Ÿ”—<class_Node3D_method_is_scale_disabled>`
  451. Returns whether this node uses a scale of ``(1, 1, 1)`` or its local transformation scale.
  452. .. rst-class:: classref-item-separator
  453. ----
  454. .. _class_Node3D_method_is_transform_notification_enabled:
  455. .. rst-class:: classref-method
  456. :ref:`bool<class_bool>` **is_transform_notification_enabled**\ (\ ) |const| :ref:`๐Ÿ”—<class_Node3D_method_is_transform_notification_enabled>`
  457. Returns whether the node notifies about its global and local transformation changes. **Node3D** will not propagate this by default.
  458. .. rst-class:: classref-item-separator
  459. ----
  460. .. _class_Node3D_method_is_visible_in_tree:
  461. .. rst-class:: classref-method
  462. :ref:`bool<class_bool>` **is_visible_in_tree**\ (\ ) |const| :ref:`๐Ÿ”—<class_Node3D_method_is_visible_in_tree>`
  463. Returns ``true`` if the node is present in the :ref:`SceneTree<class_SceneTree>`, its :ref:`visible<class_Node3D_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.
  464. .. rst-class:: classref-item-separator
  465. ----
  466. .. _class_Node3D_method_look_at:
  467. .. rst-class:: classref-method
  468. |void| **look_at**\ (\ target\: :ref:`Vector3<class_Vector3>`, up\: :ref:`Vector3<class_Vector3>` = Vector3(0, 1, 0), use_model_front\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_Node3D_method_look_at>`
  469. Rotates the node so that the local forward axis (-Z, :ref:`Vector3.FORWARD<class_Vector3_constant_FORWARD>`) points toward the ``target`` position.
  470. 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.
  471. 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.
  472. Operations take place in global space, which means that the node must be in the scene tree.
  473. If ``use_model_front`` is ``true``, the +Z axis (asset front) is treated as forward (implies +X is left) and points toward the ``target`` position. By default, the -Z axis (camera forward) is treated as forward (implies +X is right).
  474. .. rst-class:: classref-item-separator
  475. ----
  476. .. _class_Node3D_method_look_at_from_position:
  477. .. rst-class:: classref-method
  478. |void| **look_at_from_position**\ (\ position\: :ref:`Vector3<class_Vector3>`, target\: :ref:`Vector3<class_Vector3>`, up\: :ref:`Vector3<class_Vector3>` = Vector3(0, 1, 0), use_model_front\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_Node3D_method_look_at_from_position>`
  479. Moves the node to the specified ``position``, and then rotates the node to point toward the ``target`` as per :ref:`look_at<class_Node3D_method_look_at>`. Operations take place in global space.
  480. .. rst-class:: classref-item-separator
  481. ----
  482. .. _class_Node3D_method_orthonormalize:
  483. .. rst-class:: classref-method
  484. |void| **orthonormalize**\ (\ ) :ref:`๐Ÿ”—<class_Node3D_method_orthonormalize>`
  485. 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:`Transform3D<class_Transform3D>`.
  486. .. rst-class:: classref-item-separator
  487. ----
  488. .. _class_Node3D_method_rotate:
  489. .. rst-class:: classref-method
  490. |void| **rotate**\ (\ axis\: :ref:`Vector3<class_Vector3>`, angle\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_Node3D_method_rotate>`
  491. Rotates the local transformation around axis, a unit :ref:`Vector3<class_Vector3>`, by specified angle in radians.
  492. .. rst-class:: classref-item-separator
  493. ----
  494. .. _class_Node3D_method_rotate_object_local:
  495. .. rst-class:: classref-method
  496. |void| **rotate_object_local**\ (\ axis\: :ref:`Vector3<class_Vector3>`, angle\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_Node3D_method_rotate_object_local>`
  497. 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.
  498. .. rst-class:: classref-item-separator
  499. ----
  500. .. _class_Node3D_method_rotate_x:
  501. .. rst-class:: classref-method
  502. |void| **rotate_x**\ (\ angle\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_Node3D_method_rotate_x>`
  503. Rotates the local transformation around the X axis by angle in radians.
  504. .. rst-class:: classref-item-separator
  505. ----
  506. .. _class_Node3D_method_rotate_y:
  507. .. rst-class:: classref-method
  508. |void| **rotate_y**\ (\ angle\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_Node3D_method_rotate_y>`
  509. Rotates the local transformation around the Y axis by angle in radians.
  510. .. rst-class:: classref-item-separator
  511. ----
  512. .. _class_Node3D_method_rotate_z:
  513. .. rst-class:: classref-method
  514. |void| **rotate_z**\ (\ angle\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_Node3D_method_rotate_z>`
  515. Rotates the local transformation around the Z axis by angle in radians.
  516. .. rst-class:: classref-item-separator
  517. ----
  518. .. _class_Node3D_method_scale_object_local:
  519. .. rst-class:: classref-method
  520. |void| **scale_object_local**\ (\ scale\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_Node3D_method_scale_object_local>`
  521. Scales the local transformation by given 3D scale factors in object-local coordinate system.
  522. .. rst-class:: classref-item-separator
  523. ----
  524. .. _class_Node3D_method_set_disable_scale:
  525. .. rst-class:: classref-method
  526. |void| **set_disable_scale**\ (\ disable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_Node3D_method_set_disable_scale>`
  527. Sets whether the node uses a scale of ``(1, 1, 1)`` or its local transformation scale. Changes to the local transformation scale are preserved.
  528. .. rst-class:: classref-item-separator
  529. ----
  530. .. _class_Node3D_method_set_identity:
  531. .. rst-class:: classref-method
  532. |void| **set_identity**\ (\ ) :ref:`๐Ÿ”—<class_Node3D_method_set_identity>`
  533. Reset all transformations for this node (sets its :ref:`Transform3D<class_Transform3D>` to the identity matrix).
  534. .. rst-class:: classref-item-separator
  535. ----
  536. .. _class_Node3D_method_set_ignore_transform_notification:
  537. .. rst-class:: classref-method
  538. |void| **set_ignore_transform_notification**\ (\ enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_Node3D_method_set_ignore_transform_notification>`
  539. Sets whether the node ignores notification that its transformation (global or local) changed.
  540. .. rst-class:: classref-item-separator
  541. ----
  542. .. _class_Node3D_method_set_notify_local_transform:
  543. .. rst-class:: classref-method
  544. |void| **set_notify_local_transform**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_Node3D_method_set_notify_local_transform>`
  545. Sets whether the node notifies about its local transformation changes. **Node3D** will not propagate this by default.
  546. .. rst-class:: classref-item-separator
  547. ----
  548. .. _class_Node3D_method_set_notify_transform:
  549. .. rst-class:: classref-method
  550. |void| **set_notify_transform**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_Node3D_method_set_notify_transform>`
  551. Sets whether the node notifies about its global and local transformation changes. **Node3D** will not propagate this by default, unless it is in the editor context and it has a valid gizmo.
  552. .. rst-class:: classref-item-separator
  553. ----
  554. .. _class_Node3D_method_set_subgizmo_selection:
  555. .. rst-class:: classref-method
  556. |void| **set_subgizmo_selection**\ (\ gizmo\: :ref:`Node3DGizmo<class_Node3DGizmo>`, id\: :ref:`int<class_int>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`๐Ÿ”—<class_Node3D_method_set_subgizmo_selection>`
  557. Set subgizmo selection for this node in the editor.
  558. \ **Note:** The gizmo object would typically be an instance of :ref:`EditorNode3DGizmo<class_EditorNode3DGizmo>`, but the argument type is kept generic to avoid creating a dependency on editor classes in **Node3D**.
  559. .. rst-class:: classref-item-separator
  560. ----
  561. .. _class_Node3D_method_show:
  562. .. rst-class:: classref-method
  563. |void| **show**\ (\ ) :ref:`๐Ÿ”—<class_Node3D_method_show>`
  564. Enables rendering of this node. Changes :ref:`visible<class_Node3D_property_visible>` to ``true``.
  565. .. rst-class:: classref-item-separator
  566. ----
  567. .. _class_Node3D_method_to_global:
  568. .. rst-class:: classref-method
  569. :ref:`Vector3<class_Vector3>` **to_global**\ (\ local_point\: :ref:`Vector3<class_Vector3>`\ ) |const| :ref:`๐Ÿ”—<class_Node3D_method_to_global>`
  570. Transforms ``local_point`` from this node's local space to world space.
  571. .. rst-class:: classref-item-separator
  572. ----
  573. .. _class_Node3D_method_to_local:
  574. .. rst-class:: classref-method
  575. :ref:`Vector3<class_Vector3>` **to_local**\ (\ global_point\: :ref:`Vector3<class_Vector3>`\ ) |const| :ref:`๐Ÿ”—<class_Node3D_method_to_local>`
  576. Transforms ``global_point`` from world space to this node's local space.
  577. .. rst-class:: classref-item-separator
  578. ----
  579. .. _class_Node3D_method_translate:
  580. .. rst-class:: classref-method
  581. |void| **translate**\ (\ offset\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_Node3D_method_translate>`
  582. Changes the node's position by the given offset :ref:`Vector3<class_Vector3>`.
  583. 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.
  584. .. rst-class:: classref-item-separator
  585. ----
  586. .. _class_Node3D_method_translate_object_local:
  587. .. rst-class:: classref-method
  588. |void| **translate_object_local**\ (\ offset\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_Node3D_method_translate_object_local>`
  589. Changes the node's position by the given offset :ref:`Vector3<class_Vector3>` in local space.
  590. .. rst-class:: classref-item-separator
  591. ----
  592. .. _class_Node3D_method_update_gizmos:
  593. .. rst-class:: classref-method
  594. |void| **update_gizmos**\ (\ ) :ref:`๐Ÿ”—<class_Node3D_method_update_gizmos>`
  595. Updates all the **Node3D** gizmos attached to this node.
  596. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  597. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  598. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  599. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  600. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  601. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  602. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  603. .. |void| replace:: :abbr:`void (No return value.)`