Plane.html 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197
  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">A two dimensional surface that extends infinitely in 3d space.</div>
  12. <h2>Constructor</h2>
  13. <h3>[name]([page:Vector3 normal], [page:Float constant])</h3>
  14. <div>
  15. normal -- the normal vector defining the plane <br />
  16. constant -- the distance from the origin to the plane along the normal vector
  17. </div>
  18. <h2>Properties</h2>
  19. <h3>.[page:Vector3 normal]</h3>
  20. <div>
  21. [Page:Vector3] representing the normal vector that definesthe plane
  22. </div>
  23. <h3>.[page:Float constant]</h3>
  24. <div>
  25. [Page:Float] describing the distance from the origin to the plane along the normal vector
  26. </div>
  27. <h2>Methods</h2>
  28. <h3>.normalize() [page:Plane this]</h3>
  29. <div>
  30. Normalizes the normal vector, and adjusts the constant value accordingly.
  31. </div>
  32. <h3>.set([page:Vector3 normal], [page:Float constant]) [page:Plane this]</h3>
  33. <div>
  34. normal -- [Page:Vector3] <br />
  35. constant -- [Page: Float]
  36. </div>
  37. <div>
  38. Sets the plane's values.
  39. </div>
  40. <h3>.copy([page:Plane plane]) [page:Plane this]</h3>
  41. <div>
  42. plane -- [page:Plane] to copy
  43. </div>
  44. <div>
  45. Copies the values of the passed plane to this plane.
  46. </div>
  47. <h3>.applyMatrix4([page:Matrix4 matrix], [page:Matrix3 optionalNormalMatrix]) [page:Plane this]</h3>
  48. <div>
  49. matrix -- [Page:Matrix4] to apply <br />
  50. optionalNormalMatrix -- (optional) normal [Page:Matrix3] of the Matrix4 to apply
  51. </div>
  52. <div>
  53. Apply a Matrix4 to the plane. The second parameter is is optional, but if not provided a new Matrix3 will be created each time this method is called.
  54. <code>
  55. var optionalNormalMatrix = new THREE.Matrix3().getNormalMatrix( matrix )
  56. </code>
  57. </div>
  58. <h3>.orthoPoint([page:todo point], [page:todo optionalTarget]) [page:todo]</h3>
  59. <div>
  60. point -- todo <br />
  61. optionalTarget -- todo
  62. </div>
  63. <div>
  64. todo
  65. </div>
  66. <h3>.isIntersectionLine([page:todo line]) [page:todo]</h3>
  67. <div>
  68. line -- todo
  69. </div>
  70. <div>
  71. todo
  72. </div>
  73. <h3>.intersectLine([page:todo line], [page:todo optionalTarget]) [page:todo]</h3>
  74. <div>
  75. line -- todo <br />
  76. optionalTarget -- todo
  77. </div>
  78. <div>
  79. todo
  80. </div>
  81. <h3>.setFromNormalAndCoplanarPoint([page:todo normal], [page:todo point]) [page:todo]</h3>
  82. <div>
  83. normal -- todo <br />
  84. point -- todo
  85. </div>
  86. <div>
  87. todo
  88. </div>
  89. <h3>.clone() [page:todo]</h3>
  90. <div>
  91. todo
  92. </div>
  93. <h3>.distanceToPoint([page:todo point]) [page:todo]</h3>
  94. <div>
  95. point -- todo
  96. </div>
  97. <div>
  98. todo
  99. </div>
  100. <h3>.equals([page:todo plane]) [page:todo]</h3>
  101. <div>
  102. plane -- todo
  103. </div>
  104. <div>
  105. todo
  106. </div>
  107. <h3>.setComponents([page:todo x], [page:todo y], [page:todo z], [page:todo w]) [page:todo]</h3>
  108. <div>
  109. x -- todo <br />
  110. y -- todo <br />
  111. z -- todo <br />
  112. w -- todo
  113. </div>
  114. <div>
  115. todo
  116. </div>
  117. <h3>.distanceToSphere([page:todo sphere]) [page:todo]</h3>
  118. <div>
  119. sphere -- todo
  120. </div>
  121. <div>
  122. todo
  123. </div>
  124. <h3>.setFromCoplanarPoints([page:todo a], [page:todo b], [page:todo c]) [page:todo]</h3>
  125. <div>
  126. a -- todo <br />
  127. b -- todo <br />
  128. c -- todo
  129. </div>
  130. <div>
  131. todo
  132. </div>
  133. <h3>.projectPoint([page:todo point], [page:todo optionalTarget]) [page:todo]</h3>
  134. <div>
  135. point -- todo <br />
  136. optionalTarget -- todo
  137. </div>
  138. <div>
  139. todo
  140. </div>
  141. <h3>.negate() [page:todo]</h3>
  142. <div>
  143. todo
  144. </div>
  145. <h3>.translate([page:todo offset]) [page:todo]</h3>
  146. <div>
  147. offset -- todo
  148. </div>
  149. <div>
  150. todo
  151. </div>
  152. <h3>.coplanarPoint([page:todo optionalTarget]) [page:todo]</h3>
  153. <div>
  154. optionalTarget -- todo
  155. </div>
  156. <div>
  157. todo
  158. </div>
  159. <h2>Source</h2>
  160. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  161. </body>
  162. </html>