|
@@ -14,57 +14,68 @@
|
|
|
|
|
|
<div class="desc">A material for drawing wireframe-style geometries with dashed lines.</div>
|
|
<div class="desc">A material for drawing wireframe-style geometries with dashed lines.</div>
|
|
|
|
|
|
|
|
+ <h2>Examples</h2>
|
|
|
|
+
|
|
|
|
+ <div>
|
|
|
|
+ [example:webgl_lines_dashed WebGL / lines / dashed]<br />
|
|
|
|
+ [example:canvas_lines_dashed Canvas / lines /dashed]
|
|
|
|
+ </div>
|
|
|
|
+
|
|
|
|
+ <code>
|
|
|
|
+var material = new THREE.LineDashedMaterial( {
|
|
|
|
+ color: 0xffffff,
|
|
|
|
+ lineWidth: 1,
|
|
|
|
+ scale: 1,
|
|
|
|
+ dashSize: 3,
|
|
|
|
+ gapSize: 1,
|
|
|
|
+} );
|
|
|
|
+ </code>
|
|
|
|
|
|
<h2>Constructor</h2>
|
|
<h2>Constructor</h2>
|
|
|
|
|
|
|
|
|
|
<h3>[name]( [page:Object parameters] )</h3>
|
|
<h3>[name]( [page:Object parameters] )</h3>
|
|
- <div>parameters is an object with one or more properties defining the material's appearance.</div>
|
|
|
|
- <div>
|
|
|
|
- color — Line color in hexadecimal. Default is 0xffffff.<br />
|
|
|
|
- linewidth — Line thickness. Default is 1.<br />
|
|
|
|
- scale — The scale of the dashed part of a line. Default is 1.<br />
|
|
|
|
- dashSize — The size of the dash. Default is 3.<br />
|
|
|
|
- gapSize - The size of the gap. Default is 1.<br />
|
|
|
|
- vertexColors — Define how the vertices gets colored. Default is THREE.NoColors.<br />
|
|
|
|
- fog — Define whether the material color is affected by global fog settings. Default is false.
|
|
|
|
|
|
+ [page:Object parameters] - (optional) an object with one or more properties defining the material's appearance.
|
|
|
|
+ Any property of the material (including any property inherited from [page:Material]) can be passed in here.<br /><br />
|
|
|
|
+
|
|
|
|
+ The exception is the property [page:Hexadecimal color], which can be passed in as a hexadecimal string and is *0xffffff* (white) by default.<br />
|
|
|
|
+ [page:Color.set]( color ) is called internally.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h2>Properties</h2>
|
|
<h2>Properties</h2>
|
|
<div>See the base [page:Material] class for common properties.</div>
|
|
<div>See the base [page:Material] class for common properties.</div>
|
|
|
|
|
|
- <h3>[property:Color color]</h3>
|
|
|
|
- <div>
|
|
|
|
- Sets the color of the line. Default is 0xffffff.
|
|
|
|
- </div>
|
|
|
|
|
|
+ <h3>[property:Integer color]</h3>
|
|
|
|
+ <div>[page:Color] of the material, by default set to white (0xffffff).</div>
|
|
|
|
|
|
- <h3>[property:number linewidth]</h3>
|
|
|
|
- <div>Controls line thickness. Default is 1.</div>
|
|
|
|
- <div>Due to limitations in the <a href="https://code.google.com/p/angleproject/" target="_blank">ANGLE layer</a>, on Windows platforms linewidth will always be 1 regardless of the set value.</div>
|
|
|
|
|
|
+ <h3>[property:number dashSize]</h3>
|
|
|
|
+ <div>The size of the dash. This is both the gap with the stroke. Default is *3*.</div>
|
|
|
|
|
|
- <h3>[property:number scale]</h3>
|
|
|
|
- <div>
|
|
|
|
- The scale of the dashed part of a line.
|
|
|
|
- </div>
|
|
|
|
|
|
+ <h3>[property:number gapSize]</h3>
|
|
|
|
+ <div>The size of the gap. Default is *1*.</div>
|
|
|
|
|
|
- <h3>[property:number dashSize]</h3>
|
|
|
|
|
|
+ <h3>[property:Boolean isLineDashedMaterial]</h3>
|
|
<div>
|
|
<div>
|
|
- The size of the dash. This is both the gap with the stroke. Default is 3.
|
|
|
|
|
|
+ Used to check whether this or derived classes are line dashed materials. Default is *true*.<br /><br />
|
|
|
|
+
|
|
|
|
+ You should not change this, as it used internally for optimisation.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
- <h3>[property:number gapSize]</h3>
|
|
|
|
|
|
+ <h3>[property:Boolean lights]</h3>
|
|
|
|
+ <div>Whether the material is affected by lights. Default is *false*.</div>
|
|
|
|
+
|
|
|
|
+ <h3>[property:Float linewidth]</h3>
|
|
<div>
|
|
<div>
|
|
- The size of the gap. Default is 1.
|
|
|
|
- </div>
|
|
|
|
|
|
+ Controls line thickness. Default is *1*.<br /><br />
|
|
|
|
|
|
- <h3>[property:boolean vertexColors]</h3>
|
|
|
|
- <div>Define how the vertices gets colored. Possible values are THREE.NoColors, THREE.FaceColors and THREE.VertexColors. Default is THREE.NoColors.</div>
|
|
|
|
- <div>This setting might not have any effect when used with certain renderers.</div>
|
|
|
|
|
|
+ Due to limitations in the [link:https://code.google.com/p/angleproject ANGLE layer],
|
|
|
|
+ with the [page:WebGLRenderer WebGL] renderer on Windows platforms linewidth will
|
|
|
|
+ always be 1 regardless of the set value.
|
|
|
|
+ </div>
|
|
|
|
|
|
- <h3>[property:boolean fog]</h3>
|
|
|
|
- <div>Define whether the material color is affected by global fog settings.</div>
|
|
|
|
- <div>This setting might not have any effect when used with certain renderers. For example, it is ignored with the [page:CanvasRenderer Canvas] renderer, but does work with the [page:WebGLRenderer WebGL] renderer.</div>
|
|
|
|
|
|
+ <h3>[property:number scale]</h3>
|
|
|
|
+ <div>The scale of the dashed part of a line. Default is *1*.</div>
|
|
|
|
|
|
<h2>Methods</h2>
|
|
<h2>Methods</h2>
|
|
|
|
|