Inherited By: Joint, RayCast, Camera, BoneAttachment, CollisionShape, AudioStreamPlayer3D, ARVRController, Path, VisualInstance, VehicleWheel, Position3D, ProximityGroup, ARVRAnchor, RemoteTransform, CollisionObject, PathFollow, NavigationMeshInstance, Listener, VisibilityNotifier, Navigation, CollisionPolygon, GridMap, Skeleton, ARVROrigin
Most basic 3D game object, parent of all 3D related nodes.
|Spatial||get_parent_spatial ( ) const|
|World||get_world ( ) const|
|void||global_rotate ( Vector3 axis, float angle )|
|void||global_scale ( Vector3 scale )|
|void||global_translate ( Vector3 offset )|
|void||hide ( )|
|bool||is_local_transform_notification_enabled ( ) const|
|bool||is_set_as_toplevel ( ) const|
|bool||is_transform_notification_enabled ( ) const|
|bool||is_visible_in_tree ( ) const|
|void||look_at ( Vector3 target, Vector3 up )|
|void||look_at_from_position ( Vector3 position, Vector3 target, Vector3 up )|
|void||orthonormalize ( )|
|void||rotate ( Vector3 axis, float angle )|
|void||rotate_object_local ( Vector3 axis, float angle )|
|void||rotate_x ( float angle )|
|void||rotate_y ( float angle )|
|void||rotate_z ( float angle )|
|void||scale_object_local ( Vector3 scale )|
|void||set_as_toplevel ( bool enable )|
|void||set_identity ( )|
|void||set_ignore_transform_notification ( bool enabled )|
|void||set_notify_local_transform ( bool enable )|
|void||set_notify_transform ( bool enable )|
|void||show ( )|
|Vector3||to_global ( Vector3 local_point ) const|
|Vector3||to_local ( Vector3 global_point ) const|
|void||translate ( Vector3 offset )|
|void||translate_object_local ( Vector3 offset )|
|void||update_gizmo ( )|
Emitted when node visibility changes.
Note that in the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three indepdent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a Vector3 data structure not because the rotation is a vector, but only because Vector3 exists as a convenient data-structure to store 3 floating point numbers. Therefore, applying affine operations on the rotation “vector” is not meaningful.
In order for NOTIFICATION_TRANSFORM_CHANGED to work user first needs to ask for it, with set_notify_transform(true). - NOTIFICATION_ENTER_WORLD = 41 — Spatial nodes receives this notification when they are registered to new World resource. - NOTIFICATION_EXIT_WORLD = 42 — Spatial nodes receives this notification when they are unregistered from current World resource. - NOTIFICATION_VISIBILITY_CHANGED = 43 — Spatial nodes receives this notification when their visibility changes.
Most basic 3D game object, with a 3D 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.
Returns the parent
Spatial, or an empty Object if no parent exists or parent is not of type
Returns the current World resource this Spatial node is registered to.
Rotates the global (world) transformation around axis, a unit Vector3, by specified angle in radians. The rotation axis is in global coordinate system.
Moves the global (world) transformation by Vector3 offset. The offset is in global coordinate system.
Disables rendering of this node. Change Spatial Visible property to false.
Returns whether node notifies about its local transformation changes. Spatial will not propagate this by default.
Returns whether this node is set as Toplevel, that is whether it ignores its parent nodes transformations.
Returns whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default.
Returns whether the node is visible, taking into consideration that its parents visibility.
Rotates itself so that the local -Z axis points towards the
The transform will first be rotated around the given
up vector, and then fully aligned to the target by a further rotation around an axis perpendicular to both the
Operations take place in global space.
Moves the node to the specified
position, and then rotates itself to point toward the
target as per look_at. Operations take place in global space.
Resets this node’s transformations (like scale, skew and taper) preserving its rotation and translation by performing Gram-Schmidt orthonormalization on this node’s Transform3D.
Rotates the local transformation around axis, a unit Vector3, by specified angle in radians.
Rotates the local transformation around axis, a unit Vector3, by specified angle in radians. The rotation axis is in object-local coordinate system.
Rotates the local transformation around the X axis by angle in radians
Rotates the local transformation around the Y axis by angle in radians.
Rotates the local transformation around the Z axis by angle in radians.
Scales the local transformation by given 3D scale factors in object-local coordinate system.
Makes the node ignore its parents transformations. Node transformations are only in global space.
Reset all transformations for this node. Set its Transform3D to identity matrix.
Set whether the node ignores notification that its transformation (global or local) changed.
Set whether the node notifies about its local transformation changes. Spatial will not propagate this by default.
Set whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default.
Enables rendering of this node. Change Spatial Visible property to “True”.
Transforms Vector3 “local_point” from this node’s local space to world space.
Transforms Vector3 “global_point” from world space to this node’s local space.
Changes the node’s position by given offset Vector3.
Updates the SpatialGizmo of this node.
© 2014–2018 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.