Box3.html 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232
  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">Represents a boundary box in 3d space.</div>
  12. <h2>Constructor</h2>
  13. <h3>[name]([page:Vector3 min], [page:Vector3 max])</h3>
  14. <div>
  15. min -- Lower (x, y, z) boundary of the box. <br />
  16. max -- Upper (x, y, z) boundary of the box.
  17. </div>
  18. <div>
  19. Creates a box bounded by min and max
  20. </div>
  21. <h2>Properties</h2>
  22. <h3>.[page:Vector3 max]</h3>
  23. <div>
  24. Upper (x, y, z) boundary of this box.
  25. </div>
  26. <h3>.[page:Vector3 min]</h3>
  27. <div>
  28. Lower (x, y, z) boundary of this box.
  29. </div>
  30. <h2>Methods</h2>
  31. <h3>.set([page:Vector3 min], [page:Vector3 max]) [page:Box3 this]</h3>
  32. <div>
  33. min -- Upper (x, y, z) boundary of this box. <br />
  34. max -- Lower (x, y, z) boundary of this box.
  35. </div>
  36. <div>
  37. todo
  38. </div>
  39. <h3>.applyMatrix4([page:Matrix4 matrix]) [page:Box3 this]</h3>
  40. <div>
  41. matrix -- Transform the box with a matrix.
  42. </div>
  43. <div>
  44. todo
  45. </div>
  46. <h3>.expandByPoint([page:Vector3 point]) [page:Box3 this]</h3>
  47. <div>
  48. Expands the box outwards by the point. It takes the min and max values of the box.
  49. </div>
  50. <h3>.clampPoint([page:Vector3 point], [page:todo optionalTarget]) [page:todo]</h3>
  51. <div>
  52. point -- todo <br />
  53. optionalTarget -- todo
  54. </div>
  55. <div>
  56. todo
  57. </div>
  58. <h3>.isIntersectionBox([page:todo box]) [page:todo]</h3>
  59. <div>
  60. box -- todo
  61. </div>
  62. <div>
  63. todo
  64. </div>
  65. <h3>.setFromPoints([page:todo points]) [page:todo]</h3>
  66. <div>
  67. points -- todo
  68. </div>
  69. <div>
  70. todo
  71. </div>
  72. <h3>.size([page:todo optionalTarget]) [page:todo]</h3>
  73. <div>
  74. optionalTarget -- todo
  75. </div>
  76. <div>
  77. todo
  78. </div>
  79. <h3>.union([page:todo box]) [page:todo]</h3>
  80. <div>
  81. box -- todo
  82. </div>
  83. <div>
  84. todo
  85. </div>
  86. <h3>.getParameter([page:todo point]) [page:todo]</h3>
  87. <div>
  88. point -- todo
  89. </div>
  90. <div>
  91. todo
  92. </div>
  93. <h3>.expandByScalar([page:todo scalar]) [page:todo]</h3>
  94. <div>
  95. scalar -- todo
  96. </div>
  97. <div>
  98. todo
  99. </div>
  100. <h3>.intersect([page:todo box]) [page:todo]</h3>
  101. <div>
  102. box -- todo
  103. </div>
  104. <div>
  105. todo
  106. </div>
  107. <h3>.containsBox([page:todo box]) [page:todo]</h3>
  108. <div>
  109. box -- todo
  110. </div>
  111. <div>
  112. todo
  113. </div>
  114. <h3>.translate([page:todo offset]) [page:todo]</h3>
  115. <div>
  116. offset -- todo
  117. </div>
  118. <div>
  119. todo
  120. </div>
  121. <h3>.empty() [page:todo]</h3>
  122. <div>
  123. todo
  124. </div>
  125. <h3>.clone() [page:todo]</h3>
  126. <div>
  127. todo
  128. </div>
  129. <h3>.equals([page:todo box]) [page:todo]</h3>
  130. <div>
  131. box -- todo
  132. </div>
  133. <div>
  134. todo
  135. </div>
  136. <h3>.expandByVector([page:todo vector]) [page:todo]</h3>
  137. <div>
  138. vector -- todo
  139. </div>
  140. <div>
  141. todo
  142. </div>
  143. <h3>.copy([page:todo box]) [page:todo]</h3>
  144. <div>
  145. box -- todo
  146. </div>
  147. <div>
  148. todo
  149. </div>
  150. <h3>.makeEmpty() [page:todo]</h3>
  151. <div>
  152. todo
  153. </div>
  154. <h3>.center([page:todo optionalTarget]) [page:todo]</h3>
  155. <div>
  156. optionalTarget -- todo
  157. </div>
  158. <div>
  159. todo
  160. </div>
  161. <h3>.getBoundingSphere([page:todo optionalTarget]) [page:todo]</h3>
  162. <div>
  163. optionalTarget -- todo
  164. </div>
  165. <div>
  166. todo
  167. </div>
  168. <h3>.distanceToPoint([page:todo point]) [page:todo]</h3>
  169. <div>
  170. point -- todo
  171. </div>
  172. <div>
  173. todo
  174. </div>
  175. <h3>.containsPoint([page:todo point]) [page:todo]</h3>
  176. <div>
  177. point -- todo
  178. </div>
  179. <div>
  180. todo
  181. </div>
  182. <h3>.setFromCenterAndSize([page:todo center], [page:todo size]) [page:todo]</h3>
  183. <div>
  184. center -- todo <br />
  185. size -- todo
  186. </div>
  187. <div>
  188. todo
  189. </div>
  190. <h2>Source</h2>
  191. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  192. </body>
  193. </html>