FogExp2.html 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  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. <h1>[name]</h1>
  11. <p class="desc">This class contains the parameters that define exponential squared fog, which gives a clear view near the camera and a faster than exponentially densening fog farther from the camera.</p>
  12. <h2>Code Example</h2>
  13. <code>const scene = new THREE.Scene();
  14. scene.fog = new THREE.FogExp2( 0xcccccc, 0.002 );
  15. </code>
  16. <h2>Constructor</h2>
  17. <h3>[name]( [param:Integer color], [param:Float density] )</h3>
  18. <p>The color parameter is passed to the [page:Color] constructor to set the color property. Color can be a hexadecimal integer or a CSS-style string.</p>
  19. <h2>Properties</h2>
  20. <h3>[property:Boolean isFogExp2]</h3>
  21. <p>
  22. Read-only flag to check if a given object is of type [name].
  23. </p>
  24. <h3>[property:String name]</h3>
  25. <p>Optional name of the object (doesn't need to be unique). Default is an empty string.</p>
  26. <h3>[property:Color color]</h3>
  27. <p>Fog color. Example: If set to black, far away objects will be rendered black.</p>
  28. <h3>[property:Float density]</h3>
  29. <p>Defines how fast the fog will grow dense.</p>
  30. <p>Default is 0.00025.</p>
  31. <h2>Methods</h2>
  32. <h3>[method:FogExp2 clone]()</h3>
  33. <p>Returns a new FogExp2 instance with the same parameters as this one.</p>
  34. <h3>[method:Object toJSON]()</h3>
  35. <p>Return FogExp2 data in JSON format.</p>
  36. <h2>Source</h2>
  37. <p>
  38. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  39. </p>
  40. </body>
  41. </html>