Scene.html 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  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">
  13. Scenes allow you to set up what and where is to be rendered by three.js.
  14. This is where you place objects, lights and cameras.
  15. </p>
  16. <h2>Constructor</h2>
  17. <h3>[name]()</h3>
  18. <p>Create a new scene object.</p>
  19. <h2>Properties</h2>
  20. <h3>[property:Object background]</h3>
  21. <p>
  22. Defines the background of the scene. Default is `null`. Valid inputs are:
  23. </p>
  24. <ul>
  25. <li>A [page:Color] for defining a uniform colored background.</li>
  26. <li>A [page:Texture] for defining a (flat) textured background.</li>
  27. <li>
  28. Texture cubes ([page:CubeTexture]) or equirectangular textures for
  29. defining a skybox.
  30. </li>
  31. </ul>
  32. Note: Any camera related configurations like `zoom` or `view` are ignored.
  33. <h3>[property:Float backgroundBlurriness]</h3>
  34. <p>
  35. Sets the blurriness of the background. Only influences environment maps
  36. assigned to [page:Scene.background]. Valid input is a float between `0`
  37. and `1`. Default is `0`.
  38. </p>
  39. <h3>[property:Float backgroundIntensity]</h3>
  40. <p>
  41. Attenuates the color of the background. Only applies to background
  42. textures. Default is `1`.
  43. </p>
  44. <h3>[property:Euler backgroundRotation]</h3>
  45. <p>
  46. The rotation of the background in radians. Only influences environment maps
  47. assigned to [page:Scene.background]. Default is `(0,0,0)`.
  48. </p>
  49. <h3>[property:Texture environment]</h3>
  50. <p>
  51. Sets the environment map for all physical materials in the scene. However,
  52. it's not possible to overwrite an existing texture assigned to
  53. [page:MeshStandardMaterial.envMap]. Default is `null`.
  54. </p>
  55. <h3>[property:Float environmentIntensity]</h3>
  56. <p>
  57. Attenuates the color of the environment. Only influences environment maps
  58. assigned to [page:Scene.environment]. Default is `1`.
  59. </p>
  60. <h3>[property:Euler environmentRotation]</h3>
  61. <p>
  62. The rotation of the environment map in radians. Only influences physical materials
  63. in the scene when [page:.environment] is used. Default is `(0,0,0)`.
  64. </p>
  65. <h3>[property:Fog fog]</h3>
  66. <p>
  67. A [page:Fog fog] instance defining the type of fog that affects everything
  68. rendered in the scene. Default is `null`.
  69. </p>
  70. <h3>[property:Boolean isScene]</h3>
  71. <p>Read-only flag to check if a given object is of type [name].</p>
  72. <h3>[property:Material overrideMaterial]</h3>
  73. <p>
  74. Forces everything in the scene to be rendered with the defined material.
  75. Default is `null`.
  76. </p>
  77. <h2>Methods</h2>
  78. <h3>[method:Object toJSON]( [param:Object meta] )</h3>
  79. <p>
  80. meta -- object containing metadata such as textures or images for the
  81. scene.<br />
  82. Convert the scene to three.js
  83. [link:https://github.com/mrdoob/three.js/wiki/JSON-Object-Scene-format-4 JSON Object/Scene format].
  84. </p>
  85. <h2>Source</h2>
  86. <p>
  87. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  88. </p>
  89. </body>
  90. </html>