CubeCamera.html 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>CubeCamera - Three.js Docs</title>
  6. <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
  7. <script src="../scripts/highlight.min.js"></script>
  8. <link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
  9. <link type="text/css" rel="stylesheet" href="../styles/page.css">
  10. </head>
  11. <body>
  12. <p class="inheritance" translate="no"><a href="EventDispatcher.html">EventDispatcher</a> → <a href="Object3D.html">Object3D</a> → </p>
  13. <h1 translate="no">CubeCamera</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>A special type of camera that is positioned in 3D space to render its surroundings into a
  17. cube render target. The render target can then be used as an environment map for rendering
  18. realtime reflections in your scene.</p></div>
  19. <h2>Code Example</h2>
  20. <div translate="no"><pre><code class="language-js">// Create cube render target
  21. const cubeRenderTarget = new THREE.WebGLCubeRenderTarget( 256, { generateMipmaps: true, minFilter: THREE.LinearMipmapLinearFilter } );
  22. // Create cube camera
  23. const cubeCamera = new THREE.CubeCamera( 1, 100000, cubeRenderTarget );
  24. scene.add( cubeCamera );
  25. // Create car
  26. const chromeMaterial = new THREE.MeshLambertMaterial( { color: 0xffffff, envMap: cubeRenderTarget.texture } );
  27. const car = new THREE.Mesh( carGeometry, chromeMaterial );
  28. scene.add( car );
  29. // Update the render target cube
  30. car.visible = false;
  31. cubeCamera.position.copy( car.position );
  32. cubeCamera.update( renderer, scene );
  33. // Render the scene
  34. car.visible = true;
  35. renderer.render( scene, camera );
  36. </code></pre></div>
  37. </header>
  38. <article>
  39. <div class="container-overview">
  40. <h2>Constructor</h2>
  41. <h3 class="name name-method" id="CubeCamera" translate="no">new <a href="#CubeCamera">CubeCamera</a><span class="signature">( near : <span class="param-type">number</span>, far : <span class="param-type">number</span>, renderTarget : <span class="param-type"><a href="WebGLCubeRenderTarget.html">WebGLCubeRenderTarget</a></span> )</span> </h3>
  42. <div class="method">
  43. <div class="description">
  44. <p>Constructs a new cube camera.</p>
  45. </div>
  46. <table class="params">
  47. <tbody>
  48. <tr>
  49. <td class="name">
  50. <strong>near</strong>
  51. </td>
  52. <td class="description last">
  53. <p>The camera's near plane.</p>
  54. </td>
  55. </tr>
  56. <tr>
  57. <td class="name">
  58. <strong>far</strong>
  59. </td>
  60. <td class="description last">
  61. <p>The camera's far plane.</p>
  62. </td>
  63. </tr>
  64. <tr>
  65. <td class="name">
  66. <strong>renderTarget</strong>
  67. </td>
  68. <td class="description last">
  69. <p>The cube render target.</p>
  70. </td>
  71. </tr>
  72. </tbody>
  73. </table>
  74. </div>
  75. </div>
  76. <h2 class="subsection-title">Properties</h2>
  77. <div class="member">
  78. <h3 class="name" id="activeMipmapLevel" translate="no">.<a href="#activeMipmapLevel">activeMipmapLevel</a><span class="type-signature"> : number</span> </h3>
  79. <div class="description">
  80. <p>The current active mipmap level</p>
  81. <p>Default is <code>0</code>.</p>
  82. </div>
  83. </div>
  84. <div class="member">
  85. <h3 class="name" id="coordinateSystem" translate="no">.<a href="#coordinateSystem">coordinateSystem</a><span class="type-signature"> : <a href="global.html#WebGLCoordinateSystem">WebGLCoordinateSystem</a> | <a href="global.html#WebGPUCoordinateSystem">WebGPUCoordinateSystem</a></span> </h3>
  86. <div class="description">
  87. <p>The current active coordinate system.</p>
  88. <p>Default is <code>null</code>.</p>
  89. </div>
  90. </div>
  91. <div class="member">
  92. <h3 class="name" id="renderTarget" translate="no">.<a href="#renderTarget">renderTarget</a><span class="type-signature"> : <a href="WebGLCubeRenderTarget.html">WebGLCubeRenderTarget</a></span> </h3>
  93. <div class="description">
  94. <p>A reference to the cube render target.</p>
  95. </div>
  96. </div>
  97. <h2 class="subsection-title">Methods</h2>
  98. <h3 class="name name-method" id="update" translate="no">.<a href="#update">update</a><span class="signature">( renderer : <span class="param-type"><a href="Renderer.html">Renderer</a> | <a href="WebGLRenderer.html">WebGLRenderer</a></span>, scene : <span class="param-type"><a href="Scene.html">Scene</a></span> )</span> </h3>
  99. <div class="method">
  100. <div class="description">
  101. <p>Calling this method will render the given scene with the given renderer
  102. into the cube render target of the camera.</p>
  103. </div>
  104. <table class="params">
  105. <tbody>
  106. <tr>
  107. <td class="name">
  108. <strong>renderer</strong>
  109. </td>
  110. <td class="description last">
  111. <p>The renderer.</p>
  112. </td>
  113. </tr>
  114. <tr>
  115. <td class="name">
  116. <strong>scene</strong>
  117. </td>
  118. <td class="description last">
  119. <p>The scene to render.</p>
  120. </td>
  121. </tr>
  122. </tbody>
  123. </table>
  124. </div>
  125. <h3 class="name name-method" id="updateCoordinateSystem" translate="no">.<a href="#updateCoordinateSystem">updateCoordinateSystem</a><span class="signature">()</span> </h3>
  126. <div class="method">
  127. <div class="description">
  128. <p>Must be called when the coordinate system of the cube camera is changed.</p>
  129. </div>
  130. </div>
  131. <h2 class="subsection-title">Source</h2>
  132. <p>
  133. <a href="https://github.com/mrdoob/three.js/blob/master/src/cameras/CubeCamera.js" translate="no" target="_blank" rel="noopener">src/cameras/CubeCamera.js</a>
  134. </p>
  135. </article>
  136. </section>
  137. <script src="../scripts/linenumber.js"></script>
  138. <script src="../scripts/page.js"></script>
  139. </body>
  140. </html>
粤ICP备19079148号