|
@@ -12,7 +12,7 @@
|
|
|
|
|
|
<h1>[name]</h1>
|
|
<h1>[name]</h1>
|
|
|
|
|
|
- <div class="desc">An 3D arrow object for visualizing directions.</div>
|
|
|
|
|
|
+ <p class="desc">An 3D arrow object for visualizing directions.</p>
|
|
|
|
|
|
|
|
|
|
<h2>Example</h2>
|
|
<h2>Example</h2>
|
|
@@ -41,55 +41,55 @@
|
|
|
|
|
|
|
|
|
|
<h3>[name]([param:Vector3 dir], [param:Vector3 origin], [param:Number length], [param:Number hex], [param:Number headLength], [param:Number headWidth] )</h3>
|
|
<h3>[name]([param:Vector3 dir], [param:Vector3 origin], [param:Number length], [param:Number hex], [param:Number headLength], [param:Number headWidth] )</h3>
|
|
- <div>
|
|
|
|
|
|
+ <p>
|
|
[page:Vector3 dir] -- direction from origin. Must be a unit vector. <br />
|
|
[page:Vector3 dir] -- direction from origin. Must be a unit vector. <br />
|
|
[page:Vector3 origin] -- Point at which the arrow starts.<br />
|
|
[page:Vector3 origin] -- Point at which the arrow starts.<br />
|
|
[page:Number length] -- length of the arrow. Default is *1*.<br />
|
|
[page:Number length] -- length of the arrow. Default is *1*.<br />
|
|
[page:Number hex] -- hexadecimal value to define color. Default is 0xffff00.<br />
|
|
[page:Number hex] -- hexadecimal value to define color. Default is 0xffff00.<br />
|
|
[page:Number headLength] -- The length of the head of the arrow. Default is 0.2 * length.<br />
|
|
[page:Number headLength] -- The length of the head of the arrow. Default is 0.2 * length.<br />
|
|
[page:Number headWidth] -- The length of the width of the arrow. Default is 0.2 * headLength.
|
|
[page:Number headWidth] -- The length of the width of the arrow. Default is 0.2 * headLength.
|
|
- </div>
|
|
|
|
|
|
+ </p>
|
|
|
|
|
|
<h2>Properties</h2>
|
|
<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 line]</h3>
|
|
<h3>[property:Line line]</h3>
|
|
- <div>Contains the line part of the arrowHelper.</div>
|
|
|
|
|
|
+ <p>Contains the line part of the arrowHelper.</p>
|
|
|
|
|
|
<h3>[property:Mesh cone]</h3>
|
|
<h3>[property:Mesh cone]</h3>
|
|
- <div>Contains the cone part of the arrowHelper.</div>
|
|
|
|
|
|
+ <p>Contains the cone part of the arrowHelper.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Methods</h2>
|
|
<h2>Methods</h2>
|
|
- <div>See the base [page:Object3D] class for common methods.</div>
|
|
|
|
|
|
+ <p>See the base [page:Object3D] class for common methods.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>[method:null setColor]([param:Number hex])</h3>
|
|
<h3>[method:null setColor]([param:Number hex])</h3>
|
|
- <div>
|
|
|
|
|
|
+ <p>
|
|
hex -- The hexadecimal value of the color.<br /><br />
|
|
hex -- The hexadecimal value of the color.<br /><br />
|
|
|
|
|
|
Sets the color of the arrowHelper.
|
|
Sets the color of the arrowHelper.
|
|
- </div>
|
|
|
|
|
|
+ </p>
|
|
|
|
|
|
<h3>[method:null setLength]([param:Number length], [param:Number headLength], [param:Number headWidth])</h3>
|
|
<h3>[method:null setLength]([param:Number length], [param:Number headLength], [param:Number headWidth])</h3>
|
|
- <div>
|
|
|
|
|
|
+ <p>
|
|
length -- The desired length.<br />
|
|
length -- The desired length.<br />
|
|
headLength -- The length of the head of the arrow.<br />
|
|
headLength -- The length of the head of the arrow.<br />
|
|
headWidth -- The length of the width of the arrow.<br /><br />
|
|
headWidth -- The length of the width of the arrow.<br /><br />
|
|
|
|
|
|
Sets the length of the arrowhelper.
|
|
Sets the length of the arrowhelper.
|
|
- </div>
|
|
|
|
|
|
+ </p>
|
|
|
|
|
|
<h3>[method:null setDirection]([param:Vector3 dir])</h3>
|
|
<h3>[method:null setDirection]([param:Vector3 dir])</h3>
|
|
- <div>
|
|
|
|
|
|
+ <p>
|
|
dir -- The desired direction. Must be a unit vector.<br /><br />
|
|
dir -- The desired direction. Must be a unit vector.<br /><br />
|
|
|
|
|
|
Sets the direction of the arrowhelper.
|
|
Sets the direction of the arrowhelper.
|
|
- </div>
|
|
|
|
|
|
+ </p>
|
|
|
|
|
|
<h2>Source</h2>
|
|
<h2>Source</h2>
|
|
|
|
|