Node3D

Inherits: Node < Object

Inherited By: AudioListener3D, AudioStreamPlayer3D, BoneAttachment3D, Camera3D, CollisionObject3D, CollisionPolygon3D, CollisionShape3D, GridMap, ImporterMeshInstance3D, Joint3D, LightmapProbe, NavigationRegion3D, OccluderInstance3D, Path3D, PathFollow3D, Position3D, ProximityGroup3D, RayCast3D, RemoteTransform3D, Skeleton3D, SpringArm3D, VehicleWheel3D, VisualInstance3D, XRNode3D, XROrigin3D

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

Description

Most basic 3D game object, with a 3D 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.

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.

Note: Unless otherwise specified, all methods that have angle parameters must have angles specified as radians. To convert degrees to radians, use @GlobalScope.deg2rad.

Properties

Basis

basis

Transform3D

global_transform

Vector3

position

Vector3(0, 0, 0)

Quaternion

quaternion

Vector3

rotation

Vector3(0, 0, 0)

RotationEditMode

rotation_edit_mode

0

RotationOrder

rotation_order

2

Vector3

scale

Vector3(1, 1, 1)

bool

top_level

false

Transform3D

transform

Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)

NodePath

visibility_parent

NodePath("")

bool

visible

true

Methods

void

add_gizmo ( Node3DGizmo gizmo )

void

clear_gizmos ( )

void

clear_subgizmo_selection ( )

void

force_update_transform ( )

Array

get_gizmos ( ) const

Node3D

get_parent_node_3d ( ) const

World3D

get_world_3d ( ) 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_scale_disabled ( ) const

bool

is_transform_notification_enabled ( ) const

bool

is_visible_in_tree ( ) const

void

look_at ( Vector3 target, Vector3 up=Vector3(0, 1, 0) )

void

look_at_from_position ( Vector3 position, Vector3 target, Vector3 up=Vector3(0, 1, 0) )

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_disable_scale ( bool disable )

void

set_identity ( )

void

set_ignore_transform_notification ( bool enabled )

void

set_notify_local_transform ( bool enable )

void

set_notify_transform ( bool enable )

void

set_subgizmo_selection ( Node3DGizmo gizmo, int id, Transform3D transform )

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_gizmos ( )

Signals

  • visibility_changed ( )

Emitted when node visibility changes.

Enumerations

enum RotationEditMode:

  • ROTATION_EDIT_MODE_EULER = 0

  • ROTATION_EDIT_MODE_QUATERNION = 1

  • ROTATION_EDIT_MODE_BASIS = 2


enum RotationOrder:

  • ROTATION_ORDER_XYZ = 0

  • ROTATION_ORDER_XZY = 1

  • ROTATION_ORDER_YXZ = 2

  • ROTATION_ORDER_YZX = 3

  • ROTATION_ORDER_ZXY = 4

  • ROTATION_ORDER_ZYX = 5

Constants

  • NOTIFICATION_TRANSFORM_CHANGED = 2000 --- Node3D 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, users first need to ask for it, with set_notify_transform. The notification is also sent if the node is in the editor context and it has at least one valid gizmo.

  • NOTIFICATION_ENTER_WORLD = 41 --- Node3D nodes receives this notification when they are registered to new World3D resource.

  • NOTIFICATION_EXIT_WORLD = 42 --- Node3D nodes receives this notification when they are unregistered from current World3D resource.

  • NOTIFICATION_VISIBILITY_CHANGED = 43 --- Node3D nodes receives this notification when their visibility changes.

Property Descriptions

Setter

set_basis(value)

Getter

get_basis()

Direct access to the 3x3 basis of the Transform3D property.


Setter

set_global_transform(value)

Getter

get_global_transform()

World3D space (global) Transform3D of this node.


Default

Vector3(0, 0, 0)

Setter

set_position(value)

Getter

get_position()

Local position or translation of this node relative to the parent. This is equivalent to transform.origin.


Setter

set_quaternion(value)

Getter

get_quaternion()

Access to the node rotation as a Quaternion. This property is ideal for tweening complex rotations.


Default

Vector3(0, 0, 0)

Setter

set_rotation(value)

Getter

get_rotation()

Rotation part of the local transformation in radians, specified in terms of Euler angles. The angles construct a rotaton in the order specified by the rotation_order property.

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.


Default

0

Setter

set_rotation_edit_mode(value)

Getter

get_rotation_edit_mode()

Specify how rotation (and scale) will be presented in the editor.


Default

2

Setter

set_rotation_order(value)

Getter

get_rotation_order()

Specify the axis rotation order of the rotation property. The final orientation is constructed by rotating the Euler angles in the order specified by this property.


Default

Vector3(1, 1, 1)

Setter

set_scale(value)

Getter

get_scale()

Scale part of the local transformation.


Default

false

Setter

set_as_top_level(value)

Getter

is_set_as_top_level()

If true, the node will not inherit its transformations from its parent. Node transformations are only in global space.


Default

Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)

Setter

set_transform(value)

Getter

get_transform()

Local space Transform3D of this node, with respect to the parent node.


Default

NodePath("")

Setter

set_visibility_parent(value)

Getter

get_visibility_parent()

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 GeometryInstance3D.visibility_range_begin. Nodes hidden via the visible property are essentially removed from the visibility dependency tree, so dependent instances will not take the hidden node or its ancestors into account.


Default

true

Setter

set_visible(value)

Getter

is_visible()

If true, this node is drawn. The node is only visible if all of its antecedents are visible as well (in other words, is_visible_in_tree must return true).

Method Descriptions

Attach a gizmo to this Node3D.


  • void clear_gizmos ( )

Clear all gizmos attached to this Node3D.


  • void clear_subgizmo_selection ( )

Clears subgizmo selection for this node in the editor. Useful when subgizmo IDs become invalid after a property change.


  • void force_update_transform ( )

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.


  • Array get_gizmos ( ) const

Returns all the gizmos attached to this Node3D.


  • Node3D get_parent_node_3d ( ) const

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


Returns the current World3D resource this Node3D 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.


  • void global_scale ( Vector3 scale )

Scales the global (world) transformation by the given Vector3 scale factors.


  • void global_translate ( Vector3 offset )

Moves the global (world) transformation by Vector3 offset. The offset is in global coordinate system.


  • void hide ( )

Disables rendering of this node. Changes visible to false.


  • bool is_local_transform_notification_enabled ( ) const

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


  • bool is_scale_disabled ( ) const

Returns whether this node uses a scale of (1, 1, 1) or its local transformation scale.


  • bool is_transform_notification_enabled ( ) const

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


  • bool is_visible_in_tree ( ) const

Returns true if the node is present in the SceneTree, its visible property is true and all its antecedents are also visible. If any antecedent is hidden, this node will not be visible in the scene tree.


Rotates the node so that the local forward axis (-Z) points toward the target position.

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.

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.

Operations take place in global space.


Moves the node to the specified position, and then rotates the node to point toward the target as per look_at. Operations take place in global space.


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


  • void rotate_x ( float angle )

Rotates the local transformation around the X axis by angle in radians.


  • void rotate_y ( float angle )

Rotates the local transformation around the Y axis by angle in radians.


  • void rotate_z ( float angle )

Rotates the local transformation around the Z axis by angle in radians.


  • void scale_object_local ( Vector3 scale )

Scales the local transformation by given 3D scale factors in object-local coordinate system.


  • void set_disable_scale ( bool disable )

Sets whether the node uses a scale of (1, 1, 1) or its local transformation scale. Changes to the local transformation scale are preserved.


  • void set_identity ( )

Reset all transformations for this node (sets its Transform3D to the identity matrix).


  • void set_ignore_transform_notification ( bool enabled )

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


  • void set_notify_local_transform ( bool enable )

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


  • void set_notify_transform ( bool enable )

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.


Set subgizmo selection for this node in the editor.


  • void show ( )

Enables rendering of this node. Changes visible to true.


Transforms local_point from this node's local space to world space.


Transforms global_point from world space to this node's local space.


  • void translate ( Vector3 offset )

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.


  • void translate_object_local ( Vector3 offset )

Changes the node's position by the given offset Vector3 in local space.


  • void update_gizmos ( )

Updates all the Node3DGizmos attached to this node.