SkyMesh.html 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>SkyMesh - 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> → <a href="Mesh.html">Mesh</a> → </p>
  13. <h1 translate="no">SkyMesh</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>Represents a skydome for scene backgrounds. Based on <a href="https://www.researchgate.net/publication/220720443_A_Practical_Analytic_Model_for_Daylight" target="_blank" rel="noopener">A Practical Analytic Model for Daylight</a>
  17. aka The Preetham Model, the de facto standard for analytical skydomes.</p>
  18. <p>Note that this class can only be used with <a href="WebGPURenderer.html">WebGPURenderer</a>.
  19. When using <a href="WebGLRenderer.html">WebGLRenderer</a>, use <a href="Sky.html">Sky</a>.</p>
  20. <p>More references:</p>
  21. <ul>
  22. <li><a href="http://simonwallner.at/project/atmospheric-scattering/" target="_blank" rel="noopener">http://simonwallner.at/project/atmospheric-scattering/</a></li>
  23. <li><a href="http://blenderartists.org/forum/showthread.php?245954-preethams-sky-impementation-HDR" target="_blank" rel="noopener">http://blenderartists.org/forum/showthread.php?245954-preethams-sky-impementation-HDR</a></li>
  24. </ul></div>
  25. <h2>Code Example</h2>
  26. <div translate="no"><pre><code class="language-js">const sky = new SkyMesh();
  27. sky.scale.setScalar( 10000 );
  28. scene.add( sky );
  29. </code></pre></div>
  30. </header>
  31. <article>
  32. <h2 class="subsection-title">Import</h2>
  33. <p><span translate="no">SkyMesh</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank" rel="noopener">Installation#Addons</a>.</p>
  34. <pre><code class="language-js">import { SkyMesh } from 'three/addons/objects/SkyMesh.js';</code></pre>
  35. <div class="container-overview">
  36. <h2>Constructor</h2>
  37. <h3 class="name name-method" id="SkyMesh" translate="no">new <a href="#SkyMesh">SkyMesh</a><span class="signature">()</span> </h3>
  38. <div class="method">
  39. <div class="description">
  40. <p>Constructs a new skydome.</p>
  41. </div>
  42. </div>
  43. </div>
  44. <h2 class="subsection-title">Properties</h2>
  45. <div class="member">
  46. <h3 class="name" id="isSky" translate="no">.<a href="#isSky">isSky</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
  47. <div class="description">
  48. <p>This flag can be used for type testing.</p>
  49. <p>Default is <code>true</code>.</p>
  50. </div>
  51. <dl class="details">
  52. <dt class="important tag-deprecated"><strong>Deprecated:</strong> Use isSkyMesh instead.</dt>
  53. </dl>
  54. </div>
  55. <div class="member">
  56. <h3 class="name" id="isSkyMesh" translate="no">.<a href="#isSkyMesh">isSkyMesh</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
  57. <div class="description">
  58. <p>This flag can be used for type testing.</p>
  59. <p>Default is <code>true</code>.</p>
  60. </div>
  61. </div>
  62. <div class="member">
  63. <h3 class="name" id="mieCoefficient" translate="no">.<a href="#mieCoefficient">mieCoefficient</a><span class="type-signature"> : <a href="UniformNode.html">UniformNode</a>.&lt;float></span> </h3>
  64. <div class="description">
  65. <p>The mieCoefficient uniform.</p>
  66. </div>
  67. </div>
  68. <div class="member">
  69. <h3 class="name" id="mieDirectionalG" translate="no">.<a href="#mieDirectionalG">mieDirectionalG</a><span class="type-signature"> : <a href="UniformNode.html">UniformNode</a>.&lt;float></span> </h3>
  70. <div class="description">
  71. <p>The mieDirectionalG uniform.</p>
  72. </div>
  73. </div>
  74. <div class="member">
  75. <h3 class="name" id="rayleigh" translate="no">.<a href="#rayleigh">rayleigh</a><span class="type-signature"> : <a href="UniformNode.html">UniformNode</a>.&lt;float></span> </h3>
  76. <div class="description">
  77. <p>The rayleigh uniform.</p>
  78. </div>
  79. </div>
  80. <div class="member">
  81. <h3 class="name" id="sunPosition" translate="no">.<a href="#sunPosition">sunPosition</a><span class="type-signature"> : <a href="UniformNode.html">UniformNode</a>.&lt;vec3></span> </h3>
  82. <div class="description">
  83. <p>The sun position uniform.</p>
  84. </div>
  85. </div>
  86. <div class="member">
  87. <h3 class="name" id="turbidity" translate="no">.<a href="#turbidity">turbidity</a><span class="type-signature"> : <a href="UniformNode.html">UniformNode</a>.&lt;float></span> </h3>
  88. <div class="description">
  89. <p>The turbidity uniform.</p>
  90. </div>
  91. </div>
  92. <div class="member">
  93. <h3 class="name" id="upUniform" translate="no">.<a href="#upUniform">upUniform</a><span class="type-signature"> : <a href="UniformNode.html">UniformNode</a>.&lt;vec3></span> </h3>
  94. <div class="description">
  95. <p>The up position.</p>
  96. </div>
  97. </div>
  98. <h2 class="subsection-title">Source</h2>
  99. <p>
  100. <a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/objects/SkyMesh.js" translate="no" target="_blank" rel="noopener">examples/jsm/objects/SkyMesh.js</a>
  101. </p>
  102. </article>
  103. </section>
  104. <script src="../scripts/linenumber.js"></script>
  105. <script src="../scripts/page.js"></script>
  106. </body>
  107. </html>
粤ICP备19079148号