godot-docs/classes/class_gltfnode.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFNode.xml.

.. _class_GLTFNode:

GLTFNode
========

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

GLTF node class.

Description
-----------

Represents a GLTF node. GLTF nodes may have names, transforms, children (other GLTF nodes), and more specialized properties (represented by their own classes).

Tutorials
---------

- `GLTF scene and node spec <https://github.com/KhronosGroup/glTF-Tutorials/blob/master/gltfTutorial/gltfTutorial_004_ScenesNodes.md">`__

Properties
----------

+-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
| :ref:`int<class_int>`                           | :ref:`camera<class_GLTFNode_property_camera>`     | ``-1``                                              |
+-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`children<class_GLTFNode_property_children>` | ``PackedInt32Array()``                              |
+-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
| :ref:`int<class_int>`                           | :ref:`height<class_GLTFNode_property_height>`     | ``-1``                                              |
+-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
| :ref:`bool<class_bool>`                         | :ref:`joint<class_GLTFNode_property_joint>`       | ``false``                                           |
+-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
| :ref:`int<class_int>`                           | :ref:`light<class_GLTFNode_property_light>`       | ``-1``                                              |
+-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
| :ref:`int<class_int>`                           | :ref:`mesh<class_GLTFNode_property_mesh>`         | ``-1``                                              |
+-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
| :ref:`int<class_int>`                           | :ref:`parent<class_GLTFNode_property_parent>`     | ``-1``                                              |
+-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
| :ref:`Vector3<class_Vector3>`                   | :ref:`position<class_GLTFNode_property_position>` | ``Vector3(0, 0, 0)``                                |
+-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
| :ref:`Quaternion<class_Quaternion>`             | :ref:`rotation<class_GLTFNode_property_rotation>` | ``Quaternion(0, 0, 0, 1)``                          |
+-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
| :ref:`Vector3<class_Vector3>`                   | :ref:`scale<class_GLTFNode_property_scale>`       | ``Vector3(1, 1, 1)``                                |
+-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
| :ref:`int<class_int>`                           | :ref:`skeleton<class_GLTFNode_property_skeleton>` | ``-1``                                              |
+-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
| :ref:`int<class_int>`                           | :ref:`skin<class_GLTFNode_property_skin>`         | ``-1``                                              |
+-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
| :ref:`Transform3D<class_Transform3D>`           | :ref:`xform<class_GLTFNode_property_xform>`       | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` |
+-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+

Property Descriptions
---------------------

.. _class_GLTFNode_property_camera:

- :ref:`int<class_int>` **camera**

+-----------+-------------------+
| *Default* | ``-1``            |
+-----------+-------------------+
| *Setter*  | set_camera(value) |
+-----------+-------------------+
| *Getter*  | get_camera()      |
+-----------+-------------------+

----

.. _class_GLTFNode_property_children:

- :ref:`PackedInt32Array<class_PackedInt32Array>` **children**

+-----------+------------------------+
| *Default* | ``PackedInt32Array()`` |
+-----------+------------------------+
| *Setter*  | set_children(value)    |
+-----------+------------------------+
| *Getter*  | get_children()         |
+-----------+------------------------+

----

.. _class_GLTFNode_property_height:

- :ref:`int<class_int>` **height**

+-----------+-------------------+
| *Default* | ``-1``            |
+-----------+-------------------+
| *Setter*  | set_height(value) |
+-----------+-------------------+
| *Getter*  | get_height()      |
+-----------+-------------------+

----

.. _class_GLTFNode_property_joint:

- :ref:`bool<class_bool>` **joint**

+-----------+------------------+
| *Default* | ``false``        |
+-----------+------------------+
| *Setter*  | set_joint(value) |
+-----------+------------------+
| *Getter*  | get_joint()      |
+-----------+------------------+

----

.. _class_GLTFNode_property_light:

- :ref:`int<class_int>` **light**

+-----------+------------------+
| *Default* | ``-1``           |
+-----------+------------------+
| *Setter*  | set_light(value) |
+-----------+------------------+
| *Getter*  | get_light()      |
+-----------+------------------+

----

.. _class_GLTFNode_property_mesh:

- :ref:`int<class_int>` **mesh**

+-----------+-----------------+
| *Default* | ``-1``          |
+-----------+-----------------+
| *Setter*  | set_mesh(value) |
+-----------+-----------------+
| *Getter*  | get_mesh()      |
+-----------+-----------------+

----

.. _class_GLTFNode_property_parent:

- :ref:`int<class_int>` **parent**

+-----------+-------------------+
| *Default* | ``-1``            |
+-----------+-------------------+
| *Setter*  | set_parent(value) |
+-----------+-------------------+
| *Getter*  | get_parent()      |
+-----------+-------------------+

----

.. _class_GLTFNode_property_position:

- :ref:`Vector3<class_Vector3>` **position**

+-----------+----------------------+
| *Default* | ``Vector3(0, 0, 0)`` |
+-----------+----------------------+
| *Setter*  | set_position(value)  |
+-----------+----------------------+
| *Getter*  | get_position()       |
+-----------+----------------------+

----

.. _class_GLTFNode_property_rotation:

- :ref:`Quaternion<class_Quaternion>` **rotation**

+-----------+----------------------------+
| *Default* | ``Quaternion(0, 0, 0, 1)`` |
+-----------+----------------------------+
| *Setter*  | set_rotation(value)        |
+-----------+----------------------------+
| *Getter*  | get_rotation()             |
+-----------+----------------------------+

----

.. _class_GLTFNode_property_scale:

- :ref:`Vector3<class_Vector3>` **scale**

+-----------+----------------------+
| *Default* | ``Vector3(1, 1, 1)`` |
+-----------+----------------------+
| *Setter*  | set_scale(value)     |
+-----------+----------------------+
| *Getter*  | get_scale()          |
+-----------+----------------------+

----

.. _class_GLTFNode_property_skeleton:

- :ref:`int<class_int>` **skeleton**

+-----------+---------------------+
| *Default* | ``-1``              |
+-----------+---------------------+
| *Setter*  | set_skeleton(value) |
+-----------+---------------------+
| *Getter*  | get_skeleton()      |
+-----------+---------------------+

----

.. _class_GLTFNode_property_skin:

- :ref:`int<class_int>` **skin**

+-----------+-----------------+
| *Default* | ``-1``          |
+-----------+-----------------+
| *Setter*  | set_skin(value) |
+-----------+-----------------+
| *Getter*  | get_skin()      |
+-----------+-----------------+

----

.. _class_GLTFNode_property_xform:

- :ref:`Transform3D<class_Transform3D>` **xform**

+-----------+-----------------------------------------------------+
| *Default* | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` |
+-----------+-----------------------------------------------------+
| *Setter*  | set_xform(value)                                    |
+-----------+-----------------------------------------------------+
| *Getter*  | get_xform()                                         |
+-----------+-----------------------------------------------------+

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`