Fog.html 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  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 linear fog, i.e., that grows linearly denser with the distance.</p>
  12. <h2>Constructor</h2>
  13. <h3>[name]( [param:Integer color], [param:Float near], [param:Float far] )</h3>
  14. <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>
  15. <h2>Properties</h2>
  16. <h3>[property:String name]</h3>
  17. <p>Optional name of the object (doesn't need to be unique). Default is an empty string.</p>
  18. <h3>[property:Color color]</h3>
  19. <p>Fog color. Example: If set to black, far away objects will be rendered black.</p>
  20. <h3>[property:Float near]</h3>
  21. <p>The minimum distance to start applying fog. Objects that are less than 'near' units from the active camera won't be affected by fog.</p>
  22. <p>Default is 1.</p>
  23. <h3>[property:Float far]</h3>
  24. <p>The maximum distance at which fog stops being calculated and applied. Objects that are more than 'far' units away from the active camera won't be affected by fog.</p>
  25. <p>Default is 1000.</p>
  26. <h2>Methods</h2>
  27. <h3>[method:Fog clone]()</h3>
  28. <p>Returns a new fog instance with the same parameters as this one.</p>
  29. <h3>[method:Fog toJSON]()</h3>
  30. <p>Return fog data in JSON format.</p>
  31. <h2>Source</h2>
  32. <p>
  33. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  34. </p>
  35. </body>
  36. </html>