Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: b51a272459
Branches Tags
godot-docs
/
classes
/
class_surfacetool.rst

class_surfacetool.rst 6.5 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
    3. 

  3. 

  4. .. _class_SurfaceTool:
    5. 

  5. 

  6. SurfaceTool
    7. 

  7. ===========
    8. 

  8. 

  9. **Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
    10. 

  10. 

  11. **Category:** Core
    12. 

  12. 

  13. Brief Description
    14. 

  14. -----------------
    15. 

  15. 

  16. Helper tool to create geometry.
    17. 

  17. 

  18. Member Functions
    19. 

  19. ----------------
    20. 

  20. 

  21. +--------------------------+------------------------------------------------------------------------------------------------------------+
    22. 

  22. | void                     | :ref:`begin<class_SurfaceTool_begin>`  **(** :ref:`int<class_int>` primitive  **)**                        |
    23. 

  23. +--------------------------+------------------------------------------------------------------------------------------------------------+
    24. 

  24. | void                     | :ref:`add_vertex<class_SurfaceTool_add_vertex>`  **(** :ref:`Vector3<class_vector3>` vertex  **)**         |
    25. 

  25. +--------------------------+------------------------------------------------------------------------------------------------------------+
    26. 

  26. | void                     | :ref:`add_color<class_SurfaceTool_add_color>`  **(** :ref:`Color<class_color>` color  **)**                |
    27. 

  27. +--------------------------+------------------------------------------------------------------------------------------------------------+
    28. 

  28. | void                     | :ref:`add_normal<class_SurfaceTool_add_normal>`  **(** :ref:`Vector3<class_vector3>` normal  **)**         |
    29. 

  29. +--------------------------+------------------------------------------------------------------------------------------------------------+
    30. 

  30. | void                     | :ref:`add_tangent<class_SurfaceTool_add_tangent>`  **(** :ref:`Plane<class_plane>` tangent  **)**          |
    31. 

  31. +--------------------------+------------------------------------------------------------------------------------------------------------+
    32. 

  32. | void                     | :ref:`add_uv<class_SurfaceTool_add_uv>`  **(** :ref:`Vector2<class_vector2>` uv  **)**                     |
    33. 

  33. +--------------------------+------------------------------------------------------------------------------------------------------------+
    34. 

  34. | void                     | :ref:`add_uv2<class_SurfaceTool_add_uv2>`  **(** :ref:`Vector2<class_vector2>` uv2  **)**                  |
    35. 

  35. +--------------------------+------------------------------------------------------------------------------------------------------------+
    36. 

  36. | void                     | :ref:`add_bones<class_SurfaceTool_add_bones>`  **(** :ref:`IntArray<class_intarray>` bones  **)**          |
    37. 

  37. +--------------------------+------------------------------------------------------------------------------------------------------------+
    38. 

  38. | void                     | :ref:`add_weights<class_SurfaceTool_add_weights>`  **(** :ref:`RealArray<class_realarray>` weights  **)**  |
    39. 

  39. +--------------------------+------------------------------------------------------------------------------------------------------------+
    40. 

  40. | void                     | :ref:`add_smooth_group<class_SurfaceTool_add_smooth_group>`  **(** :ref:`bool<class_bool>` smooth  **)**   |
    41. 

  41. +--------------------------+------------------------------------------------------------------------------------------------------------+
    42. 

  42. | void                     | :ref:`set_material<class_SurfaceTool_set_material>`  **(** :ref:`Material<class_material>` material  **)** |
    43. 

  43. +--------------------------+------------------------------------------------------------------------------------------------------------+
    44. 

  44. | void                     | :ref:`index<class_SurfaceTool_index>`  **(** **)**                                                         |
    45. 

  45. +--------------------------+------------------------------------------------------------------------------------------------------------+
    46. 

  46. | void                     | :ref:`deindex<class_SurfaceTool_deindex>`  **(** **)**                                                     |
    47. 

  47. +--------------------------+------------------------------------------------------------------------------------------------------------+
    48. 

  48. | void                     | :ref:`generate_normals<class_SurfaceTool_generate_normals>`  **(** **)**                                   |
    49. 

  49. +--------------------------+------------------------------------------------------------------------------------------------------------+
    50. 

  50. | :ref:`Mesh<class_mesh>`  | :ref:`commit<class_SurfaceTool_commit>`  **(** :ref:`Mesh<class_mesh>` existing=NULL  **)**                |
    51. 

  51. +--------------------------+------------------------------------------------------------------------------------------------------------+
    52. 

  52. | void                     | :ref:`clear<class_SurfaceTool_clear>`  **(** **)**                                                         |
    53. 

  53. +--------------------------+------------------------------------------------------------------------------------------------------------+
    54. 

  54. 

  55. Description
    56. 

  56. -----------
    57. 

  57. 

  58. Helper tool to create geometry.
    59. 

  59. 

  60. Member Function Description
    61. 

  61. ---------------------------
    62. 

  62. 

  63. .. _class_SurfaceTool_begin:
    64. 

  64. 

  65. - void  **begin**  **(** :ref:`int<class_int>` primitive  **)**
    66. 

  66. 

  67. .. _class_SurfaceTool_add_vertex:
    68. 

  68. 

  69. - void  **add_vertex**  **(** :ref:`Vector3<class_vector3>` vertex  **)**
    70. 

  70. 

  71. .. _class_SurfaceTool_add_color:
    72. 

  72. 

  73. - void  **add_color**  **(** :ref:`Color<class_color>` color  **)**
    74. 

  74. 

  75. .. _class_SurfaceTool_add_normal:
    76. 

  76. 

  77. - void  **add_normal**  **(** :ref:`Vector3<class_vector3>` normal  **)**
    78. 

  78. 

  79. .. _class_SurfaceTool_add_tangent:
    80. 

  80. 

  81. - void  **add_tangent**  **(** :ref:`Plane<class_plane>` tangent  **)**
    82. 

  82. 

  83. .. _class_SurfaceTool_add_uv:
    84. 

  84. 

  85. - void  **add_uv**  **(** :ref:`Vector2<class_vector2>` uv  **)**
    86. 

  86. 

  87. .. _class_SurfaceTool_add_uv2:
    88. 

  88. 

  89. - void  **add_uv2**  **(** :ref:`Vector2<class_vector2>` uv2  **)**
    90. 

  90. 

  91. .. _class_SurfaceTool_add_bones:
    92. 

  92. 

  93. - void  **add_bones**  **(** :ref:`IntArray<class_intarray>` bones  **)**
    94. 

  94. 

  95. .. _class_SurfaceTool_add_weights:
    96. 

  96. 

  97. - void  **add_weights**  **(** :ref:`RealArray<class_realarray>` weights  **)**
    98. 

  98. 

  99. .. _class_SurfaceTool_add_smooth_group:
    100. 

  100. 

  101. - void  **add_smooth_group**  **(** :ref:`bool<class_bool>` smooth  **)**
    102. 

  102. 

  103. .. _class_SurfaceTool_set_material:
    104. 

  104. 

  105. - void  **set_material**  **(** :ref:`Material<class_material>` material  **)**
    106. 

  106. 

  107. .. _class_SurfaceTool_index:
    108. 

  108. 

  109. - void  **index**  **(** **)**
    110. 

  110. 

  111. .. _class_SurfaceTool_deindex:
    112. 

  112. 

  113. - void  **deindex**  **(** **)**
    114. 

  114. 

  115. .. _class_SurfaceTool_generate_normals:
    116. 

  116. 

  117. - void  **generate_normals**  **(** **)**
    118. 

  118. 

  119. .. _class_SurfaceTool_commit:
    120. 

  120. 

  121. - :ref:`Mesh<class_mesh>`  **commit**  **(** :ref:`Mesh<class_mesh>` existing=NULL  **)**
    122. 

  122. 

  123. .. _class_SurfaceTool_clear:
    124. 

  124. 

  125. - void  **clear**  **(** **)**
    126. 

  126. 

  127.