Geometry.html 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <script src="../../list.js"></script>
  6. <script src="../../page.js"></script>
  7. <link type="text/css" rel="stylesheet" href="../../page.css" />
  8. </head>
  9. <body>
  10. <h1>[name]</h1>
  11. <div class="desc">
  12. Base class for geometries.<br />
  13. A geometry holds all data necessary to describe a 3D model.
  14. </div>
  15. <h2>Example</h2>
  16. <code>var geometry = new THREE.Geometry()
  17. geometry.vertices.push( new THREE.Vector3( -10, 10, 0 ) );
  18. geometry.vertices.push( new THREE.Vector3( -10, -10, 0 ) );
  19. geometry.vertices.push( new THREE.Vector3( 10, -10, 0 ) );
  20. geometry.faces.push( new THREE.Face3( 0, 1, 2 ) );
  21. geometry.computeBoundingSphere();
  22. </code>
  23. <h2>Constructor</h2>
  24. <h3>[name]()</h3>
  25. <h2>Properties</h2>
  26. <h3>.[page:Integer id]</h3>
  27. <div>
  28. Unique number of this geometry instance
  29. </div>
  30. <h3>.[page:String name]</h3>
  31. <div>
  32. Name for this geometry. Default is an empty string.
  33. </div>
  34. <h3>.[page:Array vertices]</h3>
  35. <div>
  36. Array of [page:Vector3 vertices].<br />
  37. The array of vertices hold every position of points of the model.<br />
  38. To signal an update in this array, [page:Geometry Geometry.verticesNeedUpdate] needs to be set to true.
  39. </div>
  40. <h3>.[page:Array colors]</h3>
  41. <div>
  42. Array of vertex [page:Color colors], matching number and order of vertices.<br />
  43. Used in [page:ParticleSystem], [page:Line] and [page:Ribbon].<br />
  44. [page:Mesh Meshes] use per-face-use-of-vertex colors embedded directly in faces.<br />
  45. To signal an update in this array, [page:Geometry Geometry.colorsNeedUpdate] needs to be set to true.
  46. </div>
  47. <h3>.[page:Array normals]</h3>
  48. <div>
  49. Array of vertex [page:Vector3 normals], matching number and order of vertices.<br />
  50. [link:http://en.wikipedia.org/wiki/Normal_(geometry) Normal vectors] are nessecary for lighting <br />
  51. To signal an update in this array, [page:Geometry Geometry.normalsNeedUpdate] needs to be set to true.
  52. </div>
  53. <h3>.[page:Array faces]</h3>
  54. <div>
  55. Array of [page:Face3 triangles] or/and [page:Face4 quads].<br />
  56. The array of faces describe how each vertex in the model is connected with each other.<br />
  57. To signal an update in this array, [page:Geometry Geometry.elementsNeedUpdate] needs to be set to true.
  58. </div>
  59. <h3>.[page:Array faceUvs]</h3>
  60. <div>
  61. Array of face [page:UV] layers.<br />
  62. Each UV layer is an array of [page:UV] matching order and number of faces.<br />
  63. To signal an update in this array, [page:Geometry Geometry.uvsNeedUpdate] needs to be set to true.
  64. </div>
  65. <h3>.[page:Array faceVertexUvs]</h3>
  66. <div>
  67. Array of face [page:UV] layers.<br />
  68. Each UV layer is an array of [page:UV] matching order and number of vertices in faces.<br />
  69. To signal an update in this array, [page:Geometry Geometry.uvsNeedUpdate] needs to be set to true.
  70. </div>
  71. <h3>.[page:Array morphTargets]</h3>
  72. <div>
  73. Array of morph targets. Each morph target is a Javascript object:
  74. <code>{ name: "targetName", vertices: [ new THREE.Vector3(), ... ] }</code>
  75. Morph vertices match number and order of primary vertices.
  76. </div>
  77. <h3>.[page:Array morphColors]</h3>
  78. <div>
  79. Array of morph colors. Morph colors have similar structure as morph targets, each color set is a Javascript object:
  80. <code>morphColor = { name: "colorName", colors: [ new THREE.Color(), ... ] }</code>
  81. Morph colors can match either number and order of faces (face colors) or number of vertices (vertex colors).
  82. </div>
  83. <h3>.[page:Array morphColors]</h3>
  84. <div>
  85. Array of morph normals. Morph Normals have similar structure as morph targets, each normal set is a Javascript object:
  86. <code>morphNormal = { name: "NormalName", normals: [ new THREE.Vector3(), ... ] }</code>
  87. </div>
  88. <h3>.[page:Array skinWeights]</h3>
  89. <div>
  90. Array of skinning weights, matching number and order of vertices.
  91. </div>
  92. <h3>.[page:Array skinIndices]</h3>
  93. <div>
  94. Array of skinning indices, matching number and order of vertices.
  95. </div>
  96. <h3>.[page:Object boundingBox]</h3>
  97. <div>
  98. Bounding box.
  99. <code>{ min: new THREE.Vector3(), max: new THREE.Vector3() }</code>
  100. </div>
  101. <h3>.[page:Object boundingSphere]</h3>
  102. <div>
  103. Bounding sphere.
  104. <code>{ radius: float }</code>
  105. </div>
  106. <h3>.[page:Boolean hasTangents]</h3>
  107. <div>
  108. True if geometry has tangents. Set in [page:Geometry Geometry.computeTangents].
  109. </div>
  110. <h3>.[page:Boolean dynamic]</h3>
  111. <div>
  112. Set to *true* if attribute buffers will need to change in runtime (using "dirty" flags).<br/>
  113. Unless set to true internal typed arrays corresponding to buffers will be deleted once sent to GPU.<br/>
  114. Defaults to true.
  115. </div>
  116. <h3>.[page:Boolean verticesNeedUpdate]</h3>
  117. <div>
  118. Set to *true* if the vertices array has been updated.
  119. </div>
  120. <h3>.[page:Boolean elementsNeedUpdate]</h3>
  121. <div>
  122. Set to *true* if the faces array has been updated.
  123. </div>
  124. <h3>.[page:Boolean uvsNeedUpdate]</h3>
  125. <div>
  126. Set to *true* if the uvs array has been updated.
  127. </div>
  128. <h3>.[page:Boolean normalsNeedUpdate]</h3>
  129. <div>
  130. Set to *true* if the normals array has been updated.
  131. </div>
  132. <h3>.[page:Boolean tangentsNeedUpdate]</h3>
  133. <div>
  134. Set to *true* if the tangents in the faces has been updated.
  135. </div>
  136. <h3>.[page:Boolean colorsNeedUpdate]</h3>
  137. <div>
  138. Set to *true* if the colors array has been updated.
  139. </div>
  140. <h3>.[page:Boolean lineDistancesNeedUpdate]</h3>
  141. <div>
  142. Set to *true* if the linedistances array has been updated.
  143. </div>
  144. <h3>.[page:Boolean buffersNeedUpdate]</h3>
  145. <div>
  146. Set to *true* if an array has changed in length.
  147. </div>
  148. <h2>Methods</h2>
  149. <h3>.applyMatrix( [page:Matrix4 matrix] )</h3>
  150. <div>
  151. Bakes matrix transform directly into vertex coordinates.
  152. </div>
  153. <h3>.computeCentroids()</h3>
  154. <div>
  155. Computes centroids for all faces.
  156. </div>
  157. <h3>.computeFaceNormals()</h3>
  158. <div>
  159. Computes face normals.
  160. </div>
  161. <h3>.computeVertexNormals()</h3>
  162. <div>
  163. Computes vertex normals by averaging face normals.<br />
  164. Face normals must be existing / computed beforehand.
  165. </div>
  166. <h3>.computeMorphNormals()</h3>
  167. <div>
  168. Computes morph normals.
  169. </div>
  170. <h3>.computeTangents()</h3>
  171. <div>
  172. Computes vertex tangents.<br />
  173. Based on [link:http://www.terathon.com/code/tangent.html]<br />
  174. Geometry must have vertex [page:UV UVs] (layer 0 will be used).
  175. </div>
  176. <h3>.computeBoundingBox()</h3>
  177. <div>
  178. Computes bounding box of the geometry, updating [page:Geometry Geometry.boundingBox] attribute.
  179. </div>
  180. <h3>.computeBoundingSphere()</h3>
  181. <div>
  182. Computes bounding sphere of the geometry, updating [page:Geometry Geometry.boundingSphere] attribute.
  183. </div>
  184. <div>Neither bounding boxes or bounding spheres are computed by default. They need to be explicitly computed, otherwise they are *null*.</div>
  185. <h3>.mergeVertices()</h3>
  186. <div>
  187. Checks for duplicate vertices using hashmap.<br />
  188. Duplicated vertices are removed and faces' vertices are updated.
  189. </div>
  190. <h3>.clone()</h3>
  191. <div>
  192. Creates a new clone of the Geometry.
  193. </div>
  194. <h3>.dispose()</h3>
  195. <div>
  196. Removes The object from memory. <br />
  197. Don't forget to call this method when you remove an geometry because it can cuase meomory leaks.
  198. </div>
  199. <h2>Source</h2>
  200. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  201. </body>
  202. </html>