Skip to content

Commit f754df4

Browse files
weiserheimrdoob
authored andcommitted
update grid helper docs (mrdoob#8946)
removed `setColors` method and added them to the constructor
1 parent 4dee35a commit f754df4

File tree

1 file changed

+45
-55
lines changed

1 file changed

+45
-55
lines changed
Lines changed: 45 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,46 @@
1-
<!DOCTYPE html>
2-
<html lang="en">
3-
<head>
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
44
<meta charset="utf-8" />
5-
<base href="../../../" />
6-
<script src="list.js"></script>
7-
<script src="page.js"></script>
8-
<link type="text/css" rel="stylesheet" href="page.css" />
9-
</head>
10-
<body>
11-
[page:Line] &rarr;
12-
13-
<h1>[name]</h1>
14-
15-
<div class="desc">The GridHelper is an object to define grids. Grids are two-dimensional arrays of lines.</div>
16-
17-
18-
<h2>Example</h2>
19-
20-
<code>var size = 10;
21-
var step = 1;
22-
23-
var gridHelper = new THREE.GridHelper( size, step );
24-
scene.add( gridHelper );
25-
</code>
26-
[example:webgl_helpers Example using various helpers]
27-
28-
29-
<h2>Constructor</h2>
30-
31-
<h3>[name]([page:number size], [page:Number step])</h3>
32-
<div>
33-
size -- The size of the grid <br />
34-
step -- The size of the step between 2 lines
35-
</div>
36-
<div>
37-
Creates a new [name] of size 'size' and with steps of size 'step'.
38-
</div>
39-
40-
<h2>Methods</h2>
41-
42-
<h3>[method:null setColors]([page:number colorCenterLine], [page:Number colorGrid])</h3>
43-
<div>
44-
colorCenterLine -- The color of the centerline. This can be a [page:Color], a hexadecimal value and an CSS-Color name. <br />
45-
colorGrid -- The color of the lines of the grid. This can be a [page:Color], a hexadecimal value and an CSS-Color name.
46-
</div>
47-
<div>
48-
Updates the color of the grid lines.
49-
</div>
50-
51-
52-
<h2>Source</h2>
53-
54-
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
55-
</body>
56-
</html>
5+
<base href="../../../" />
6+
<script src="list.js"></script>
7+
<script src="page.js"></script>
8+
<link type="text/css" rel="stylesheet" href="page.css" />
9+
</head>
10+
<body>
11+
[page:Line] &rarr;
12+
13+
<h1>[name]</h1>
14+
15+
<div class="desc">The GridHelper is an object to define grids. Grids are two-dimensional arrays of lines.</div>
16+
17+
18+
<h2>Example</h2>
19+
20+
<code>var size = 10;
21+
var step = 1;
22+
23+
var gridHelper = new THREE.GridHelper( size, step );
24+
scene.add( gridHelper );
25+
</code>
26+
[example:webgl_helpers Example using various helpers]
27+
28+
29+
<h2>Constructor</h2>
30+
31+
<h3>[name]( [page:number size], [page:Number step], [page:Color colorCenterLine], [page:Color colorGrid] )</h3>
32+
<div>
33+
size -- The size of the grid <br />
34+
step -- The size of the step between 2 lines <br />
35+
colorCenterLine -- The color of the centerline. This can be a [page:Color], a hexadecimal value and an CSS-Color name. Default is 0x444444 <br />
36+
colorGrid -- The color of the lines of the grid. This can be a [page:Color], a hexadecimal value and an CSS-Color name. Default is 0x888888
37+
</div>
38+
<div>
39+
Creates a new [name] of size 'size' and with steps of size 'step'. Colors are optional.
40+
</div>
41+
42+
<h2>Source</h2>
43+
44+
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
45+
</body>
46+
</html>

0 commit comments

Comments
 (0)