You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

111 lines
3.1 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../../" />
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
[page:Object3D] &rarr;
<h1>[name]</h1>
<p class="desc">
Scenes allow you to set up what is to be rendered and where by three.js.
This is where you place objects, lights and cameras.
</p>
<h2>Constructor</h2>
<h3>[name]()</h3>
<p>Create a new scene object.</p>
<h2>Properties</h2>
<h3>[property:Object background]</h3>
<p>
Defines the background of the scene. Default is `null`. Valid inputs are:
</p>
<ul>
<li>A [page:Color] for defining a uniform colored background.</li>
<li>A [page:Texture] for defining a (flat) textured background.</li>
<li>
Texture cubes ([page:CubeTexture]) or equirectangular textures for
defining a skybox.
</li>
</ul>
Note: Any camera related configurations like `zoom` or `view` are ignored.
<h3>[property:Float backgroundBlurriness]</h3>
<p>
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`.
</p>
<h3>[property:Float backgroundIntensity]</h3>
<p>
Attenuates the color of the background. Only applies to background
textures. Default is `1`.
</p>
<h3>[property:Euler backgroundRotation]</h3>
<p>
The rotation of the background in radians. Only influences environment maps
assigned to [page:Scene.background]. Default is `(0,0,0)`.
</p>
<h3>[property:Texture environment]</h3>
<p>
Sets the environment map for all physical materials in the scene. However,
it's not possible to overwrite an existing texture assigned to
[page:MeshStandardMaterial.envMap]. Default is `null`.
</p>
<h3>[property:Float environmentIntensity]</h3>
<p>
Attenuates the color of the environment. Only influences environment maps
assigned to [page:Scene.environment]. Default is `1`.
</p>
<h3>[property:Euler environmentRotation]</h3>
<p>
The rotation of the environment map in radians. Only influences physical materials
in the scene when [page:.environment] is used. Default is `(0,0,0)`.
</p>
<h3>[property:Fog fog]</h3>
<p>
A [page:Fog fog] instance defining the type of fog that affects everything
rendered in the scene. Default is `null`.
</p>
<h3>[property:Boolean isScene]</h3>
<p>Read-only flag to check if a given object is of type [name].</p>
<h3>[property:Material overrideMaterial]</h3>
<p>
Forces everything in the scene to be rendered with the defined material.
Default is `null`.
</p>
<h2>Methods</h2>
<h3>[method:Object toJSON]( [param:Object meta] )</h3>
<p>
meta -- object containing metadata such as textures or images for the
scene.<br />
Convert the scene to three.js
[link:https://github.com/mrdoob/three.js/wiki/JSON-Object-Scene-format-4 JSON Object/Scene format].
</p>
<h2>Source</h2>
<p>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</p>
</body>
</html>