Raycaster.html 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202
  1. <!DOCTYPE html>
  2. <html lang="en">
  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. 这个类用于进行[link:https://en.wikipedia.org/wiki/Ray_casting raycasting](光线投射)。
  14. 光线投射用于进行鼠标拾取(在三维空间中计算出鼠标移过了什么物体)。
  15. </p>
  16. <h2>示例</h2>
  17. <code>
  18. var raycaster = new THREE.Raycaster();
  19. var mouse = new THREE.Vector2();
  20. function onMouseMove( event ) {
  21. // 将鼠标位置归一化为设备坐标。x 和 y 方向的取值范围是 (-1 to +1)
  22. mouse.x = ( event.clientX / window.innerWidth ) * 2 - 1;
  23. mouse.y = - ( event.clientY / window.innerHeight ) * 2 + 1;
  24. }
  25. function render() {
  26. // 通过摄像机和鼠标位置更新射线
  27. raycaster.setFromCamera( mouse, camera );
  28. // 计算物体和射线的焦点
  29. var intersects = raycaster.intersectObjects( scene.children );
  30. for ( var i = 0; i < intersects.length; i++ ) {
  31. intersects[ i ].object.material.color.set( 0xff0000 );
  32. }
  33. renderer.render( scene, camera );
  34. }
  35. window.addEventListener( 'mousemove', onMouseMove, false );
  36. window.requestAnimationFrame(render);
  37. </code>
  38. <div>
  39. 其它示例:<br>[example:webgl_interactive_cubes Raycasting to a Mesh]<br />
  40. [example:webgl_interactive_cubes_ortho Raycasting to a Mesh in using an OrthographicCamera]<br />
  41. [example:webgl_interactive_buffergeometry Raycasting to a Mesh with BufferGeometry]<br />
  42. [example:webgl_interactive_lines Raycasting to a Line]<br />
  43. [example:webgl_interactive_raycasting_points Raycasting to Points]<br />
  44. [example:webgl_geometry_terrain_raycast Terrain raycasting]<br />
  45. [example:webgl_interactive_voxelpainter Raycasting to paint voxels]<br />
  46. [example:webgl_raycast_texture Raycast to a Texture]
  47. </div>
  48. <p>
  49. </p>
  50. <h2>构造器</h2>
  51. <h3>[name]( [param:Vector3 origin], [param:Vector3 direction], [param:Float near], [param:Float far] ) {</h3>
  52. <p>
  53. [page:Vector3 origin] —— 光线投射的原点向量。<br />
  54. [page:Vector3 direction] —— 向射线提供方向的方向向量,应当被标准化。<br />
  55. [page:Float near] —— 返回的所有结果比near远。near不能为负值,其默认值为0。<br />
  56. [page:Float far] —— 返回的所有结果都比far近。far不能小于near,其默认值为Infinity(正无穷。)</p>
  57. <p>
  58. 这将创建一个新的raycaster对象。<br />
  59. </p>
  60. <h2>属性</h2>
  61. <h3>[property:float far]</h3>
  62. <p>
  63. raycaster的远距离因数(投射远点)。这个值表明哪些对象可以基于该距离而被raycaster所丢弃。
  64. 这个值不应当为负,并且应当比near属性大。
  65. </p>
  66. <h3>[property:float linePrecision]</h3>
  67. <p>
  68. raycaster与[page:Line](线)物体相交时的精度因数。
  69. </p>
  70. <h3>[property:float near]</h3>
  71. <p>
  72. raycaster的近距离因数(投射近点)。这个值表明哪些对象可以基于该距离而被raycaster所丢弃。
  73. 这个值不应当为负,并且应当比near属性小。
  74. </p>
  75. <h3>[property:Camera camera]</h3>
  76. <p>
  77. The camera to use when raycasting against view-dependent objects such as billboarded objects like [page:Sprites]. This field
  78. can be set manually or is set when calling "setFromCamera".
  79. Defaults to null.
  80. </p>
  81. <h3>[property:Object params]</h3>
  82. <p>
  83. 具有以下属性的对象:<code>
  84. {
  85. Mesh: {},
  86. Line: {},
  87. LOD: {},
  88. Points: { threshold: 1 },
  89. Sprite: {}
  90. }
  91. </code>
  92. </p>
  93. <h3>[property:Ray ray]</h3>
  94. <p>用于进行光线投射的[Page:Ray](射线)。</p>
  95. <h2>方法</h2>
  96. <h3>[method:null set]( [param:Vector3 origin], [param:Vector3 direction] )</h3>
  97. <p>
  98. [page:Vector3 origin] —— 光线投射的原点向量。<br />
  99. [page:Vector3 direction] —— 为光线提供方向的标准化方向向量。
  100. </p>
  101. <p>
  102. 使用一个新的原点和方向来更新射线。
  103. </p>
  104. <h3>[method:null setFromCamera]( [param:Vector2 coords], [param:Camera camera] )</h3>
  105. <p>
  106. [page:Vector2 coords] —— 在标准化设备坐标中鼠标的二维坐标 —— X分量与Y分量应当在-1到1之间。<br />
  107. [page:Camera camera] —— 射线所来源的摄像机。
  108. </p>
  109. <p>
  110. 使用一个新的原点和方向来更新射线。
  111. </p>
  112. <h3>[method:Array intersectObject]( [param:Object3D object], [param:Boolean recursive], [param:Array optionalTarget] )</h3>
  113. <p>
  114. [page:Object3D object] —— 检查与射线相交的物体。<br />
  115. [page:Boolean recursive] —— 若为true,则同时也会检查所有的后代。否则将只会检查对象本身。默认值为false。<br />
  116. [page:Array optionalTarget] — (可选)设置结果的目标数组。如果不设置这个值,则一个新的[page:Array]会被实例化;如果设置了这个值,则在每次调用之前必须清空这个数组(例如:array.length = 0;)。
  117. </p>
  118. <p>
  119. 检测所有在射线与物体之间,包括或不包括后代的相交部分。返回结果时,相交部分将按距离进行排序,最近的位于第一个。<br>
  120. 该方法返回一个包含有交叉部分的数组:
  121. </p>
  122. <code>
  123. [ { distance, point, face, faceIndex, object }, ... ]
  124. </code>
  125. <p>
  126. [page:Float distance] —— 射线投射原点和相交部分之间的距离。<br />
  127. [page:Vector3 point] —— 相交部分的点(世界坐标)<br />
  128. [page:Face3 face] —— 相交的面<br />
  129. [page:Integer faceIndex] —— 相交的面的索引<br />
  130. [page:Object3D object] —— 相交的物体<br />
  131. [page:Vector2 uv] —— 相交部分的点的UV坐标。<br />
  132. [page:Vector2 uv2] —— Second set of U,V coordinates at point of intersection
  133. </p>
  134. <p>
  135. 当计算这条射线是否和物体相交的时候,*Raycaster*将传入的对象委托给[page:Object3D.raycast raycast]方法。
  136. 这将可以让[page:Mesh mesh]对于光线投射的响应不同于[page:Line lines]和[page:Points pointclouds]。
  137. </p>
  138. <p>
  139. <strong>请注意</strong>:对于网格来说,面必须朝向射线的原点,以便其能够被检测到。
  140. 用于交互的射线穿过面的背侧时,将不会被检测到。如果需要对物体中面的两侧进行光线投射,
  141. 你需要将[page:Mesh.material material]中的[page:Material.side side]属性设置为*THREE.DoubleSide*。
  142. </p>
  143. <h3>[method:Array intersectObjects]( [param:Array objects], [param:Boolean recursive], [param:Array optionalTarget] )</h3>
  144. <p>
  145. [page:Array objects] —— 检测和射线相交的一组物体。<br />
  146. [page:Boolean recursive] —— 若为true,则同时也会检测所有物体的后代。否则将只会检测对象本身的相交部分。默认值为false。<br />
  147. [page:Array optionalTarget] —— (可选)设置结果的目标数组。如果不设置这个值,则一个新的[page:Array]会被实例化;如果设置了这个值,则在每次调用之前必须清空这个数组(例如:array.length = 0;)。
  148. </p>
  149. <p>
  150. 检测所有在射线与这些物体之间,包括或不包括后代的相交部分。返回结果时,相交部分将按距离进行排序,最近的位于第一个),相交部分和[page:.intersectObject]所返回的格式是相同的。
  151. </p>
  152. <h2>源代码</h2>
  153. <p>
  154. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  155. </p>
  156. </body>
  157. </html>