343 lines
15 KiB
XML
343 lines
15 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Node3D" inherits="Node" version="4.0">
|
|
<brief_description>
|
|
Most basic 3D game object, parent of all 3D-related nodes.
|
|
</brief_description>
|
|
<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.
|
|
[b]Note:[/b] Unless otherwise specified, all methods that have angle parameters must have angles specified as [i]radians[/i]. To convert degrees to radians, use [method @GlobalScope.deg2rad].
|
|
</description>
|
|
<tutorials>
|
|
<link title="Introduction to 3D">https://docs.godotengine.org/en/latest/tutorials/3d/introduction_to_3d.html</link>
|
|
<link title="All 3D Demos">https://github.com/godotengine/godot-demo-projects/tree/master/3d</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="force_update_transform">
|
|
<return type="void">
|
|
</return>
|
|
<description>
|
|
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.
|
|
</description>
|
|
</method>
|
|
<method name="get_parent_node_3d" qualifiers="const">
|
|
<return type="Node3D">
|
|
</return>
|
|
<description>
|
|
Returns the parent [Node3D], or an empty [Object] if no parent exists or parent is not of type [Node3D].
|
|
</description>
|
|
</method>
|
|
<method name="get_world_3d" qualifiers="const">
|
|
<return type="World3D">
|
|
</return>
|
|
<description>
|
|
Returns the current [World3D] resource this [Node3D] node is registered to.
|
|
</description>
|
|
</method>
|
|
<method name="global_rotate">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="axis" type="Vector3">
|
|
</argument>
|
|
<argument index="1" name="angle" type="float">
|
|
</argument>
|
|
<description>
|
|
Rotates the global (world) transformation around axis, a unit [Vector3], by specified angle in radians. The rotation axis is in global coordinate system.
|
|
</description>
|
|
</method>
|
|
<method name="global_scale">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="scale" type="Vector3">
|
|
</argument>
|
|
<description>
|
|
Scales the global (world) transformation by the given [Vector3] scale factors.
|
|
</description>
|
|
</method>
|
|
<method name="global_translate">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="offset" type="Vector3">
|
|
</argument>
|
|
<description>
|
|
Moves the global (world) transformation by [Vector3] offset. The offset is in global coordinate system.
|
|
</description>
|
|
</method>
|
|
<method name="hide">
|
|
<return type="void">
|
|
</return>
|
|
<description>
|
|
Disables rendering of this node. Changes [member visible] to [code]false[/code].
|
|
</description>
|
|
</method>
|
|
<method name="is_local_transform_notification_enabled" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<description>
|
|
Returns whether node notifies about its local transformation changes. [Node3D] will not propagate this by default.
|
|
</description>
|
|
</method>
|
|
<method name="is_scale_disabled" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<description>
|
|
Returns whether this node uses a scale of [code](1, 1, 1)[/code] or its local transformation scale.
|
|
</description>
|
|
</method>
|
|
<method name="is_transform_notification_enabled" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<description>
|
|
Returns whether the node notifies about its global and local transformation changes. [Node3D] will not propagate this by default.
|
|
</description>
|
|
</method>
|
|
<method name="is_visible_in_tree" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<description>
|
|
Returns [code]true[/code] if the node is present in the [SceneTree], its [member visible] property is [code]true[/code] and all its antecedents are also visible. If any antecedent is hidden, this node will not be visible in the scene tree.
|
|
</description>
|
|
</method>
|
|
<method name="look_at">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="target" type="Vector3">
|
|
</argument>
|
|
<argument index="1" name="up" type="Vector3" default="Vector3( 0, 1, 0 )">
|
|
</argument>
|
|
<description>
|
|
Rotates itself so that the local -Z axis points towards the [code]target[/code] position.
|
|
The transform will first be rotated around the given [code]up[/code] vector, and then fully aligned to the target by a further rotation around an axis perpendicular to both the [code]target[/code] and [code]up[/code] vectors.
|
|
Operations take place in global space.
|
|
</description>
|
|
</method>
|
|
<method name="look_at_from_position">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="position" type="Vector3">
|
|
</argument>
|
|
<argument index="1" name="target" type="Vector3">
|
|
</argument>
|
|
<argument index="2" name="up" type="Vector3" default="Vector3( 0, 1, 0 )">
|
|
</argument>
|
|
<description>
|
|
Moves the node to the specified [code]position[/code], and then rotates itself to point toward the [code]target[/code] as per [method look_at]. Operations take place in global space.
|
|
</description>
|
|
</method>
|
|
<method name="orthonormalize">
|
|
<return type="void">
|
|
</return>
|
|
<description>
|
|
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].
|
|
</description>
|
|
</method>
|
|
<method name="rotate">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="axis" type="Vector3">
|
|
</argument>
|
|
<argument index="1" name="angle" type="float">
|
|
</argument>
|
|
<description>
|
|
Rotates the local transformation around axis, a unit [Vector3], by specified angle in radians.
|
|
</description>
|
|
</method>
|
|
<method name="rotate_object_local">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="axis" type="Vector3">
|
|
</argument>
|
|
<argument index="1" name="angle" type="float">
|
|
</argument>
|
|
<description>
|
|
Rotates the local transformation around axis, a unit [Vector3], by specified angle in radians. The rotation axis is in object-local coordinate system.
|
|
</description>
|
|
</method>
|
|
<method name="rotate_x">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="angle" type="float">
|
|
</argument>
|
|
<description>
|
|
Rotates the local transformation around the X axis by angle in radians.
|
|
</description>
|
|
</method>
|
|
<method name="rotate_y">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="angle" type="float">
|
|
</argument>
|
|
<description>
|
|
Rotates the local transformation around the Y axis by angle in radians.
|
|
</description>
|
|
</method>
|
|
<method name="rotate_z">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="angle" type="float">
|
|
</argument>
|
|
<description>
|
|
Rotates the local transformation around the Z axis by angle in radians.
|
|
</description>
|
|
</method>
|
|
<method name="scale_object_local">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="scale" type="Vector3">
|
|
</argument>
|
|
<description>
|
|
Scales the local transformation by given 3D scale factors in object-local coordinate system.
|
|
</description>
|
|
</method>
|
|
<method name="set_disable_scale">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="disable" type="bool">
|
|
</argument>
|
|
<description>
|
|
Sets whether the node uses a scale of [code](1, 1, 1)[/code] or its local transformation scale. Changes to the local transformation scale are preserved.
|
|
</description>
|
|
</method>
|
|
<method name="set_identity">
|
|
<return type="void">
|
|
</return>
|
|
<description>
|
|
Reset all transformations for this node (sets its [Transform3D] to the identity matrix).
|
|
</description>
|
|
</method>
|
|
<method name="set_ignore_transform_notification">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="enabled" type="bool">
|
|
</argument>
|
|
<description>
|
|
Sets whether the node ignores notification that its transformation (global or local) changed.
|
|
</description>
|
|
</method>
|
|
<method name="set_notify_local_transform">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="enable" type="bool">
|
|
</argument>
|
|
<description>
|
|
Sets whether the node notifies about its local transformation changes. [Node3D] will not propagate this by default.
|
|
</description>
|
|
</method>
|
|
<method name="set_notify_transform">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="enable" type="bool">
|
|
</argument>
|
|
<description>
|
|
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.
|
|
</description>
|
|
</method>
|
|
<method name="show">
|
|
<return type="void">
|
|
</return>
|
|
<description>
|
|
Enables rendering of this node. Changes [member visible] to [code]true[/code].
|
|
</description>
|
|
</method>
|
|
<method name="to_global" qualifiers="const">
|
|
<return type="Vector3">
|
|
</return>
|
|
<argument index="0" name="local_point" type="Vector3">
|
|
</argument>
|
|
<description>
|
|
Transforms [code]local_point[/code] from this node's local space to world space.
|
|
</description>
|
|
</method>
|
|
<method name="to_local" qualifiers="const">
|
|
<return type="Vector3">
|
|
</return>
|
|
<argument index="0" name="global_point" type="Vector3">
|
|
</argument>
|
|
<description>
|
|
Transforms [code]global_point[/code] from world space to this node's local space.
|
|
</description>
|
|
</method>
|
|
<method name="translate">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="offset" type="Vector3">
|
|
</argument>
|
|
<description>
|
|
Changes the node's position by the given offset [Vector3].
|
|
Note that the translation [code]offset[/code] is affected by the node's scale, so if scaled by e.g. [code](10, 1, 1)[/code], a translation by an offset of [code](2, 0, 0)[/code] would actually add 20 ([code]2 * 10[/code]) to the X coordinate.
|
|
</description>
|
|
</method>
|
|
<method name="translate_object_local">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="offset" type="Vector3">
|
|
</argument>
|
|
<description>
|
|
Changes the node's position by the given offset [Vector3] in local space.
|
|
</description>
|
|
</method>
|
|
<method name="update_gizmo">
|
|
<return type="void">
|
|
</return>
|
|
<description>
|
|
Updates the [Node3DGizmo] of this node.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="gizmo" type="Node3DGizmo" setter="set_gizmo" getter="get_gizmo">
|
|
The [Node3DGizmo] for this node. Used for example in [EditorNode3DGizmo] as custom visualization and editing handles in Editor.
|
|
</member>
|
|
<member name="global_transform" type="Transform3D" setter="set_global_transform" getter="get_global_transform">
|
|
World3D space (global) [Transform3D] of this node.
|
|
</member>
|
|
<member name="position" type="Vector3" setter="set_position" getter="get_position" default="Vector3( 0, 0, 0 )">
|
|
Local position or translation of this node relative to the parent. This is equivalent to [code]transform.origin[/code].
|
|
</member>
|
|
<member name="rotation" type="Vector3" setter="set_rotation" getter="get_rotation">
|
|
Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).
|
|
[b]Note:[/b] 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.
|
|
</member>
|
|
<member name="rotation_degrees" type="Vector3" setter="set_rotation_degrees" getter="get_rotation_degrees" default="Vector3( 0, 0, 0 )">
|
|
Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).
|
|
</member>
|
|
<member name="scale" type="Vector3" setter="set_scale" getter="get_scale" default="Vector3( 1, 1, 1 )">
|
|
Scale part of the local transformation.
|
|
</member>
|
|
<member name="top_level" type="bool" setter="set_as_top_level" getter="is_set_as_top_level" default="false">
|
|
If [code]true[/code], the node will not inherit its transformations from its parent. Node transformations are only in global space.
|
|
</member>
|
|
<member name="transform" type="Transform3D" setter="set_transform" getter="get_transform" default="Transform3D( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
|
|
Local space [Transform3D] of this node, with respect to the parent node.
|
|
</member>
|
|
<member name="visibility_parent" type="NodePath" setter="set_visibility_parent" getter="get_visibility_parent" default="NodePath("")">
|
|
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 [member GeometryInstance3D.visibility_range_begin]. Nodes hidden via the [member Node3D.visible] property are essentially removed from the visibility dependency tree, so dependant instances will not take the hidden node or its ancestors into account.
|
|
</member>
|
|
<member name="visible" type="bool" setter="set_visible" getter="is_visible" default="true">
|
|
If [code]true[/code], this node is drawn. The node is only visible if all of its antecedents are visible as well (in other words, [method is_visible_in_tree] must return [code]true[/code]).
|
|
</member>
|
|
</members>
|
|
<signals>
|
|
<signal name="visibility_changed">
|
|
<description>
|
|
Emitted when node visibility changes.
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
<constants>
|
|
<constant name="NOTIFICATION_TRANSFORM_CHANGED" value="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 [constant NOTIFICATION_TRANSFORM_CHANGED] to work, users first need to ask for it, with [method set_notify_transform]. The notification is also sent if the node is in the editor context and it has a valid gizmo.
|
|
</constant>
|
|
<constant name="NOTIFICATION_ENTER_WORLD" value="41">
|
|
Node3D nodes receives this notification when they are registered to new [World3D] resource.
|
|
</constant>
|
|
<constant name="NOTIFICATION_EXIT_WORLD" value="42">
|
|
Node3D nodes receives this notification when they are unregistered from current [World3D] resource.
|
|
</constant>
|
|
<constant name="NOTIFICATION_VISIBILITY_CHANGED" value="43">
|
|
Node3D nodes receives this notification when their visibility changes.
|
|
</constant>
|
|
</constants>
|
|
</class>
|