|
@@ -12,9 +12,9 @@
|
|
<h1>[name]</h1>
|
|
<h1>[name]</h1>
|
|
|
|
|
|
<p 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.
|
|
|
|
|
|
+ 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.
|
|
</p>
|
|
</p>
|
|
|
|
|
|
<h2>Code Example</h2>
|
|
<h2>Code Example</h2>
|
|
@@ -27,54 +27,60 @@
|
|
|
|
|
|
<h2>Constructor</h2>
|
|
<h2>Constructor</h2>
|
|
|
|
|
|
-
|
|
|
|
- <h3>[name]( [param:DirectionalLight light], [param:Number size], [param:Hex color] )</h3>
|
|
|
|
|
|
+ <h3>
|
|
|
|
+ [name]( [param:DirectionalLight light], [param:Number size], [param:Hex color] )
|
|
|
|
+ </h3>
|
|
<p>
|
|
<p>
|
|
[page:DirectionalLight light]-- The light to be visualized. <br /><br />
|
|
[page:DirectionalLight light]-- The light to be visualized. <br /><br />
|
|
|
|
|
|
- [page:Number size] -- (optional) dimensions of the plane. Default is `1`.<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.
|
|
|
|
|
|
+ [page:Hex color] -- (optional) if this is not the set the helper will take
|
|
|
|
+ the color of the light.
|
|
</p>
|
|
</p>
|
|
|
|
|
|
-
|
|
|
|
<h2>Properties</h2>
|
|
<h2>Properties</h2>
|
|
<p>See the base [page:Object3D] class for common properties.</p>
|
|
<p>See the base [page:Object3D] class for common properties.</p>
|
|
|
|
|
|
-
|
|
|
|
<h3>[property:Line lightPlane]</h3>
|
|
<h3>[property:Line lightPlane]</h3>
|
|
<p>Contains the line mesh showing the location of the directional light.</p>
|
|
<p>Contains the line mesh showing the location of the directional light.</p>
|
|
|
|
|
|
<h3>[property:DirectionalLight light]</h3>
|
|
<h3>[property:DirectionalLight light]</h3>
|
|
- <p>Reference to the [page:DirectionalLight directionalLight] being visualized.</p>
|
|
|
|
|
|
+ <p>
|
|
|
|
+ Reference to the [page:DirectionalLight directionalLight] being
|
|
|
|
+ visualized.
|
|
|
|
+ </p>
|
|
|
|
|
|
<h3>[property:Object matrix]</h3>
|
|
<h3>[property:Object matrix]</h3>
|
|
<p>Reference to the light's [page:Object3D.matrixWorld matrixWorld].</p>
|
|
<p>Reference to the light's [page:Object3D.matrixWorld matrixWorld].</p>
|
|
|
|
|
|
<h3>[property:Object matrixAutoUpdate]</h3>
|
|
<h3>[property:Object matrixAutoUpdate]</h3>
|
|
<p>
|
|
<p>
|
|
- See [page:Object3D.matrixAutoUpdate]. Set to `false` here as the helper is using the
|
|
|
|
- light's [page:Object3D.matrixWorld matrixWorld].
|
|
|
|
|
|
+ See [page:Object3D.matrixAutoUpdate]. Set to `false` here as the helper is
|
|
|
|
+ using the light's [page:Object3D.matrixWorld matrixWorld].
|
|
</p>
|
|
</p>
|
|
|
|
|
|
<h3>[property:hex color]</h3>
|
|
<h3>[property:hex color]</h3>
|
|
<p>
|
|
<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.
|
|
|
|
|
|
+ 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.
|
|
</p>
|
|
</p>
|
|
|
|
|
|
-
|
|
|
|
<h2>Methods</h2>
|
|
<h2>Methods</h2>
|
|
<p>See the base [page:Object3D] class for common properties.</p>
|
|
<p>See the base [page:Object3D] class for common properties.</p>
|
|
|
|
|
|
<h3>[method:undefined dispose]()</h3>
|
|
<h3>[method:undefined dispose]()</h3>
|
|
<p>
|
|
<p>
|
|
- Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.
|
|
|
|
|
|
+ Frees the GPU-related resources allocated by this instance. Call this
|
|
|
|
+ method whenever this instance is no longer used in your app.
|
|
</p>
|
|
</p>
|
|
|
|
|
|
-
|
|
|
|
<h3>[method:undefined update]()</h3>
|
|
<h3>[method:undefined update]()</h3>
|
|
- <p>Updates the helper to match the position and direction of the [page:.light directionalLight] being visualized.</p>
|
|
|
|
|
|
+ <p>
|
|
|
|
+ Updates the helper to match the position and direction of the [page:.light directionalLight] being visualized.
|
|
|
|
+ </p>
|
|
|
|
|
|
<h2>Source</h2>
|
|
<h2>Source</h2>
|
|
|
|
|