LightProbeHelper.html 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. <!DOCTYPE html>
  2. <html lang="en">
  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. [page:Object3D] &rarr; [page:Mesh] &rarr;
  11. <h1>[name]</h1>
  12. <p class="desc">
  13. Renders a sphere to visualize a light probe in the scene.
  14. <p>
  15. <h2>Import</h2>
  16. <p>
  17. [name] is an add-on, and must be imported explicitly.
  18. See [link:#manual/introduction/Installation Installation / Addons].
  19. </p>
  20. <code>
  21. import { LightProbeHelper } from 'three/addons/helpers/LightProbeHelper.js';
  22. </code>
  23. <h2>Code Example</h2>
  24. <code>
  25. const helper = new LightProbeHelper( lightProbe, 1 );
  26. scene.add( helper );
  27. </code>
  28. <h2>Examples</h2>
  29. <p>[example:webgl_lightprobe_cubecamera WebGL / lightprobe / cubecamera]</p>
  30. <h2>Constructor</h2>
  31. <h3>[name]( [param:LightProbe lightProbe], [param:Number size] )</h3>
  32. <p>
  33. [page:LightProbe lightProbe] -- the light probe.<br />
  34. [page:Number size] -- size of the helper sphere
  35. </p>
  36. <h2>Properties</h2>
  37. <p>See the base [page:Mesh] class for common properties.</p>
  38. <h3>[property:LightProbe lightProbe]</h3>
  39. <p>The light probe.</p>
  40. <h3>[property:Number size]</h3>
  41. <p>The size of the helper sphere.</p>
  42. <h2>Methods</h2>
  43. <p>See the base [page:Mesh] class for common methods.</p>
  44. <h3>[method:undefined dispose]()</h3>
  45. <p>
  46. Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.
  47. </p>
  48. <h2>Source</h2>
  49. <p>
  50. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/helpers/LightProbeHelper.js examples/jsm/helpers/LightProbeHelper.js]
  51. </p>
  52. </body>
  53. </html>