|
@@ -12,47 +12,61 @@
|
|
|
|
|
|
<h1>[name]</h1>
|
|
|
|
|
|
- <div class="desc">Visualize a [page:DirectionalLight]'s effect on the scene</div>
|
|
|
+ <div class="desc">Helper object to assist with visualizing a [page:DirectionalLight]'s effect on the scene.</div>
|
|
|
+
|
|
|
+ <h2>Example</h2>
|
|
|
+
|
|
|
+ <code>
|
|
|
+ var light = new THREE.DirectionalLight( 0xFFFFFF );
|
|
|
+
|
|
|
+ var helper = new THREE.DirectionalLightHelper( light );
|
|
|
+
|
|
|
+ scene.add( helper );
|
|
|
+ </code>
|
|
|
|
|
|
|
|
|
<h2>Constructor</h2>
|
|
|
|
|
|
|
|
|
- <h3>[name]([page:DirectionalLight light], [page:Number size])</h3>
|
|
|
+ <h3>[name]( [page:DirectionalLight light], [page:Number size] )</h3>
|
|
|
<div>
|
|
|
- light -- [page:DirectionalLight] -- Light to visualize <br />
|
|
|
- size -- dimensions of the plane
|
|
|
- </div>
|
|
|
- <div>
|
|
|
- Creates a line and plane to visualize the light's position and direction
|
|
|
+ [page:DirectionalLight light]-- Light to visualize. <br />
|
|
|
+ [page:Number size] -- (optional) dimensions of the plane. Default is *1*.<br /><br />
|
|
|
+
|
|
|
+ Creates a line and plane to visualize the light's position and direction.
|
|
|
</div>
|
|
|
|
|
|
|
|
|
<h2>Properties</h2>
|
|
|
+ <div>See the base [page:Object3D] class for common properties.</div>
|
|
|
|
|
|
|
|
|
<h3>[property:Line lightPlane]</h3>
|
|
|
- <div>
|
|
|
- Contains the line mesh showing the location of the directional light.
|
|
|
- </div>
|
|
|
+ <div>Contains the line mesh showing the location of the directional light.</div>
|
|
|
|
|
|
<h3>[property:DirectionalLight light]</h3>
|
|
|
- <div>
|
|
|
- Contains the directionalLight.
|
|
|
- </div>
|
|
|
+ <div>Contains the directionalLight.</div>
|
|
|
|
|
|
- <h3>[property:Line targetLine]</h3>
|
|
|
+ <h3>[property:object matrix]</h3>
|
|
|
+ <div>Reference to the [page:Object3D.matrixWorld light.matrixWorld].</div>
|
|
|
+
|
|
|
+ <h3>[property:object matrixAutoUpdate]</h3>
|
|
|
<div>
|
|
|
- Contains the line mesh that shows the direction of the light.
|
|
|
+ See [page:Object3D.matrixAutoUpdate]. Set to *false* here as the helper is using the
|
|
|
+ light's [page:Object3D.matrixWorld matrixWorld].
|
|
|
</div>
|
|
|
|
|
|
+
|
|
|
+
|
|
|
<h2>Methods</h2>
|
|
|
+ <div>See the base [page:Object3D] class for common properties.</div>
|
|
|
+
|
|
|
+ <h3>.[method:null dispose]()</h3>
|
|
|
+ <div>Dispose of the directionalLightHelper.</div>
|
|
|
|
|
|
|
|
|
<h3>.[method:null update]()</h3>
|
|
|
- <div>
|
|
|
- Updates the helper to match the position and direction of the [page:.light].
|
|
|
- </div>
|
|
|
+ <div>Updates the helper to match the position and direction of the [page:.light].</div>
|
|
|
|
|
|
<h2>Source</h2>
|
|
|
|