Files
godot-docs/classes/class_gltfnode.rst
2023-09-20 12:07:07 +00:00

314 lines
12 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFNode.xml.
.. _class_GLTFNode:
GLTFNode
========
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
.. rst-class:: classref-introduction-group
Description
-----------
**Note:** This class is only compiled in editor builds. Run-time glTF loading and saving is *not* available in exported projects. References to **GLTFNode** within a script will cause an error in an exported project.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
| :ref:`int<class_int>` | :ref:`camera<class_GLTFNode_property_camera>` | ``-1`` |
+-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`children<class_GLTFNode_property_children>` | ``PoolIntArray( )`` |
+-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
| :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:`Quat<class_Quat>` | :ref:`rotation<class_GLTFNode_property_rotation>` | ``Quat( 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:`Vector3<class_Vector3>` | :ref:`translation<class_GLTFNode_property_translation>` | ``Vector3( 0, 0, 0 )`` |
+-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
| :ref:`Transform<class_Transform>` | :ref:`xform<class_GLTFNode_property_xform>` | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` |
+-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_GLTFNode_property_camera:
.. rst-class:: classref-property
:ref:`int<class_int>` **camera** = ``-1``
.. rst-class:: classref-property-setget
- void **set_camera** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_camera** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFNode_property_children:
.. rst-class:: classref-property
:ref:`PoolIntArray<class_PoolIntArray>` **children** = ``PoolIntArray( )``
.. rst-class:: classref-property-setget
- void **set_children** **(** :ref:`PoolIntArray<class_PoolIntArray>` value **)**
- :ref:`PoolIntArray<class_PoolIntArray>` **get_children** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFNode_property_height:
.. rst-class:: classref-property
:ref:`int<class_int>` **height** = ``-1``
.. rst-class:: classref-property-setget
- void **set_height** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_height** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFNode_property_joint:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **joint** = ``false``
.. rst-class:: classref-property-setget
- void **set_joint** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **get_joint** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFNode_property_light:
.. rst-class:: classref-property
:ref:`int<class_int>` **light** = ``-1``
.. rst-class:: classref-property-setget
- void **set_light** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_light** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFNode_property_mesh:
.. rst-class:: classref-property
:ref:`int<class_int>` **mesh** = ``-1``
.. rst-class:: classref-property-setget
- void **set_mesh** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_mesh** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFNode_property_parent:
.. rst-class:: classref-property
:ref:`int<class_int>` **parent** = ``-1``
.. rst-class:: classref-property-setget
- void **set_parent** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_parent** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFNode_property_rotation:
.. rst-class:: classref-property
:ref:`Quat<class_Quat>` **rotation** = ``Quat( 0, 0, 0, 1 )``
.. rst-class:: classref-property-setget
- void **set_rotation** **(** :ref:`Quat<class_Quat>` value **)**
- :ref:`Quat<class_Quat>` **get_rotation** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFNode_property_scale:
.. rst-class:: classref-property
:ref:`Vector3<class_Vector3>` **scale** = ``Vector3( 1, 1, 1 )``
.. rst-class:: classref-property-setget
- void **set_scale** **(** :ref:`Vector3<class_Vector3>` value **)**
- :ref:`Vector3<class_Vector3>` **get_scale** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFNode_property_skeleton:
.. rst-class:: classref-property
:ref:`int<class_int>` **skeleton** = ``-1``
.. rst-class:: classref-property-setget
- void **set_skeleton** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_skeleton** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFNode_property_skin:
.. rst-class:: classref-property
:ref:`int<class_int>` **skin** = ``-1``
.. rst-class:: classref-property-setget
- void **set_skin** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_skin** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFNode_property_translation:
.. rst-class:: classref-property
:ref:`Vector3<class_Vector3>` **translation** = ``Vector3( 0, 0, 0 )``
.. rst-class:: classref-property-setget
- void **set_translation** **(** :ref:`Vector3<class_Vector3>` value **)**
- :ref:`Vector3<class_Vector3>` **get_translation** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFNode_property_xform:
.. rst-class:: classref-property
:ref:`Transform<class_Transform>` **xform** = ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )``
.. rst-class:: classref-property-setget
- void **set_xform** **(** :ref:`Transform<class_Transform>` value **)**
- :ref:`Transform<class_Transform>` **get_xform** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`