Skip to content

Commit 5d98a2f

Browse files
author
cjshannon
committed
additions to documentation
1 parent 4453bf0 commit 5d98a2f

File tree

91 files changed

+4373
-0
lines changed

Some content is hidden

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

91 files changed

+4373
-0
lines changed

‎docs/api/core/BufferGeometry.html‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,11 @@ <h3>.[page:Array morphTargets]</h3>
6565
Morph vertices match number and order of primary vertices.
6666
</div>
6767

68+
<h3>.[page:boolean hasTangents]</h3>
69+
<div>
70+
todo
71+
</div>
72+
6873
<h2>Methods</h2>
6974

7075
<h3>.applyMatrix( [page:Matrix4 matrix] )</h3>
@@ -103,6 +108,46 @@ <h3>.dispose()</h3>
103108
</div>
104109

105110

111+
<h3>.hasEventListener([page:todo type], [page:todo listener]) [page:todo]</h3>
112+
<div>
113+
type -- todo <br />
114+
listener -- todo
115+
</div>
116+
<div>
117+
todo
118+
</div>
119+
120+
<h3>.addEventListener([page:todo type], [page:todo listener]) [page:todo]</h3>
121+
<div>
122+
type -- todo <br />
123+
listener -- todo
124+
</div>
125+
<div>
126+
todo
127+
</div>
128+
129+
<h3>.removeEventListener([page:todo type], [page:todo listener]) [page:todo]</h3>
130+
<div>
131+
type -- todo <br />
132+
listener -- todo
133+
</div>
134+
<div>
135+
todo
136+
</div>
137+
138+
<h3>.normalizeNormals() [page:todo]</h3>
139+
<div>
140+
todo
141+
</div>
142+
143+
<h3>.dispatchEvent([page:todo event]) [page:todo]</h3>
144+
<div>
145+
event -- todo
146+
</div>
147+
<div>
148+
todo
149+
</div>
150+
106151
<h2>Source</h2>
107152

108153
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

‎docs/api/core/Geometry.html‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,16 @@ <h3>.[page:Boolean buffersNeedUpdate]</h3>
182182
Set to *true* if an array has changed in length.
183183
</div>
184184

185+
<h3>.[page:array morphNormals]</h3>
186+
<div>
187+
todo
188+
</div>
189+
190+
<h3>.[page:array lineDistances]</h3>
191+
<div>
192+
todo
193+
</div>
194+
185195
<h2>Methods</h2>
186196

187197
<h3>.applyMatrix( [page:Matrix4 matrix] )</h3>
@@ -247,6 +257,46 @@ <h3>.dispose()</h3>
247257
</div>
248258

249259

260+
<h3>.dispatchEvent([page:todo event]) [page:todo]</h3>
261+
<div>
262+
event -- todo
263+
</div>
264+
<div>
265+
todo
266+
</div>
267+
268+
<h3>.hasEventListener([page:todo type], [page:todo listener]) [page:todo]</h3>
269+
<div>
270+
type -- todo <br />
271+
listener -- todo
272+
</div>
273+
<div>
274+
todo
275+
</div>
276+
277+
<h3>.removeEventListener([page:todo type], [page:todo listener]) [page:todo]</h3>
278+
<div>
279+
type -- todo <br />
280+
listener -- todo
281+
</div>
282+
<div>
283+
todo
284+
</div>
285+
286+
<h3>.computeLineDistances() [page:todo]</h3>
287+
<div>
288+
todo
289+
</div>
290+
291+
<h3>.addEventListener([page:todo type], [page:todo listener]) [page:todo]</h3>
292+
<div>
293+
type -- todo <br />
294+
listener -- todo
295+
</div>
296+
<div>
297+
todo
298+
</div>
299+
250300
<h2>Source</h2>
251301

252302
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

‎docs/api/core/Object3D.html‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,16 @@ <h3>.[page:Boolean rotationAutoUpdate]</h3>
119119
When this is set, then the rotationMatrix gets calculated every frame.
120120
</div>
121121

122+
<h3>.[page:object userData]</h3>
123+
<div>
124+
todo
125+
</div>
126+
127+
<h3>.[page:Matrix4 matrixWorld]</h3>
128+
<div>
129+
todo
130+
</div>
131+
122132
<h2>Methods</h2>
123133

124134
<h3>.applyMatrix( [page:Matrix4 matrix])</h3>
@@ -243,6 +253,42 @@ <h3>.clone()</h3>
243253
</div>
244254

245255

256+
<h3>.getObjectByName([page:todo name], [page:todo recursive]) [page:todo]</h3>
257+
<div>
258+
name -- todo <br />
259+
recursive -- todo
260+
</div>
261+
<div>
262+
todo
263+
</div>
264+
265+
<h3>.translateOnAxis([page:todo axis], [page:todo distance]) [page:todo]</h3>
266+
<div>
267+
axis -- todo <br />
268+
distance -- todo
269+
</div>
270+
<div>
271+
todo
272+
</div>
273+
274+
<h3>.getObjectById([page:todo id], [page:todo recursive]) [page:todo]</h3>
275+
<div>
276+
id -- todo <br />
277+
recursive -- todo
278+
</div>
279+
<div>
280+
todo
281+
</div>
282+
283+
<h3>.rotateOnAxis([page:todo axis], [page:todo angle]) [page:todo]</h3>
284+
<div>
285+
axis -- todo <br />
286+
angle -- todo
287+
</div>
288+
<div>
289+
todo
290+
</div>
291+
246292
<h2>Source</h2>
247293

248294
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

‎docs/api/extras/FontUtils.html‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,36 @@ <h2>Properties</h2>
2222
<h3>.[page:Vector3 todo]</h3>
2323

2424

25+
<h3>.[page:number divisions]</h3>
26+
<div>
27+
todo
28+
</div>
29+
30+
<h3>.[page:string style]</h3>
31+
<div>
32+
todo
33+
</div>
34+
35+
<h3>.[page:string weight]</h3>
36+
<div>
37+
todo
38+
</div>
39+
40+
<h3>.[page:string face]</h3>
41+
<div>
42+
todo
43+
</div>
44+
45+
<h3>.[page:object faces]</h3>
46+
<div>
47+
todo
48+
</div>
49+
50+
<h3>.[page:number size]</h3>
51+
<div>
52+
todo
53+
</div>
54+
2555
<h2>Methods</h2>
2656

2757
<h3>.todo( [page:Vector3 todo] )</h3>
@@ -30,6 +60,57 @@ <h3>.todo( [page:Vector3 todo] )</h3>
3060
</div>
3161

3262

63+
<h3>.drawText([page:todo text]) [page:todo]</h3>
64+
<div>
65+
text -- todo
66+
</div>
67+
<div>
68+
todo
69+
</div>
70+
71+
<h3>.Triangulate([page:todo contour], [page:todo indices]) [page:todo]</h3>
72+
<div>
73+
contour -- todo <br />
74+
indices -- todo
75+
</div>
76+
<div>
77+
todo
78+
</div>
79+
80+
<h3>.extractGlyphPoints([page:todo c], [page:todo face], [page:todo scale], [page:todo offset], [page:todo path]) [page:todo]</h3>
81+
<div>
82+
c -- todo <br />
83+
face -- todo <br />
84+
scale -- todo <br />
85+
offset -- todo <br />
86+
path -- todo
87+
</div>
88+
<div>
89+
todo
90+
</div>
91+
92+
<h3>.generateShapes([page:todo text], [page:todo parameters]) [page:todo]</h3>
93+
<div>
94+
text -- todo <br />
95+
parameters -- todo
96+
</div>
97+
<div>
98+
todo
99+
</div>
100+
101+
<h3>.loadFace([page:todo data]) [page:todo]</h3>
102+
<div>
103+
data -- todo
104+
</div>
105+
<div>
106+
todo
107+
</div>
108+
109+
<h3>.getFace() [page:todo]</h3>
110+
<div>
111+
todo
112+
</div>
113+
33114
<h2>Source</h2>
34115

35116
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

‎docs/api/extras/GeometryUtils.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,11 @@ <h3> .setMaterialIndex ( [page:geometry Geometry] , [page:Integer index], [page:
113113
</div>
114114

115115

116+
<h3>.random() [page:todo]</h3>
117+
<div>
118+
todo
119+
</div>
120+
116121
<h2>Source</h2>
117122

118123
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

‎docs/api/extras/ImageUtils.html‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ <h2>Properties</h2>
2222
<h3>.[page:Vector3 todo]</h3>
2323

2424

25+
<h3>.[page:string crossOrigin]</h3>
26+
<div>
27+
todo
28+
</div>
29+
2530
<h2>Methods</h2>
2631

2732
<h3>.todo( [page:Vector3 todo] )</h3>
@@ -30,6 +35,78 @@ <h3>.todo( [page:Vector3 todo] )</h3>
3035
</div>
3136

3237

38+
<h3>.generateDataTexture([page:todo width], [page:todo height], [page:todo color]) [page:todo]</h3>
39+
<div>
40+
width -- todo <br />
41+
height -- todo <br />
42+
color -- todo
43+
</div>
44+
<div>
45+
todo
46+
</div>
47+
48+
<h3>.parseDDS([page:todo buffer], [page:todo loadMipmaps]) [page:todo]</h3>
49+
<div>
50+
buffer -- todo <br />
51+
loadMipmaps -- todo
52+
</div>
53+
<div>
54+
todo
55+
</div>
56+
57+
<h3>.loadCompressedTexture([page:todo url], [page:todo mapping], [page:todo onLoad], [page:todo onError]) [page:todo]</h3>
58+
<div>
59+
url -- todo <br />
60+
mapping -- todo <br />
61+
onLoad -- todo <br />
62+
onError -- todo
63+
</div>
64+
<div>
65+
todo
66+
</div>
67+
68+
<h3>.loadTexture([page:todo url], [page:todo mapping], [page:todo onLoad], [page:todo onError]) [page:todo]</h3>
69+
<div>
70+
url -- todo <br />
71+
mapping -- todo <br />
72+
onLoad -- todo <br />
73+
onError -- todo
74+
</div>
75+
<div>
76+
todo
77+
</div>
78+
79+
<h3>.getNormalMap([page:todo image], [page:todo depth]) [page:todo]</h3>
80+
<div>
81+
image -- todo <br />
82+
depth -- todo
83+
</div>
84+
<div>
85+
todo
86+
</div>
87+
88+
<h3>.loadCompressedTextureCube([page:todo array], [page:todo mapping], [page:todo onLoad], [page:todo onError]) [page:todo]</h3>
89+
<div>
90+
array -- todo <br />
91+
mapping -- todo <br />
92+
onLoad -- todo <br />
93+
onError -- todo
94+
</div>
95+
<div>
96+
todo
97+
</div>
98+
99+
<h3>.loadTextureCube([page:todo array], [page:todo mapping], [page:todo onLoad], [page:todo onError]) [page:todo]</h3>
100+
<div>
101+
array -- todo <br />
102+
mapping -- todo <br />
103+
onLoad -- todo <br />
104+
onError -- todo
105+
</div>
106+
<div>
107+
todo
108+
</div>
109+
33110
<h2>Source</h2>
34111

35112
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

0 commit comments

Comments
 (0)