Spatial

####Inherits: Node ####Category: Core

Brief Description

Base class for all 3D nodes.

Member Functions

• void set_transform ( Transform local )
• Transform get_transform ( ) const
• void set_translation ( Vector3 translation )
• Vector3 get_translation ( ) const
• void set_rotation ( Vector3 rotation )
• Vector3 get_rotation ( ) const
• void set_scale ( Vector3 scale )
• Vector3 get_scale ( ) const
• void set_global_transform ( Transform global )
• Transform get_global_transform ( ) const
• Object get_parent_spatial ( ) const
• void set_ignore_transform_notification ( bool enabled )
• void set_as_toplevel ( bool enable )
• bool is_set_as_toplevel ( ) const
• World get_world ( ) const
• void update_gizmo ( )
• void set_gizmo ( SpatialGizmo gizmo )
• SpatialGizmo get_gizmo ( ) const
• void show ( )
• void hide ( )
• bool is_visible ( ) const
• bool is_hidden ( ) const

Signals

• visibility_changed ( )

Numeric Constants

• NOTIFICATION_TRANSFORM_CHANGED = 29 - Spatial nodes receive this notifacation with their global transform changes. This means that either the current or a parent node changed it's transform.
• NOTIFICATION_ENTER_WORLD = 41
• NOTIFICATION_EXIT_WORLD = 42
• NOTIFICATION_VISIBILITY_CHANGED = 43

Description

Spatial is the base for every type of 3D Node. It contains a 3D Transform which can be set or get as local or global. If a Spatial Node has Spatial children, their transforms will be relative to the parent.

Member Function Description

set_transform

• void set_transform ( Transform local )

Set the transform locally, relative to the parent spatial node.

get_transform

• Transform get_transform ( ) const

Return the local transform, relative to the bone parent.

set_global_transform

• void set_global_transform ( Transform global )

Set the transform globally, relative to worldspace.

get_global_transform

• Transform get_global_transform ( ) const

Return the gloal transform, relative to worldspace.

get_parent_spatial

• Object get_parent_spatial ( ) const

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