|
@@ -12,11 +12,11 @@
|
|
|
|
|
|
<h1>[name]</h1>
|
|
|
|
|
|
- <div class="desc">
|
|
|
+ <p class="desc">
|
|
|
Helper object to assist with visualizing a [page:DirectionalLight]'s effect on the scene.
|
|
|
|
|
|
This consists of plane and a line representing the light's position and direction.
|
|
|
- </div>
|
|
|
+ </p>
|
|
|
|
|
|
<h2>Example</h2>
|
|
|
|
|
@@ -33,50 +33,50 @@
|
|
|
|
|
|
|
|
|
<h3>[name]( [param:DirectionalLight light], [param:Number size], [param:Hex color] )</h3>
|
|
|
- <div>
|
|
|
+ <p>
|
|
|
[page:DirectionalLight light]-- The light to be visualized. <br /><br />
|
|
|
|
|
|
[page:Number size] -- (optional) dimensions of the plane. Default is *1*.<br /><br />
|
|
|
|
|
|
[page:Hex color] -- (optional) if this is not the set the helper will take the color of the light.
|
|
|
- </div>
|
|
|
+ </p>
|
|
|
|
|
|
|
|
|
<h2>Properties</h2>
|
|
|
- <div>See the base [page:Object3D] class for common properties.</div>
|
|
|
+ <p>See the base [page:Object3D] class for common properties.</p>
|
|
|
|
|
|
|
|
|
<h3>[property:Line lightPlane]</h3>
|
|
|
- <div>Contains the line mesh showing the location of the directional light.</div>
|
|
|
+ <p>Contains the line mesh showing the location of the directional light.</p>
|
|
|
|
|
|
<h3>[property:DirectionalLight light]</h3>
|
|
|
- <div>Reference to the [page:DirectionalLight directionalLight] being visualized.</div>
|
|
|
+ <p>Reference to the [page:DirectionalLight directionalLight] being visualized.</p>
|
|
|
|
|
|
<h3>[property:object matrix]</h3>
|
|
|
- <div>Reference to the light's [page:Object3D.matrixWorld matrixWorld].</div>
|
|
|
+ <p>Reference to the light's [page:Object3D.matrixWorld matrixWorld].</p>
|
|
|
|
|
|
<h3>[property:object matrixAutoUpdate]</h3>
|
|
|
- <div>
|
|
|
+ <p>
|
|
|
See [page:Object3D.matrixAutoUpdate]. Set to *false* here as the helper is using the
|
|
|
light's [page:Object3D.matrixWorld matrixWorld].
|
|
|
- </div>
|
|
|
+ </p>
|
|
|
|
|
|
<h3>[property:hex color]</h3>
|
|
|
- <div>
|
|
|
+ <p>
|
|
|
The color parameter passed in the constructor. Default is *undefined*. If this is changed,
|
|
|
the helper's color will update the next time [page:.update update] is called.
|
|
|
- </div>
|
|
|
+ </p>
|
|
|
|
|
|
|
|
|
<h2>Methods</h2>
|
|
|
- <div>See the base [page:Object3D] class for common properties.</div>
|
|
|
+ <p>See the base [page:Object3D] class for common properties.</p>
|
|
|
|
|
|
<h3>[method:null dispose]()</h3>
|
|
|
- <div>Dispose of the directionalLightHelper.</div>
|
|
|
+ <p>Dispose of the directionalLightHelper.</p>
|
|
|
|
|
|
|
|
|
<h3>[method:null update]()</h3>
|
|
|
- <div>Updates the helper to match the position and direction of the [page:.light directionalLight] being visualized.</div>
|
|
|
+ <p>Updates the helper to match the position and direction of the [page:.light directionalLight] being visualized.</p>
|
|
|
|
|
|
<h2>Source</h2>
|
|
|
|