class_gltfnode.rst 9.3 KB

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