File: LineDashedMaterial.html

package info (click to toggle)
three.js 111%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 15,184 kB
  • sloc: javascript: 133,174; makefile: 24; sh: 1
file content (88 lines) | stat: -rw-r--r-- 2,463 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<base href="../../../" />
		<script src="list.js"></script>
		<script src="page.js"></script>
		<link type="text/css" rel="stylesheet" href="page.css" />
	</head>
	<body>
		[page:Material] &rarr;

		<h1>[name]</h1>

		<p class="desc">A material for drawing wireframe-style geometries with dashed lines.</p>

		<h2>Examples</h2>

		<p>
			[example:webgl_lines_dashed WebGL / lines / dashed]<br />
		</p>

		<code>
var material = new THREE.LineDashedMaterial( {
	color: 0xffffff,
	linewidth: 1,
	scale: 1,
	dashSize: 3,
	gapSize: 1,
} );
		</code>

		<h2>Constructor</h2>


		<h3>[name]( [param:Object parameters] )</h3>
		<p>
		[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 i	as a hexadecimal
		string and is *0xffffff* (white) by default. [page:Color.set]( color ) is called internally.
		</p>


		<h2>Properties</h2>
		<p>See the base [page:Material] class for common properties.</p>

		<h3>[property:Color color]</h3>
		<p>[page:Color] of the material, by default set to white (0xffffff).</p>

		<h3>[property:number dashSize]</h3>
		<p>The size of the dash. This is both the gap with the stroke. Default is *3*.</p>

		<h3>[property:number gapSize]</h3>
		<p>The size of the gap. Default is *1*.</p>

		<h3>[property:Boolean isLineDashedMaterial]</h3>
		<p>
			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.
		</p>

		<h3>[property:Float linewidth]</h3>
		<p>
			Controls line thickness. Default is *1*.<br /><br />

			Due to limitations of the [link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf OpenGL Core Profile]
			with the [page:WebGLRenderer WebGL] renderer on most platforms linewidth will
			always be 1 regardless of the set value.
		</p>

		<h3>[property:number scale]</h3>
		<p>The scale of the dashed part of a line. Default is *1*.</p>

		<h2>Methods</h2>
		<p>See the base [page:Material] class for common methods.</p>



		<h2>Source</h2>

		<p>
			[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
		</p>
	</body>
</html>