2
0

Box3.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295
  1. <!DOCTYPE html>
  2. <html lang="zh">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="list.js"></script>
  7. <script src="page.js"></script>
  8. <link type="text/css" rel="stylesheet" href="page.css" />
  9. </head>
  10. <body>
  11. <h1>[name]</h1>
  12. <p class="desc">
  13. 在3D空间中表示一个盒子或立方体。其主要用于表示物体在世界坐标中的边界框。
  14. </p>
  15. <h2>代码示例</h2>
  16. <code>
  17. var box = new THREE.Box3();
  18. var mesh = new THREE.Mesh(
  19. new THREE.SphereBufferGeometry(),
  20. new THREE.MeshBasicMaterial()
  21. );
  22. // ensure the bounding box is computed for its geometry
  23. // this should be done only once (assuming static geometries)
  24. mesh.geometry.computeBoundingBox();
  25. // ...
  26. // in the animation loop, compute the current bounding box with the world matrix
  27. box.copy( mesh.geometry.boundingBox ).applyMatrix4( mesh.matrixWorld );
  28. </code>
  29. <h2>构造器(Constructor)</h2>
  30. <h3>[name]( [param:Vector3 min], [param:Vector3 max] )</h3>
  31. <p>
  32. [page:Vector3 min] - (参数可选) [page:Vector3] 表示包围盒的下边界。
  33. 默认值是( + Infinity, + Infinity, + Infinity )。<br>
  34. [page:Vector3 max] - (参数可选) [page:Vector3] 表示包围盒的上边界。
  35. 默认值是( - Infinity, - Infinity, - Infinity )。<br /><br />
  36. 创建一个以max和min为边界的包围盒。
  37. </p>
  38. <h2>属性(Properties)</h2>
  39. <h3>[property:Vector3 min]</h3>
  40. <p>
  41. [page:Vector3] 表示包围盒的下边界。<br />
  42. 默认值是( - Infinity, - Infinity, - Infinity )。
  43. </p>
  44. <h3>[property:Vector3 max]</h3>
  45. <p>
  46. [page:Vector3] 包围盒的(x, y, z)上边界。<br />
  47. 默认值是 ( - Infinity, - Infinity, - Infinity ).
  48. </p>
  49. <h2>方法(Methods)</h2>
  50. <h3>[method:Box3 applyMatrix4]( [param:Matrix4 matrix] )</h3>
  51. <p>
  52. [page:Matrix4 matrix] - 要应用的 [page:Matrix4] <br /><br />
  53. 使用传入的矩阵变换Box3(包围盒8个顶点都会乘以这个变换矩阵)。
  54. </p>
  55. <h3>[method:Vector3 clampPoint]( [param:Vector3 point], [param:Vector3 target] )</h3>
  56. <p>
  57. [page:Vector3 point] - 需要做clamp 的坐标 [page:Vector3]。 <br>
  58. [page:Vector3 target] — 结果将会被拷贝到这个对象中<br /><br />
  59. 是这个点[page:Vector3 point] [link:https://en.wikipedia.org/wiki/Clamping_(graphics) Clamps](处于范围内) 处于包围盒边界范围内。<br />
  60. </p>
  61. <h3>[method:Box3 clone]()</h3>
  62. <p>返回一个与该包围盒子有相同下边界[page:.min min] 和上边界 [page:.max max]的新包围盒。</p>
  63. <h3>[method:Boolean containsBox]( [param:Box3 box] )</h3>
  64. <p>
  65. [page:Box3 box] - 需要检测是否在当前包围盒内的 [page:Box3 Box3]。<br /><br />
  66. 传入的 [page:Box3 box] 整体都被包含在该对象中则返回true。如果他们两个包围盒是一样的也返回true。
  67. </p>
  68. <h3>[method:Boolean containsPoint]( [param:Vector3 point] )</h3>
  69. <p>
  70. [page:Vector3 point] - 需要检测是否在当前包围盒内的 [page:Vector3]。<br /><br />
  71. 当传入的值 [page:Vector3 point] 在包围盒内部或者边界都会返回true。
  72. </p>
  73. <h3>[method:Box3 copy]( [param:Box3 box] )</h3>
  74. <p>
  75. [page:Box3 box] - 需要复制的包围盒 [page:Box3] 。<br /><br />
  76. 将传入的值 [page:Box3 box] 中的 [page:.min min] 和 [page:.max max] 拷贝到当前对象。
  77. </p>
  78. <h3>[method:Float distanceToPoint]( [param:Vector3 point] )</h3>
  79. <p>
  80. [page:Vector3 point] - 用来测试距离的点 [page:Vector3]。<br /><br />
  81. 返回这个box的任何边缘到指定点的距离。如果这个点位于这个盒子里,距离将是0。
  82. </p>
  83. <h3>[method:Boolean equals]( [param:Box3 box] )</h3>
  84. <p>
  85. [page:Box3 box] - 将box与当前对象做比较。<br /><br />
  86. 返回true如果传入的值与当前的对象 [page:Box3 box] 有相同的上下边界。
  87. </p>
  88. <h3>[method:Box3 expandByObject]( [param:Object3D object] )</h3>
  89. <p>
  90. [page:Object3D object] - 包裹在包围盒中的3d对象 [page:Object3D]。<br /><br />
  91. 扩展此包围盒的边界,使得对象及其子对象在包围盒内,包括对象和子对象的世界坐标的变换。
  92. </p>
  93. <h3>[method:Box3 expandByPoint]( [param:Vector3 point] )</h3>
  94. <p>
  95. [page:Vector3 point] - 需要在包围盒中的点 [page:Vector3]。<br /><br />
  96. 扩展这个包围盒的边界使得该点([page:Vector3 point])在包围盒内。
  97. </p>
  98. <h3>[method:Box3 expandByScalar]( [param:float scalar] )</h3>
  99. <p>
  100. [page:float scalar] - 扩展包围盒的比例。<br /><br />
  101. 按 [page:float scalar] 的值展开盒子的每个维度。如果是负数,盒子的尺寸会缩小。
  102. </p>
  103. <h3>[method:Box3 expandByVector]( [param:Vector3 vector] )</h3>
  104. <p>
  105. [page:Vector3 vector] - 扩展包围盒的数值 [page:Vector3] 。<br /><br />
  106. 按 [page:Vector3 vector] 每个纬度的值展开这个箱子。
  107. 这个盒子的宽度将由 [page:Vector3 vector] 的x分量在两个方向上展开。
  108. 这个盒子的高度将由 [page:Vector3 vector] 两个方向上的y分量展开。
  109. 这个盒子的深度将由 [page:Vector3 vector] z分量在两个方向上展开。
  110. </p>
  111. <h3>[method:Sphere getBoundingSphere]( [param:Sphere target] )</h3>
  112. <p>
  113. [page:Sphere target] — 如果指定了target ,结果将会被拷贝到target。<br /><br />
  114. 获取一个包围球 [page:Sphere]。
  115. </p>
  116. <h3>[method:Vector3 getCenter]( [param:Vector3 target] )</h3>
  117. <p>
  118. [page:Vector3 target] — 如果指定了target ,结果将会被拷贝到target。<br /><br />
  119. 返回包围盒的中心点 [page:Vector3]。
  120. </p>
  121. <h3>[method:Vector3 getParameter]( [param:Vector3 point], [param:Vector3 target] ) </h3>
  122. <p>
  123. [page:Vector3 point] - [page:Vector3].<br/>
  124. [page:Vector3 target] — 如果指定了target ,结果将会被拷贝到target。<br /><br />
  125. 返回一个点为这个盒子的宽度和高度的比例。
  126. </p>
  127. <h3>[method:Vector3 getSize]( [param:Vector3 target] )</h3>
  128. <p>
  129. [page:Vector3 target] — 如果指定了target ,结果将会被拷贝到target。<br /><br />
  130. 返回包围盒的宽度,高度,和深度。
  131. </p>
  132. <h3>[method:Box3 intersect]( [param:Box3 box] )</h3>
  133. <p>
  134. [page:Box3 box] - 与包围盒的交集<br /><br />
  135. 返回此包围盒和 [page:Box3 box] 的交集,将此框的上界设置为两个框的max的较小部分,
  136. 将此包围盒的下界设置为两个包围盒的min的较大部分。
  137. </p>
  138. <h3>[method:Boolean intersectsBox]( [param:Box3 box] )</h3>
  139. <p>
  140. [page:Box3 box] - 用来检测是否相交的包围盒<br /><br />
  141. 确定当前包围盒是否与传入包围盒[page:Box3 box] 相交。
  142. </p>
  143. <h3>[method:Boolean intersectsPlane]( [param:Plane plane] )</h3>
  144. <p>
  145. [page:Plane plane] - 用来检测是否相交的 [page:Plane]。<br /><br />
  146. 确定当前包围盒是否与平面 [page:Plane plane] 相交。
  147. </p>
  148. <h3>[method:Boolean intersectsSphere]( [param:Sphere sphere] )</h3>
  149. <p>
  150. [page:Sphere sphere] - 用来检测是否相交的球体 [page:Sphere]。<br /><br />
  151. 确定当前包围盒是否与球体 [page:Sphere sphere] 相交。
  152. </p>
  153. <h3>[method:Boolean intersectsTriangle]( [param:Triangle triangle] )</h3>
  154. <p>
  155. [page:Triangle triangle] - 用来检测是否相交的三角形 [page:Triangle]。<br /><br />
  156. 确定当前包围盒是否与三角形 [page:Triangle triangle] 相交。
  157. </p>
  158. <h3>[method:Boolean isEmpty]()</h3>
  159. <p>
  160. 如果这个盒子包含0个顶点,则返回true。<br>
  161. 注意,下界和上界相等的方框仍然包含一个点,即两个边界共享的那个点。
  162. </p>
  163. <h3>[method:Box3 makeEmpty]()</h3>
  164. <p>清空包围盒。</p>
  165. <h3>[method:Box3 set]( [param:Vector3 min], [param:Vector3 max] )</h3>
  166. <p>
  167. [page:Vector3 min] - [page:Vector3] 表示下边界每个纬度(x,y,z)的值。<br />
  168. [page:Vector3 max] - [page:Vector3] 表示上边界每个纬度(x,y,z)的值。<br /><br />
  169. 设置包围盒上下边界每个纬度(x,y,z)的值。
  170. </p>
  171. <h3>[method:Box3 setFromArray]( [param:Array array] ) [param:Box3 this]</h3>
  172. <p>
  173. array -- 数组当中的所有的点都将被包围盒包裹。<br /><br />
  174. 设置包围盒的上下边界使得数组 *array* 中的所有点的点都被包含在内。
  175. </p>
  176. <h3>[method:Box3 setFromBufferAttribute]( [param:BufferAttribute attribute] ) [param:Box3 this]</h3>
  177. <p>
  178. [page:BufferAttribute attribute] - 位置的缓冲数据,包含在返回的包围盒内。<br /><br />
  179. 设置此包围盒的上边界和下边界,以包含 [page:BufferAttribute attribute] 中的所有位置数据。
  180. </p>
  181. <h3>[method:Box3 setFromCenterAndSize]( [param:Vector3 center], [param:Vector3 size] ) [param:Box3 this]</h3>
  182. <p>
  183. [page:Vector3 center], - 包围盒所要设置的中心位置。 <br>
  184. [page:Vector3 size] - 包围盒所要设置的x、y和z尺寸(宽/高/长)。<br /><br />
  185. 将当前包围盒的中心点设置为 [page:Vector3 center] ,并将此包围盒的宽度,高度和深度设置为大小指定 [page:Vector3 size] 的值。
  186. </p>
  187. <h3>[method:Box3 setFromObject]( [param:Object3D object] )</h3>
  188. <p>
  189. [page:Object3D object] - 用来计算包围盒的3D对象 [page:Object3D]。<br /><br />
  190. 计算和世界轴对齐的一个对象 [page:Object3D] (含其子对象)的包围盒,计算对象和子对象的世界坐标变换。
  191. </p>
  192. <h3>[method:Box3 setFromPoints]( [param:Array points] )</h3>
  193. <p>
  194. [page:Array points] - 计算出的包围盒将包含数组中所有的点 [page:Vector3 Vector3s]<br /><br />
  195. 设置此包围盒的上边界和下边界,以包含数组 [page:Array points] 中的所有点。
  196. </p>
  197. <h3>[method:Box3 translate]( [param:Vector3 offset] )</h3>
  198. <p>
  199. [page:Vector3 offset] - 偏移方向和距离。<br /><br />
  200. 给包围盒的上下边界添加偏移量 [page:Vector3 offset],这样可以有效的在3D空间中移动包围盒。
  201. 偏移量为 [page:Vector3 offset] 大小。
  202. </p>
  203. <h3>[method:Box3 union]( [param:Box3 box] )</h3>
  204. <p>
  205. [page:Box3 box] - 要结合在一起的包围盒。<br /><br />
  206. 在 [page:Box3 box] 参数的上边界和已有box对象的上边界之间取较大者,而对两者的下边界取较小者,这样获得一个新的较大的联合盒子。
  207. </p>
  208. <h2>源码(Source)</h2>
  209. <p>
  210. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  211. </p>
  212. </body>
  213. </html>