Struct Spatial
Most basic 3D game object, parent of all 3D-related nodes.
struct Spatial
;
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.
Properties
| Name | Type | Description |
|---|---|---|
gizmo[get, set]
|
SpatialGizmo | The SpatialGizmo for this node. Used for example in EditorSpatialGizmo as custom visualization and editing handles in Editor.
|
globalTransform[get, set]
|
Transform | World space (global) Transform of this node.
|
rotation[get, set]
|
Vector3 | 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 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.
|
rotationDegrees[get, set]
|
Vector3 | Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle). |
scale[get, set]
|
Vector3 | Scale part of the local transformation. |
transform[get, set]
|
Transform | Local space Transform of this node, with respect to the parent node.
|
translation[get, set]
|
Vector3 | Local translation of this node. |
visible[get, set]
|
bool | If true, this node is drawn.
|
Methods
| Name | Description |
|---|---|
_updateGizmo
|
|
forceUpdateTransform
|
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. |
getGizmo
|
|
getGlobalTransform
|
|
getParentSpatial
|
Returns the parent Spatial, or an empty GodotObject if no parent exists or parent is not of type Spatial.
|
getRotation
|
|
getRotationDegrees
|
|
getScale
|
|
getTransform
|
|
getTranslation
|
|
getWorld
|
Returns the current World resource this Spatial node is registered to.
|
globalRotate
|
Rotates the global (world) transformation around axis, a unit Vector3, by specified angle in radians. The rotation axis is in global coordinate system.
|
globalScale
|
Scales the global (world) transformation by the given Vector3 scale factors.
|
globalTranslate
|
Moves the global (world) transformation by Vector3 offset. The offset is in global coordinate system.
|
hide
|
Disables rendering of this node. Changes visible to false.
|
isLocalTransformNotificationEnabled
|
Returns whether node notifies about its local transformation changes. Spatial will not propagate this by default.
|
isScaleDisabled
|
Returns whether this node uses a scale of (1, 1, 1) or its local transformation scale.
|
isSetAsToplevel
|
Returns whether this node is set as Toplevel, that is whether it ignores its parent nodes transformations. |
isTransformNotificationEnabled
|
Returns whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default.
|
isVisible
|
|
isVisibleInTree
|
Returns whether the node is visible, taking into consideration that its parents visibility. |
lookAt
|
Rotates itself so that the local -Z axis points towards the target position.
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 target and up vectors.
Operations take place in global space.
|
lookAtFromPosition
|
Moves the node to the specified position, and then rotates itself to point toward the target as per lookAt. Operations take place in global space.
|
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 Transform.
|
rotate
|
Rotates the local transformation around axis, a unit Vector3, by specified angle in radians.
|
rotateObjectLocal
|
Rotates the local transformation around axis, a unit Vector3, by specified angle in radians. The rotation axis is in object-local coordinate system.
|
rotateX
|
Rotates the local transformation around the X axis by angle in radians. |
rotateY
|
Rotates the local transformation around the Y axis by angle in radians. |
rotateZ
|
Rotates the local transformation around the Z axis by angle in radians. |
scaleObjectLocal
|
Scales the local transformation by given 3D scale factors in object-local coordinate system. |
setAsToplevel
|
Makes the node ignore its parents transformations. Node transformations are only in global space. |
setDisableScale
|
Sets whether the node uses a scale of (1, 1, 1) or its local transformation scale. Changes to the local transformation scale are preserved.
|
setGizmo
|
|
setGlobalTransform
|
|
setIdentity
|
Reset all transformations for this node (sets its Transform to the identity matrix).
|
setIgnoreTransformNotification
|
Sets whether the node ignores notification that its transformation (global or local) changed. |
setNotifyLocalTransform
|
Sets whether the node notifies about its local transformation changes. Spatial will not propagate this by default.
|
setNotifyTransform
|
Sets whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default.
|
setRotation
|
|
setRotationDegrees
|
|
setScale
|
|
setTransform
|
|
setTranslation
|
|
setVisible
|
|
show
|
Enables rendering of this node. Changes visible to true.
|
toGlobal
|
Transforms local_point from this node's local space to world space.
|
toLocal
|
Transforms global_point from world space to this node's local space.
|
translate
|
Changes the node's position by the given offset 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.
|
translateObjectLocal
|
Changes the node's position by the given offset Vector3 in local space.
|
updateGizmo
|
Updates the SpatialGizmo of this node.
|
Enums
| Name | Description |
|---|---|
Constants
|