Spatial

Inherits: Node < Object

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

Category: Core

Brief Description

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

Member Functions

SpatialGizmo get_gizmo ( ) const
Spatial get_parent_spatial ( ) const
World get_world ( ) const
void global_rotate ( Vector3 normal, float radians )
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 normal, float radians )
void rotate_x ( float radians )
void rotate_y ( float radians )
void rotate_z ( float radians )
void set_as_toplevel ( bool enable )
void set_gizmo ( SpatialGizmo gizmo )
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 update_gizmo ( )

Signals

  • visibility_changed ( )

Emitted when node visibility changes.

Member Variables

  • Transform global_transform - World space (global) Transform of this node.
  • Vector3 rotation - Local euler rotation in radians of this node.
  • Vector3 rotation_degrees - Local euler rotation in degrees of this node.
  • Vector3 scale - Local scale of this node.
  • Transform transform - Local space Transform of this node.
  • Vector3 translation - Local translation of this node.
  • bool visible - Visibility of this node. Toggles if this node is rendered.

Numeric Constants

  • NOTIFICATION_TRANSFORM_CHANGED = 29 — 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 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.

Description

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.

Member Function Description

Returns the SpatialGizmo for this node. Used for example in EditorSpatialGizmo as custom visualization and editing handles in Editor.

  • Spatial get_parent_spatial ( ) const

Returns the parent Spatial, or an empty Object if no parent exists or parent is not of type Spatial.

  • World get_world ( ) const

Returns the current World resource this Spatial node is registered to.

Rotates the current node along normal Vector3 by angle in radians in Global space.

  • void global_translate ( Vector3 offset )

Moves the node by Vector3 offset in Global space.

  • void hide ( )

Disables rendering of this node. Change Spatial Visible property to false.

  • bool is_local_transform_notification_enabled ( ) const

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

  • bool is_set_as_toplevel ( ) const

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

  • 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.

  • bool is_visible_in_tree ( ) const

Returns whether the node is visible, taking into consideration that its parents visibility.

Rotates itself to point into direction of target position. Operations take place in global space.

Moves the node to specified position and then rotates itself to point into direction of target position. Operations take place in global space.

  • void orthonormalize ( )

Resets this node’s transformations (like scale, skew and taper) preserving its rotation and translation. Performs orthonormalization on this node Transform3D.

Rotates the node in local space on given normal Vector3 by angle in radians.

  • void rotate_x ( float radians )

Rotates the node in local space on X axis by angle in radians.

  • void rotate_y ( float radians )

Rotates the node in local space on Y axis by angle in radians.

  • void rotate_z ( float radians )

Rotates the node in local space on Z axis by angle in radians.

  • void set_as_toplevel ( bool enable )

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

Set SpatialGizmo for this node. Used for example in EditorSpatialGizmo as custom visualization and editing handles in Editor.

  • void set_identity ( )

Reset all transformations for this node. Set its Transform3D to identity matrix.

  • void set_ignore_transform_notification ( bool enabled )

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

  • void set_notify_local_transform ( bool enable )

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

  • void set_notify_transform ( bool enable )

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

  • void show ( )

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.

  • void translate ( Vector3 offset )

Changes the node’s position by given offset Vector3.

  • void update_gizmo ( )

Updates the SpatialGizmo of this node.