class_gltfnode.rst 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFNode.xml.
  6. .. _class_GLTFNode:
  7. GLTFNode
  8. ========
  9. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. .. rst-class:: classref-introduction-group
  11. Description
  12. -----------
  13. **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.
  14. .. rst-class:: classref-reftable-group
  15. Properties
  16. ----------
  17. .. table::
  18. :widths: auto
  19. +-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
  20. | :ref:`int<class_int>` | :ref:`camera<class_GLTFNode_property_camera>` | ``-1`` |
  21. +-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
  22. | :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`children<class_GLTFNode_property_children>` | ``PoolIntArray( )`` |
  23. +-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
  24. | :ref:`int<class_int>` | :ref:`height<class_GLTFNode_property_height>` | ``-1`` |
  25. +-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
  26. | :ref:`bool<class_bool>` | :ref:`joint<class_GLTFNode_property_joint>` | ``false`` |
  27. +-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
  28. | :ref:`int<class_int>` | :ref:`light<class_GLTFNode_property_light>` | ``-1`` |
  29. +-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
  30. | :ref:`int<class_int>` | :ref:`mesh<class_GLTFNode_property_mesh>` | ``-1`` |
  31. +-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
  32. | :ref:`int<class_int>` | :ref:`parent<class_GLTFNode_property_parent>` | ``-1`` |
  33. +-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
  34. | :ref:`Quat<class_Quat>` | :ref:`rotation<class_GLTFNode_property_rotation>` | ``Quat( 0, 0, 0, 1 )`` |
  35. +-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
  36. | :ref:`Vector3<class_Vector3>` | :ref:`scale<class_GLTFNode_property_scale>` | ``Vector3( 1, 1, 1 )`` |
  37. +-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
  38. | :ref:`int<class_int>` | :ref:`skeleton<class_GLTFNode_property_skeleton>` | ``-1`` |
  39. +-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
  40. | :ref:`int<class_int>` | :ref:`skin<class_GLTFNode_property_skin>` | ``-1`` |
  41. +-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
  42. | :ref:`Vector3<class_Vector3>` | :ref:`translation<class_GLTFNode_property_translation>` | ``Vector3( 0, 0, 0 )`` |
  43. +-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
  44. | :ref:`Transform<class_Transform>` | :ref:`xform<class_GLTFNode_property_xform>` | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` |
  45. +-----------------------------------------+---------------------------------------------------------+-----------------------------------------------------+
  46. .. rst-class:: classref-section-separator
  47. ----
  48. .. rst-class:: classref-descriptions-group
  49. Property Descriptions
  50. ---------------------
  51. .. _class_GLTFNode_property_camera:
  52. .. rst-class:: classref-property
  53. :ref:`int<class_int>` **camera** = ``-1``
  54. .. rst-class:: classref-property-setget
  55. - void **set_camera** **(** :ref:`int<class_int>` value **)**
  56. - :ref:`int<class_int>` **get_camera** **(** **)**
  57. .. container:: contribute
  58. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  59. .. rst-class:: classref-item-separator
  60. ----
  61. .. _class_GLTFNode_property_children:
  62. .. rst-class:: classref-property
  63. :ref:`PoolIntArray<class_PoolIntArray>` **children** = ``PoolIntArray( )``
  64. .. rst-class:: classref-property-setget
  65. - void **set_children** **(** :ref:`PoolIntArray<class_PoolIntArray>` value **)**
  66. - :ref:`PoolIntArray<class_PoolIntArray>` **get_children** **(** **)**
  67. .. container:: contribute
  68. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  69. .. rst-class:: classref-item-separator
  70. ----
  71. .. _class_GLTFNode_property_height:
  72. .. rst-class:: classref-property
  73. :ref:`int<class_int>` **height** = ``-1``
  74. .. rst-class:: classref-property-setget
  75. - void **set_height** **(** :ref:`int<class_int>` value **)**
  76. - :ref:`int<class_int>` **get_height** **(** **)**
  77. .. container:: contribute
  78. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  79. .. rst-class:: classref-item-separator
  80. ----
  81. .. _class_GLTFNode_property_joint:
  82. .. rst-class:: classref-property
  83. :ref:`bool<class_bool>` **joint** = ``false``
  84. .. rst-class:: classref-property-setget
  85. - void **set_joint** **(** :ref:`bool<class_bool>` value **)**
  86. - :ref:`bool<class_bool>` **get_joint** **(** **)**
  87. .. container:: contribute
  88. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  89. .. rst-class:: classref-item-separator
  90. ----
  91. .. _class_GLTFNode_property_light:
  92. .. rst-class:: classref-property
  93. :ref:`int<class_int>` **light** = ``-1``
  94. .. rst-class:: classref-property-setget
  95. - void **set_light** **(** :ref:`int<class_int>` value **)**
  96. - :ref:`int<class_int>` **get_light** **(** **)**
  97. .. container:: contribute
  98. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  99. .. rst-class:: classref-item-separator
  100. ----
  101. .. _class_GLTFNode_property_mesh:
  102. .. rst-class:: classref-property
  103. :ref:`int<class_int>` **mesh** = ``-1``
  104. .. rst-class:: classref-property-setget
  105. - void **set_mesh** **(** :ref:`int<class_int>` value **)**
  106. - :ref:`int<class_int>` **get_mesh** **(** **)**
  107. .. container:: contribute
  108. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  109. .. rst-class:: classref-item-separator
  110. ----
  111. .. _class_GLTFNode_property_parent:
  112. .. rst-class:: classref-property
  113. :ref:`int<class_int>` **parent** = ``-1``
  114. .. rst-class:: classref-property-setget
  115. - void **set_parent** **(** :ref:`int<class_int>` value **)**
  116. - :ref:`int<class_int>` **get_parent** **(** **)**
  117. .. container:: contribute
  118. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  119. .. rst-class:: classref-item-separator
  120. ----
  121. .. _class_GLTFNode_property_rotation:
  122. .. rst-class:: classref-property
  123. :ref:`Quat<class_Quat>` **rotation** = ``Quat( 0, 0, 0, 1 )``
  124. .. rst-class:: classref-property-setget
  125. - void **set_rotation** **(** :ref:`Quat<class_Quat>` value **)**
  126. - :ref:`Quat<class_Quat>` **get_rotation** **(** **)**
  127. .. container:: contribute
  128. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  129. .. rst-class:: classref-item-separator
  130. ----
  131. .. _class_GLTFNode_property_scale:
  132. .. rst-class:: classref-property
  133. :ref:`Vector3<class_Vector3>` **scale** = ``Vector3( 1, 1, 1 )``
  134. .. rst-class:: classref-property-setget
  135. - void **set_scale** **(** :ref:`Vector3<class_Vector3>` value **)**
  136. - :ref:`Vector3<class_Vector3>` **get_scale** **(** **)**
  137. .. container:: contribute
  138. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  139. .. rst-class:: classref-item-separator
  140. ----
  141. .. _class_GLTFNode_property_skeleton:
  142. .. rst-class:: classref-property
  143. :ref:`int<class_int>` **skeleton** = ``-1``
  144. .. rst-class:: classref-property-setget
  145. - void **set_skeleton** **(** :ref:`int<class_int>` value **)**
  146. - :ref:`int<class_int>` **get_skeleton** **(** **)**
  147. .. container:: contribute
  148. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  149. .. rst-class:: classref-item-separator
  150. ----
  151. .. _class_GLTFNode_property_skin:
  152. .. rst-class:: classref-property
  153. :ref:`int<class_int>` **skin** = ``-1``
  154. .. rst-class:: classref-property-setget
  155. - void **set_skin** **(** :ref:`int<class_int>` value **)**
  156. - :ref:`int<class_int>` **get_skin** **(** **)**
  157. .. container:: contribute
  158. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  159. .. rst-class:: classref-item-separator
  160. ----
  161. .. _class_GLTFNode_property_translation:
  162. .. rst-class:: classref-property
  163. :ref:`Vector3<class_Vector3>` **translation** = ``Vector3( 0, 0, 0 )``
  164. .. rst-class:: classref-property-setget
  165. - void **set_translation** **(** :ref:`Vector3<class_Vector3>` value **)**
  166. - :ref:`Vector3<class_Vector3>` **get_translation** **(** **)**
  167. .. container:: contribute
  168. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  169. .. rst-class:: classref-item-separator
  170. ----
  171. .. _class_GLTFNode_property_xform:
  172. .. rst-class:: classref-property
  173. :ref:`Transform<class_Transform>` **xform** = ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )``
  174. .. rst-class:: classref-property-setget
  175. - void **set_xform** **(** :ref:`Transform<class_Transform>` value **)**
  176. - :ref:`Transform<class_Transform>` **get_xform** **(** **)**
  177. .. container:: contribute
  178. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  179. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  180. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  181. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  182. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`