1
0

Triangle.html 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  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. <p class="desc">
  12. A geometric triangle as defined by three [page:Vector3 Vector3s]
  13. representing its three corners.
  14. </p>
  15. <h2>Constructor</h2>
  16. <h3>[name]( [param:Vector3 a], [param:Vector3 b], [param:Vector3 c] )</h3>
  17. <p>
  18. [page:Vector3 a] - the first corner of the triangle. Default is a
  19. [page:Vector3] at `(0, 0, 0)`.<br />
  20. [page:Vector3 b] - the second corner of the triangle. Default is a
  21. [page:Vector3] at `(0, 0, 0)`.<br />
  22. [page:Vector3 c] - the final corner of the triangle. Default is a
  23. [page:Vector3] at `(0, 0, 0)`.<br /><br />
  24. Creates a new [name].
  25. </p>
  26. <h2>Properties</h2>
  27. <h3>[property:Vector3 a]</h3>
  28. <p>
  29. The first corner of the triangle. Default is a [page:Vector3] at `(0, 0,
  30. 0)`.
  31. </p>
  32. <h3>[property:Vector3 b]</h3>
  33. <p>
  34. The second corner of the triangle. Default is a [page:Vector3] at `(0, 0,
  35. 0)`.
  36. </p>
  37. <h3>[property:Vector3 c]</h3>
  38. <p>
  39. The final corner of the triangle. Default is a [page:Vector3] at `(0, 0,
  40. 0)`.
  41. </p>
  42. <h2>Methods</h2>
  43. <h3>[method:Triangle clone]()</h3>
  44. <p>
  45. Returns a new triangle with the same [page:.a a], [page:.b b] and [page:.c c]
  46. properties as this one.
  47. </p>
  48. <h3>
  49. [method:Vector3 closestPointToPoint]( [param:Vector3 point], [param:Vector3 target] )
  50. </h3>
  51. <p>
  52. [page:Vector3 point] - [page:Vector3] <br />
  53. [page:Vector3 target] — the result will be copied into this Vector3.<br /><br />
  54. Returns the closest point on the triangle to [page:Vector3 point].
  55. </p>
  56. <h3>[method:Boolean containsPoint]( [param:Vector3 point] )</h3>
  57. <p>
  58. [page:Vector3 point] - [page:Vector3] to check.<br /><br />
  59. Returns true if the passed point, when projected onto the plane of the
  60. triangle, lies within the triangle.
  61. </p>
  62. <h3>[method:this copy]( [param:Triangle triangle] )</h3>
  63. <p>
  64. Copies the values of the passed triangles's [page:.a a], [page:.b b] and
  65. [page:.c c] properties to this triangle.
  66. </p>
  67. <h3>[method:Boolean equals]( [param:Triangle triangle] )</h3>
  68. <p>
  69. Returns true if the two triangles have identical [page:.a a], [page:.b b]
  70. and [page:.c c] properties.
  71. </p>
  72. <h3>[method:Float getArea]()</h3>
  73. <p>Return the area of the triangle.</p>
  74. <h3>
  75. [method:Vector3 getBarycoord]( [param:Vector3 point], [param:Vector3 target] )
  76. </h3>
  77. <p>
  78. [page:Vector3 point] - [page:Vector3] <br />
  79. [page:Vector3 target] — the result will be copied into this Vector3.<br /><br />
  80. Return a [link:https://en.wikipedia.org/wiki/Barycentric_coordinate_system barycentric coordinate]
  81. from the given vector. Returns `null` if the triangle is degenerate.<br /><br />
  82. [link:http://commons.wikimedia.org/wiki/File:Barycentric_coordinates_1.png Picture of barycentric coordinates]
  83. </p>
  84. <h3>[method:Vector3 getMidpoint]( [param:Vector3 target] )</h3>
  85. <p>
  86. [page:Vector3 target] — the result will be copied into this Vector3.<br /><br />
  87. Calculate the midpoint of the triangle.
  88. </p>
  89. <h3>[method:Vector3 getNormal]( [param:Vector3 target] )</h3>
  90. <p>
  91. [page:Vector3 target] — the result will be copied into this Vector3.<br /><br />
  92. Calculate the [link:https://en.wikipedia.org/wiki/Normal_(geometry) normal vector] of the triangle.
  93. </p>
  94. <h3>[method:Plane getPlane]( [param:Plane target] )</h3>
  95. <p>
  96. [page:Plane target] — the result will be copied into this Plane.<br /><br />
  97. Calculate a [page:Plane plane] based on the triangle. .
  98. </p>
  99. <h3>
  100. [method:Vector getInterpolation]( [param:Vector3 point], [param:Vector3 p1], [param:Vector3 p2], [param:Vector3 p3], [param:Vector v1], [param:Vector v2], [param:Vector v3], [param:Vector target] )
  101. </h3>
  102. <p>
  103. [page:Vector3 point] - Position of interpolated point.<br />
  104. [page:Vector3 p1] - Position of first vertex.<br />
  105. [page:Vector3 p2] - Position of second vertex.<br />
  106. [page:Vector3 p3] - Position of third vertex.<br />
  107. [page:Vector v1] - Value of first vertex.<br />
  108. [page:Vector v2] - Value of second vertex.<br />
  109. [page:Vector v3] - Value of third vertex.<br />
  110. [page:Vector target] — Result will be copied into this Vector.<br /><br />
  111. Returns the value barycentrically interpolated for the given point on the
  112. triangle. Returns `null` if the triangle is degenerate.
  113. </p>
  114. <h3>
  115. [method:Vector getInterpolatedAttribute]( [param:BufferAttribute attribute], [param:Number i1], [param:Vector3 i2], [param:Number i3], [param:Vector3 barycoord], [param:Vector3 target] )
  116. </h3>
  117. <p>
  118. [page:BufferAttribute attribute] - The attribute to interpolate.<br />
  119. p1 - Index of first vertex.<br />
  120. p2 - Index of second vertex.<br />
  121. p3 - Index of third vertex.<br />
  122. barycoord - The barycoordinate value to use to interpolate.<br />
  123. [page:Vector target] — Result will be copied into this Vector.<br /><br />
  124. Returns the value barycentrically interpolated for the given attribute and indices.
  125. </p>
  126. <h3>[method:Boolean intersectsBox]( [param:Box3 box] )</h3>
  127. <p>
  128. [page:Box3 box] - Box to check for intersection against.<br /><br />
  129. Determines whether or not this triangle intersects [page:Box3 box].
  130. </p>
  131. <h3>[method:Boolean isFrontFacing]( [param:Vector3 direction] )</h3>
  132. <p>
  133. [page:Vector3 direction] - The direction to test.<br /><br />
  134. Whether the triangle is oriented towards the given direction or not.
  135. </p>
  136. <h3>
  137. [method:this set]( [param:Vector3 a], [param:Vector3 b], [param:Vector3 c] )
  138. </h3>
  139. <p>
  140. Sets the triangle's [page:.a a], [page:.b b] and [page:.c c] properties to
  141. the passed [page:Vector3 vector3s].<br />
  142. Please note that this method only copies the values from the given
  143. objects.
  144. </p>
  145. <h3>
  146. [method:this setFromAttributeAndIndices]( [param:BufferAttribute attribute],
  147. [param:Integer i0], [param:Integer i1], [param:Integer i2] )
  148. </h3>
  149. <p>
  150. attribute - [page:BufferAttribute] of vertex data <br />
  151. i0 - [page:Integer] index <br />
  152. i1 - [page:Integer] index <br />
  153. i2 - [page:Integer] index<br /><br />
  154. Sets the triangle's vertices from the buffer attribute vertex data.
  155. </p>
  156. <h3>
  157. [method:this setFromPointsAndIndices]( [param:Array points], [param:Integer i0], [param:Integer i1], [param:Integer i2] )
  158. </h3>
  159. <p>
  160. points - [page:Array] of [page:Vector3]s <br />
  161. i0 - [page:Integer] index <br />
  162. i1 - [page:Integer] index <br />
  163. i2 - [page:Integer] index<br /><br />
  164. Sets the triangle's vectors to the vectors in the array.
  165. </p>
  166. <h2>Source</h2>
  167. <p>
  168. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  169. </p>
  170. </body>
  171. </html>