Skip to content

Commit 9a1bd00

Browse files
mrdoobmrdoob
committed
Refactored documentation system. No more XMLHttpRequest.
Now you can browse the docs from the local system too.
1 parent b99c3b9 commit 9a1bd00

126 files changed

Lines changed: 5132 additions & 3650 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/api/cameras/Camera.html‎

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,43 @@
1-
[page:Object3D] →
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<script src="../../list.js"></script>
6+
<script src="../../page.js"></script>
7+
<link type="text/css" rel="stylesheet" href="../../page.css" />
8+
</head>
9+
<body>
10+
[page:Object3D] &rarr;
211

3-
<h1>[name]</h1>
12+
<h1>[name]</h1>
413

5-
<div class="desc">Abstract base class for cameras.</div>
14+
<div class="desc">Abstract base class for cameras.</div>
615

716

8-
<h2>Constructor</h2>
17+
<h2>Constructor</h2>
918

10-
<h3>[name]()</h3>
19+
<h3>[name]()</h3>
1120

1221

13-
<h2>Properties</h2>
22+
<h2>Properties</h2>
1423

15-
<h3>.[page:Matrix4 matrixWorldInverse]</h3>
24+
<h3>.[page:Matrix4 matrixWorldInverse]</h3>
1625

17-
<h3>.[page:Matrix4 projectionMatrix]</h3>
26+
<h3>.[page:Matrix4 projectionMatrix]</h3>
1827

19-
<h3>.[page:Matrix4 projectionMatrixInverse]</h3>
28+
<h3>.[page:Matrix4 projectionMatrixInverse]</h3>
2029

2130

22-
<h2>Methods</h2>
31+
<h2>Methods</h2>
2332

24-
<h3>.lookAt( [page:Vector3 vector] )</h3>
25-
<div>
26-
vector — point to look at<br />
27-
</div>
33+
<h3>.lookAt( [page:Vector3 vector] )</h3>
34+
<div>
35+
vector — point to look at<br />
36+
</div>
2837

2938

30-
<h2>Source</h2>
39+
<h2>Source</h2>
3140

32-
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
41+
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
42+
</body>
43+
</html>

‎docs/api/cameras/OrthographicCamera.html‎

Lines changed: 47 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,69 @@
1-
[page:Object3D] &rarr; [page:Camera] &rarr;
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<script src="../../list.js"></script>
6+
<script src="../../page.js"></script>
7+
<link type="text/css" rel="stylesheet" href="../../page.css" />
8+
</head>
9+
<body>
10+
[page:Object3D] &rarr; [page:Camera] &rarr;
211

3-
<h1>[name]</h1>
12+
<h1>[name]</h1>
413

5-
<div class="desc">Camera with orthographic projection</div>
14+
<div class="desc">Camera with orthographic projection</div>
615

716

8-
<h2>Example</h2>
17+
<h2>Example</h2>
918

10-
<code>var camera = new THREE.OrthographicCamera( width / - 2, width / 2, height / 2, height / - 2, 1, 1000 );
11-
scene.add( camera );
12-
</code>
19+
<code>var camera = new THREE.OrthographicCamera( width / - 2, width / 2, height / 2, height / - 2, 1, 1000 );
20+
scene.add( camera );</code>
1321

1422

15-
<h2>Constructor</h2>
23+
<h2>Constructor</h2>
1624

17-
<h3>[name]( [page:Float left], [page:Float right], [page:Float top], [page:Float bottom], [page:Float near], [page:Float far] )</h3>
18-
<div>
19-
left — Camera frustum left plane.<br />
20-
right — Camera frustum right plane.<br />
21-
top — Camera frustum top plane.<br />
22-
bottom — Camera frustum bottom plane.<br />
23-
near — Camera frustum near plane.<br />
24-
far — Camera frustum far plane.
25-
</div>
25+
<h3>[name]( [page:Float left], [page:Float right], [page:Float top], [page:Float bottom], [page:Float near], [page:Float far] )</h3>
26+
<div>
27+
left — Camera frustum left plane.<br />
28+
right — Camera frustum right plane.<br />
29+
top — Camera frustum top plane.<br />
30+
bottom — Camera frustum bottom plane.<br />
31+
near — Camera frustum near plane.<br />
32+
far — Camera frustum far plane.
33+
</div>
2634

2735

28-
<h2>Properties</h2>
36+
<h2>Properties</h2>
2937

30-
<h3>.[page:Float left]</h3>
31-
<div>Camera frustum left plane.</div>
38+
<h3>.[page:Float left]</h3>
39+
<div>Camera frustum left plane.</div>
3240

33-
<h3>.[page:Float right]</h3>
34-
<div>Camera frustum right plane.</div>
41+
<h3>.[page:Float right]</h3>
42+
<div>Camera frustum right plane.</div>
3543

36-
<h3>.[page:Float top]</h3>
37-
<div>Camera frustum top plane.</div>
44+
<h3>.[page:Float top]</h3>
45+
<div>Camera frustum top plane.</div>
3846

39-
<h3>.[page:Float bottom]</h3>
40-
<div>Camera frustum bottom plane.</div>
47+
<h3>.[page:Float bottom]</h3>
48+
<div>Camera frustum bottom plane.</div>
4149

42-
<h3>.[page:Float near]</h3>
43-
<div>Camera frustum near plane.</div>
50+
<h3>.[page:Float near]</h3>
51+
<div>Camera frustum near plane.</div>
4452

45-
<h3>.[page:Float far]</h3>
46-
<div>Camera frustum far plane.</div>
53+
<h3>.[page:Float far]</h3>
54+
<div>Camera frustum far plane.</div>
4755

4856

49-
<h2>Methods</h2>
57+
<h2>Methods</h2>
5058

51-
<h3>.updateProjectionMatrix()</h3>
52-
<div>
53-
Updates the camera projection matrix. Must be called after change of parameters.
54-
</div>
59+
<h3>.updateProjectionMatrix()</h3>
60+
<div>
61+
Updates the camera projection matrix. Must be called after change of parameters.
62+
</div>
5563

5664

57-
<h2>Source</h2>
65+
<h2>Source</h2>
5866

59-
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
67+
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
68+
</body>
69+
</html>

‎docs/api/cameras/PerspectiveCamera.html‎

Lines changed: 70 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,90 @@
1-
[page:Object3D] &rarr; [page:Camera] &rarr;
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<script src="../../list.js"></script>
6+
<script src="../../page.js"></script>
7+
<link type="text/css" rel="stylesheet" href="../../page.css" />
8+
</head>
9+
<body>
10+
[page:Object3D] &rarr; [page:Camera] &rarr;
211

3-
<h1>[name]</h1>
12+
<h1>[name]</h1>
413

5-
<div class="desc">Camera with perspective projection.</div>
14+
<div class="desc">Camera with perspective projection.</div>
615

716

8-
<h2>Example</h2>
17+
<h2>Example</h2>
918

10-
<code>var camera = new THREE.PerspectiveCamera( 45, width / height, 1, 1000 );
11-
scene.add( camera );
12-
</code>
19+
<code>var camera = new THREE.PerspectiveCamera( 45, width / height, 1, 1000 );
20+
scene.add( camera );</code>
1321

1422

15-
<h2>Constructor</h2>
23+
<h2>Constructor</h2>
1624

17-
<h3>[name]( [page:Float fov], [page:Float aspect], [page:Float near], [page:Float far] )</h3>
18-
<div>
19-
fov — Camera frustum vertical field of view.<br />
20-
aspect — Camera frustum aspect ratio.<br />
21-
near — Camera frustum near plane.<br />
22-
far — Camera frustum far plane.
23-
</div>
25+
<h3>[name]( [page:Float fov], [page:Float aspect], [page:Float near], [page:Float far] )</h3>
26+
<div>
27+
fov — Camera frustum vertical field of view.<br />
28+
aspect — Camera frustum aspect ratio.<br />
29+
near — Camera frustum near plane.<br />
30+
far — Camera frustum far plane.
31+
</div>
2432

2533

26-
<h2>Properties</h2>
34+
<h2>Properties</h2>
2735

28-
<h3>.[page:Float fov]</h3>
29-
<div>Camera frustum vertical field of view.</div>
36+
<h3>.[page:Float fov]</h3>
37+
<div>Camera frustum vertical field of view.</div>
3038

31-
<h3>.[page:Float aspect]</h3>
32-
<div>Camera frustum aspect ratio.</div>
39+
<h3>.[page:Float aspect]</h3>
40+
<div>Camera frustum aspect ratio.</div>
3341

34-
<h3>.[page:Float near]</h3>
35-
<div>Camera frustum near plane.</div>
42+
<h3>.[page:Float near]</h3>
43+
<div>Camera frustum near plane.</div>
3644

37-
<h3>.[page:Float far]</h3>
38-
<div>Camera frustum far plane.</div>
45+
<h3>.[page:Float far]</h3>
46+
<div>Camera frustum far plane.</div>
3947

4048

41-
<h2>Methods</h2>
49+
<h2>Methods</h2>
4250

43-
<h3>.setLens( [page:Float focalLength], [page:Float frameSize] )</h3>
44-
<div>
45-
focalLength — focal length<br />
46-
frameSize — frame size
47-
</div>
51+
<h3>.setLens( [page:Float focalLength], [page:Float frameSize] )</h3>
52+
<div>
53+
focalLength — focal length<br />
54+
frameSize — frame size
55+
</div>
4856

49-
<div>
50-
Uses focal length (in mm) to estimate and set FOV 35mm (fullframe) camera is used if frame size is not specified.<br />
51-
Formula based on [link:http://www.bobatkins.com/photography/technical/field_of_view.html]
52-
</div>
57+
<div>
58+
Uses focal length (in mm) to estimate and set FOV 35mm (fullframe) camera is used if frame size is not specified.<br />
59+
Formula based on [link:http://www.bobatkins.com/photography/technical/field_of_view.html]
60+
</div>
5361

54-
<h3>.setViewOffset( [page:Float fullWidth], [page:Float fullHeight], [page:Float x], [page:Float y], [page:Float width], [page:Float height] )</h3>
55-
<div>
56-
fullWidth — full width of multiview setup<br />
57-
fullHeight — full height of multiview setup<br />
58-
x — horizontal offset of subcamera<br />
59-
y — vertical offset of subcamera<br />
60-
width — width of subcamera<br />
61-
height — height of subcamera
62-
</div>
62+
<h3>.setViewOffset( [page:Float fullWidth], [page:Float fullHeight], [page:Float x], [page:Float y], [page:Float width], [page:Float height] )</h3>
63+
<div>
64+
fullWidth — full width of multiview setup<br />
65+
fullHeight — full height of multiview setup<br />
66+
x — horizontal offset of subcamera<br />
67+
y — vertical offset of subcamera<br />
68+
width — width of subcamera<br />
69+
height — height of subcamera
70+
</div>
6371

64-
<div>
65-
Sets an offset in a larger frustum. This is useful for multi-window or multi-monitor/multi-machine setups.
66-
</div>
72+
<div>
73+
Sets an offset in a larger frustum. This is useful for multi-window or multi-monitor/multi-machine setups.
74+
</div>
6775

68-
<div>
69-
For example, if you have 3x2 monitors and each monitor is 1920x1080 and the monitors are in grid like this:<br />
76+
<div>
77+
For example, if you have 3x2 monitors and each monitor is 1920x1080 and the monitors are in grid like this:<br />
7078

71-
<pre>+---+---+---+
79+
<pre>+---+---+---+
7280
| A | B | C |
7381
+---+---+---+
7482
| D | E | F |
75-
+---+---+---+
76-
</pre>
83+
+---+---+---+</pre>
7784

78-
then for each monitor you would call it like this:<br />
85+
then for each monitor you would call it like this:<br />
7986

80-
<code>var w = 1920;
87+
<code>var w = 1920;
8188
var h = 1080;
8289
var fullWidth = w * 3;
8390
var fullHeight = h * 2;
@@ -96,15 +103,17 @@ <h3>.setViewOffset( [page:Float fullWidth], [page:Float fullHeight], [page:Float
96103
camera.setViewOffset( fullWidth, fullHeight, w * 2, h * 1, w, h );
97104
</code>
98105

99-
Note there is no reason monitors have to be the same size or in a grid.
100-
</div>
106+
Note there is no reason monitors have to be the same size or in a grid.
107+
</div>
101108

102-
<h3>.updateProjectionMatrix()</h3>
103-
<div>
104-
Updates the camera projection matrix. Must be called after change of parameters.
105-
</div>
109+
<h3>.updateProjectionMatrix()</h3>
110+
<div>
111+
Updates the camera projection matrix. Must be called after change of parameters.
112+
</div>
106113

107114

108-
<h2>Source</h2>
115+
<h2>Source</h2>
109116

110-
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
117+
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
118+
</body>
119+
</html>

0 commit comments

Comments
 (0)