Scene.html 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  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;
  11. <h1>[name]</h1>
  12. <p class="desc">Scenes allow you to set up what and where is to be rendered by three.js. This is where you place objects, lights and cameras.</p>
  13. <h2>Constructor</h2>
  14. <h3>[name]()</h3>
  15. <p>
  16. Create a new scene object.
  17. </p>
  18. <h2>Properties</h2>
  19. <h3>[property:Object background]</h3>
  20. <p>
  21. Defines the background of the scene. Default is `null`. Valid inputs are:
  22. <ul>
  23. <li>A [page:Color] for defining a uniform colored background.</li>
  24. <li>A [page:Texture] for defining a (flat) textured background.</li>
  25. <li>Texture cubes ([page:CubeTexture]) or equirectangular textures for defining a skybox.</li>
  26. </ul>
  27. Note: Any camera related configurations like `zoom` or `view` are ignored.
  28. </p>
  29. <h3>[property:Float backgroundBlurriness]</h3>
  30. <p>
  31. Sets the blurriness of the background. Only influences environment maps assigned to [page:Scene.background]. Valid input is a float between *0* and *1*. Default is *0*.
  32. </p>
  33. <h3>[property:Texture environment]</h3>
  34. <p>
  35. Sets the environment map for all physical materials in the scene.
  36. However, it's not possible to overwrite an existing texture assigned to [page:MeshStandardMaterial.envMap]. Default is `null`.
  37. </p>
  38. <h3>[property:Fog fog]</h3>
  39. <p>A [page:Fog fog] instance defining the type of fog that affects everything rendered in the scene. Default is `null`.</p>
  40. <h3>[property:Boolean isScene]</h3>
  41. <p>
  42. Read-only flag to check if a given object is of type [name].
  43. </p>
  44. <h3>[property:Material overrideMaterial]</h3>
  45. <p>Forces everything in the scene to be rendered with the defined material. Default is `null`.</p>
  46. <h2>Methods</h2>
  47. <h3>[method:Object toJSON]( [param:Object meta] )</h3>
  48. <p>
  49. meta -- object containing metadata such as textures or images for the scene.<br />
  50. Convert the scene to three.js [link:https://github.com/mrdoob/three.js/wiki/JSON-Object-Scene-format-4 JSON Object/Scene format].
  51. </p>
  52. <h2>Source</h2>
  53. <p>
  54. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  55. </p>
  56. </body>
  57. </html>