class_gltfnode.rst 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236
  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/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFNode.xml.
  6. .. _class_GLTFNode:
  7. GLTFNode
  8. ========
  9. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Properties
  11. ----------
  12. +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
  13. | :ref:`int<class_int>` | :ref:`camera<class_GLTFNode_property_camera>` | ``-1`` |
  14. +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
  15. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`children<class_GLTFNode_property_children>` | ``PackedInt32Array()`` |
  16. +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
  17. | :ref:`int<class_int>` | :ref:`height<class_GLTFNode_property_height>` | ``-1`` |
  18. +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
  19. | :ref:`bool<class_bool>` | :ref:`joint<class_GLTFNode_property_joint>` | ``false`` |
  20. +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
  21. | :ref:`int<class_int>` | :ref:`light<class_GLTFNode_property_light>` | ``-1`` |
  22. +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
  23. | :ref:`int<class_int>` | :ref:`mesh<class_GLTFNode_property_mesh>` | ``-1`` |
  24. +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
  25. | :ref:`int<class_int>` | :ref:`parent<class_GLTFNode_property_parent>` | ``-1`` |
  26. +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
  27. | :ref:`Vector3<class_Vector3>` | :ref:`position<class_GLTFNode_property_position>` | ``Vector3(0, 0, 0)`` |
  28. +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
  29. | :ref:`Quaternion<class_Quaternion>` | :ref:`rotation<class_GLTFNode_property_rotation>` | ``Quaternion(0, 0, 0, 1)`` |
  30. +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
  31. | :ref:`Vector3<class_Vector3>` | :ref:`scale<class_GLTFNode_property_scale>` | ``Vector3(1, 1, 1)`` |
  32. +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
  33. | :ref:`int<class_int>` | :ref:`skeleton<class_GLTFNode_property_skeleton>` | ``-1`` |
  34. +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
  35. | :ref:`int<class_int>` | :ref:`skin<class_GLTFNode_property_skin>` | ``-1`` |
  36. +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
  37. | :ref:`Transform3D<class_Transform3D>` | :ref:`xform<class_GLTFNode_property_xform>` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` |
  38. +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+
  39. Property Descriptions
  40. ---------------------
  41. .. _class_GLTFNode_property_camera:
  42. - :ref:`int<class_int>` **camera**
  43. +-----------+-------------------+
  44. | *Default* | ``-1`` |
  45. +-----------+-------------------+
  46. | *Setter* | set_camera(value) |
  47. +-----------+-------------------+
  48. | *Getter* | get_camera() |
  49. +-----------+-------------------+
  50. ----
  51. .. _class_GLTFNode_property_children:
  52. - :ref:`PackedInt32Array<class_PackedInt32Array>` **children**
  53. +-----------+------------------------+
  54. | *Default* | ``PackedInt32Array()`` |
  55. +-----------+------------------------+
  56. | *Setter* | set_children(value) |
  57. +-----------+------------------------+
  58. | *Getter* | get_children() |
  59. +-----------+------------------------+
  60. ----
  61. .. _class_GLTFNode_property_height:
  62. - :ref:`int<class_int>` **height**
  63. +-----------+-------------------+
  64. | *Default* | ``-1`` |
  65. +-----------+-------------------+
  66. | *Setter* | set_height(value) |
  67. +-----------+-------------------+
  68. | *Getter* | get_height() |
  69. +-----------+-------------------+
  70. ----
  71. .. _class_GLTFNode_property_joint:
  72. - :ref:`bool<class_bool>` **joint**
  73. +-----------+------------------+
  74. | *Default* | ``false`` |
  75. +-----------+------------------+
  76. | *Setter* | set_joint(value) |
  77. +-----------+------------------+
  78. | *Getter* | get_joint() |
  79. +-----------+------------------+
  80. ----
  81. .. _class_GLTFNode_property_light:
  82. - :ref:`int<class_int>` **light**
  83. +-----------+------------------+
  84. | *Default* | ``-1`` |
  85. +-----------+------------------+
  86. | *Setter* | set_light(value) |
  87. +-----------+------------------+
  88. | *Getter* | get_light() |
  89. +-----------+------------------+
  90. ----
  91. .. _class_GLTFNode_property_mesh:
  92. - :ref:`int<class_int>` **mesh**
  93. +-----------+-----------------+
  94. | *Default* | ``-1`` |
  95. +-----------+-----------------+
  96. | *Setter* | set_mesh(value) |
  97. +-----------+-----------------+
  98. | *Getter* | get_mesh() |
  99. +-----------+-----------------+
  100. ----
  101. .. _class_GLTFNode_property_parent:
  102. - :ref:`int<class_int>` **parent**
  103. +-----------+-------------------+
  104. | *Default* | ``-1`` |
  105. +-----------+-------------------+
  106. | *Setter* | set_parent(value) |
  107. +-----------+-------------------+
  108. | *Getter* | get_parent() |
  109. +-----------+-------------------+
  110. ----
  111. .. _class_GLTFNode_property_position:
  112. - :ref:`Vector3<class_Vector3>` **position**
  113. +-----------+----------------------+
  114. | *Default* | ``Vector3(0, 0, 0)`` |
  115. +-----------+----------------------+
  116. | *Setter* | set_position(value) |
  117. +-----------+----------------------+
  118. | *Getter* | get_position() |
  119. +-----------+----------------------+
  120. ----
  121. .. _class_GLTFNode_property_rotation:
  122. - :ref:`Quaternion<class_Quaternion>` **rotation**
  123. +-----------+----------------------------+
  124. | *Default* | ``Quaternion(0, 0, 0, 1)`` |
  125. +-----------+----------------------------+
  126. | *Setter* | set_rotation(value) |
  127. +-----------+----------------------------+
  128. | *Getter* | get_rotation() |
  129. +-----------+----------------------------+
  130. ----
  131. .. _class_GLTFNode_property_scale:
  132. - :ref:`Vector3<class_Vector3>` **scale**
  133. +-----------+----------------------+
  134. | *Default* | ``Vector3(1, 1, 1)`` |
  135. +-----------+----------------------+
  136. | *Setter* | set_scale(value) |
  137. +-----------+----------------------+
  138. | *Getter* | get_scale() |
  139. +-----------+----------------------+
  140. ----
  141. .. _class_GLTFNode_property_skeleton:
  142. - :ref:`int<class_int>` **skeleton**
  143. +-----------+---------------------+
  144. | *Default* | ``-1`` |
  145. +-----------+---------------------+
  146. | *Setter* | set_skeleton(value) |
  147. +-----------+---------------------+
  148. | *Getter* | get_skeleton() |
  149. +-----------+---------------------+
  150. ----
  151. .. _class_GLTFNode_property_skin:
  152. - :ref:`int<class_int>` **skin**
  153. +-----------+-----------------+
  154. | *Default* | ``-1`` |
  155. +-----------+-----------------+
  156. | *Setter* | set_skin(value) |
  157. +-----------+-----------------+
  158. | *Getter* | get_skin() |
  159. +-----------+-----------------+
  160. ----
  161. .. _class_GLTFNode_property_xform:
  162. - :ref:`Transform3D<class_Transform3D>` **xform**
  163. +-----------+-----------------------------------------------------+
  164. | *Default* | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` |
  165. +-----------+-----------------------------------------------------+
  166. | *Setter* | set_xform(value) |
  167. +-----------+-----------------------------------------------------+
  168. | *Getter* | get_xform() |
  169. +-----------+-----------------------------------------------------+
  170. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  171. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  172. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  173. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  174. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  175. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`