Plane.html 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. <!DOCTYPE html>
  2. <html lang="zh">
  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. 在三维空间中无限延伸的二维平面,平面方程用单位长度的法向量和常数表示为海塞法向量[link:http://mathworld.wolfram.com/HessianNormalForm.html Hessian normal form]形式。
  13. </p>
  14. <h2>构造器(Constructor)</h2>
  15. <h3>[name]( [param:Vector3 normal], [param:Float constant] )</h3>
  16. <p>
  17. [page:Vector3 normal] - (可选参数) 定义单位长度的平面法向量[page:Vector3]。默认值为 *(1, 0, 0)*。<br />
  18. [page:Float constant] - (可选参数) 从原点到平面的有符号距离。 默认值为 *0*.
  19. </p>
  20. <h2>属性(Properties)</h2>
  21. <h3>[property:Vector3 normal]</h3>
  22. <h3>[property:Float constant]</h3>
  23. <h2>方法(Methods)</h2>
  24. <h3>[method:Plane applyMatrix4]( [param:Matrix4 matrix], [param:Matrix3 optionalNormalMatrix] )</h3>
  25. <p>
  26. [page:Matrix4 matrix] - 要应用的四位矩阵([Page:Matrix4])。<br />
  27. [page:Matrix3 optionalNormalMatrix] - (可选参数) 预先计算好的上述Matrix4参数的法线矩阵 [Page:Matrix3]。<br /><br />
  28. 在平面上应用矩阵。矩阵必须是仿射齐次变换。<br />
  29. 如果提供一个optionalNormalMatrix,可以这样创建:
  30. <code>
  31. const optionalNormalMatrix = new THREE.Matrix3().getNormalMatrix( matrix );
  32. </code>
  33. </p>
  34. <h3>[method:Plane clone]()</h3>
  35. <p>返回一个与当前平面有相同法线 [page:.normal normal],常量 [page:.constant constant] 距离的平面。</p>
  36. <h3>[method:Vector3 coplanarPoint]( [param:Vector3 target] )</h3>
  37. <p>
  38. [page:Vector3 target] — 结果会拷贝到该向量中。<br /><br />
  39. 返回一个共面点,通过原点的法向量在平面上投影算得。
  40. </p>
  41. <h3>[method:Plane copy]( [param:Plane plane] )</h3>
  42. <p>
  43. 拷贝给定平面,将其中的法线 [page:.normal normal],距离常量 [page:.constant constant]属性拷贝给该对象。
  44. </p>
  45. <h3>[method:Float distanceToPoint]( [param:Vector3 point] )</h3>
  46. <p>返回点[page:Vector3 point]到平面的有符号距离。</p>
  47. <h3>[method:Float distanceToSphere]( [param:Sphere sphere] )</h3>
  48. <p>返回球面 [page:Sphere sphere] 的边缘到平面的最短距离。</p>
  49. <h3>[method:Boolean equals]( [param:Plane plane] )</h3>
  50. <p>
  51. 检查两个平面是否相等。(法线 [page:.normal normal] 以及常量 [page:.constant constant] 都相同)。
  52. </p>
  53. <h3>[method:Vector3 intersectLine]( [param:Line3 line], [param:Vector3 target] )</h3>
  54. <p>
  55. [page:Line3 line] - 检测是否相交的三维几何线段 [page:Line3]。<br />
  56. [page:Vector3 target] — 结果将会写入该向量中。<br /><br />
  57. 返回给定线段和平面的交点。如果不相交则返回null。如果线与平面共面,则返回该线段的起始点。
  58. </p>
  59. <h3>[method:Boolean intersectsBox]( [param:Box3 box] )</h3>
  60. <p>
  61. [page:Box3 box] - 检查是否相交的包围盒 [page:Box3]。<br /><br />
  62. 确定该平面是否与给定3d包围盒[page:Box3]相交。
  63. </p>
  64. <h3>[method:Boolean intersectsLine]( [param:Line3 line] )</h3>
  65. <p>
  66. [page:Line3 line] - 检查是否相交的三维线段 [page:Line3]。<br /><br />
  67. 测试线段是否与平面相交。
  68. </p>
  69. <h3>[method:Boolean intersectsSphere]( [param:Sphere sphere] )</h3>
  70. <p>
  71. [page:Sphere sphere] - 检查是否相交的球体 [page:Sphere]。<br /><br />
  72. 确定该平面是否与给定球体 [page:Sphere] 相交。
  73. </p>
  74. <h3>[method:Plane negate]()</h3>
  75. <p>
  76. 将法向量与常量求反(乘以-1)。
  77. </p>
  78. <h3>[method:Plane normalize]()</h3>
  79. <p>
  80. 归一化法向量 [page:.normal normal] ,并相应的调整常量 [page:.constant constant]数值。
  81. </p>
  82. <h3>[method:Vector3 projectPoint]( [param:Vector3 point], [param:Vector3 target] )</h3>
  83. <p>
  84. [page:Vector3 point] - 需要投射到该平面的点。<br />
  85. [page:Vector3 target] — 在该平面上离投射点最近的点。<br /><br />
  86. 将一个点[page:Vector3 point]投射到该平面上。
  87. </p>
  88. <h3>[method:Plane set]( [param:Vector3 normal], [param:Float constant] )</h3>
  89. <p>
  90. [page:Vector3 normal] - 单位长度的向量表示平面的法向量。<br />
  91. [page:Float constant] - 原点到平面有符号距离。默认值为 *0*。<br /><br />
  92. 设置平面 [page:.normal normal] 的法线和常量 [page:.constant constant] 属性值 by copying the values from the given normal。
  93. </p>
  94. <h3>[method:Plane setComponents]( [param:Float x], [param:Float y], [param:Float z], [param:Float w] )</h3>
  95. <p>
  96. [page:Float x] - 单位长度法向量的x值。<br />
  97. [page:Float y] - 单位长度法向量的y值。<br />
  98. [page:Float z] - 单位长度法向量的z值。<br />
  99. [page:Float w] - 原点沿法向量到平面常量 [page:.constant constant] 距离。<br /><br />
  100. 设置定义平面的各个变量。
  101. </p>
  102. <h3>[method:Plane setFromCoplanarPoints]( [param:Vector3 a], [param:Vector3 b], [param:Vector3 c] )</h3>
  103. <p>
  104. [page:Vector3 a] - 用于确定平面的第一个点。<br />
  105. [page:Vector3 b] - 用于确定平面的第二个点。<br />
  106. [page:Vector3 c] - 用于确定平面的第三个点。<br /><br />
  107. 根据给定的三个点确定平面。如果三个点共线将会抛出错误。通过右手螺旋规则确定(向量叉乘)法向量 [page:.normal normal]。
  108. </p>
  109. <h3>[method:Plane setFromNormalAndCoplanarPoint]( [param:Vector3 normal], [param:Vector3 point] ) [param:Vector3 this]</h3>
  110. <p>
  111. [page:Vector3 normal] - 平面单位法向量<br />
  112. [page:Vector3 point] - 平面上的点<br /><br />
  113. 通过平面上的一点以及法线确定原点到平面的最短距离(常量)。
  114. </p>
  115. <h3>[method:Plane translate]( [param:Vector3 offset] )</h3>
  116. <p>
  117. [page:Vector3 offset] - 平移量<br /><br />
  118. 将平面平移给定向量大小,注意:这只会影响平面的常量不会影响平面的法向量。
  119. </p>
  120. <h2>Source</h2>
  121. <p>
  122. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  123. </p>
  124. </body>
  125. </html>