Skip to content

Commit 8fdcc1d

Browse files
gregtatumgregtatum
committed
Updated misc docs todos
1 parent dc3f237 commit 8fdcc1d

10 files changed

Lines changed: 233 additions & 266 deletions

File tree

‎docs/api/cameras/CubeCamera.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ <h2>Methods</h2>
6767

6868

6969

70-
<h3>[method:todo updateCubeMap]([page:todo renderer], [page:todo scene])</h3>
70+
<h3>[method:null updateCubeMap]([page:WebGLRenderer renderer], [page:Scene scene])</h3>
7171
<div>
7272
renderer -- The current WebGL renderer <br />
7373
scene -- The current scene

‎docs/api/extras/ImageUtils.html‎

Lines changed: 17 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -44,57 +44,40 @@ <h3>[method:CompressedTexture parseDDS]([page:String buffer], [page:boolean load
4444
Parses a DDS Image from the string into a CompressedTexture.
4545
</div>
4646

47-
<h3>[method:todo loadCompressedTexture]([page:todo url], [page:todo mapping], [page:todo onLoad], [page:todo onError])</h3>
48-
<div>
49-
url -- todo <br />
50-
mapping -- todo <br />
51-
onLoad -- todo <br />
52-
onError -- todo
53-
</div>
54-
<div>
55-
todo
56-
</div>
57-
58-
<h3>[method:todo loadTexture]([page:String url], [page:UVMapping mapping], [page:Function onLoad], [page:Function onError])</h3>
47+
<h3>[method:Texture loadTexture]([page:String url], [page:UVMapping mapping], [page:Function onLoad], [page:Function onError])</h3>
5948
<div>
6049
url -- the url of the texture<br />
6150
mapping -- Can be an instance of [page:UVMapping THREE.UVMapping], [page:CubeReflectionMapping THREE.CubeReflectionMapping] or [page:SphericalReflectionMapping THREE.SphericalReflectionMapping]. Describes how the image is applied to the object.<br />Use undefined instead of null as a default value. See mapping property of [page:Texture texture] for more details. <br/>
6251
onLoad -- callback function<br />
6352
onError -- callback function
6453
</div>
6554
<div>
66-
todo
55+
A helper function to generates a [page:Texture THREE.Texture] from an image URL. Provides a load and error
56+
callback.
6757
</div>
6858

69-
<h3>[method:todo getNormalMap]([page:todo image], [page:todo depth])</h3>
59+
<h3>[method:canvas getNormalMap]([page:Image image], [page:Float depth])</h3>
7060
<div>
71-
image -- todo <br />
72-
depth -- todo
61+
image -- A loaded image element <br />
62+
depth -- The depth of the normal map. Defaults to between -1 and 1.
7363
</div>
7464
<div>
75-
todo
65+
Translates an image element into a normal map with the range (-1, -1, -1) to (1, 1, 1) multiplied by the depth.
66+
Returns a canvas element.
7667
</div>
7768

78-
<h3>[method:todo loadCompressedTextureCube]([page:todo array], [page:todo mapping], [page:todo onLoad], [page:todo onError])</h3>
69+
<h3>[method:CubeTexture loadTextureCube]([page:Array array], [page:Textures mapping], [page:function onLoad], [page:function onError])</h3>
7970
<div>
80-
array -- todo <br />
81-
mapping -- todo <br />
82-
onLoad -- todo <br />
83-
onError -- todo
71+
array -- An array of 6 images <br />
72+
mapping -- Either [page:Textures THREE.CubeReflectionMapping] or [page:Textures THREE.CubeRefractionMapping]<br />
73+
onLoad -- callback <br />
74+
onError -- callback
8475
</div>
8576
<div>
86-
todo
87-
</div>
88-
89-
<h3>[method:todo loadTextureCube]([page:todo array], [page:todo mapping], [page:todo onLoad], [page:todo onError])</h3>
90-
<div>
91-
array -- todo <br />
92-
mapping -- todo <br />
93-
onLoad -- todo <br />
94-
onError -- todo
95-
</div>
96-
<div>
97-
todo
77+
Creates a [page:CubeTexture] from 6 images.<br /><br />
78+
79+
The images are loaded in the following order where p is positiive and n is negative: [ px, nx, py, ny, pz, nz ].
80+
See [page:CubeTexture] for an example in code.
9881
</div>
9982

10083
<h2>Source</h2>

‎docs/api/extras/animation/Animation.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ <h3>[property:number currentTime]</h3>
4848

4949
<h3>[property:number timeScale]</h3>
5050
<div>
51-
The timez
51+
How much to scale the speed of the animation. Defaults to 1.
5252
</div>
5353

5454
<h3>[property:boolean isPlaying]</h3>
@@ -75,7 +75,7 @@ <h2>Methods</h2>
7575

7676
<h3>[method:null play]([page:Number startTime])</h3>
7777
<div>
78-
Starts the animation from a moment startTime in the animation.
78+
Starts the animation at the startTime (in seconds) of the animation.
7979
</div>
8080

8181
<h3>[method:null stop]()</h3>

‎docs/api/extras/animation/AnimationMorphTarget.html‎

Lines changed: 0 additions & 105 deletions
This file was deleted.

‎docs/api/extras/animation/KeyFrameAnimation.html‎

Lines changed: 36 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -9,124 +9,106 @@
99
<body>
1010
<h1>[name]</h1>
1111

12-
<div class="desc">todo</div>
12+
<div class="desc">Runs a keyframe animation as imported from the [page:ColladaLoader].</div>
13+
14+
<h2>Examples</h2>
15+
16+
<div>[example:webgl_loader_collada_keyframe loader / collada / keyframe ]</div>
1317

1418

1519
<h2>Constructor</h2>
1620

1721

18-
<h3>[name]([page:todo root], [page:todo data], [page:todo JITCompile])</h3>
22+
<h3>[name]([page:Object data])</h3>
1923
<div>
20-
root -- todo <br />
21-
data -- todo <br />
22-
JITCompile -- todo
24+
data -- An individual animation object from a the [page:ColladaLoader], e.g. loadedColladaObj.animations[0] <br />
2325
</div>
2426
<div>
25-
todo
27+
Creates a new keyframe animation and initializes it to the first keyframes.
2628
</div>
2729

2830

2931
<h2>Properties</h2>
3032

31-
<h3>[property:todo root]</h3>
33+
<h3>[property:Object3D root]</h3>
3234
<div>
33-
todo
35+
The root object of the animation
3436
</div>
3537

36-
<h3>[property:todo data]</h3>
38+
<h3>[property:Object data]</h3>
3739
<div>
38-
todo
40+
The data containing the animation
3941
</div>
4042

41-
<h3>[property:todo hierarchy]</h3>
43+
<h3>[property:Array hierarchy]</h3>
4244
<div>
43-
todo
45+
The objects that are influenced by the animation.
4446
</div>
4547

4648
<h3>[property:number currentTime]</h3>
4749
<div>
48-
todo
50+
The time elapsed since the last start/restart of the animation.
4951
</div>
5052

5153
<h3>[property:number timeScale]</h3>
5254
<div>
53-
todo
55+
How much to scale the speed of the animation. Defaults to 1.
5456
</div>
5557

5658
<h3>[property:boolean isPlaying]</h3>
5759
<div>
58-
todo
60+
Indicates whether the animation is playing. This shouldn't be adapted by user code.
5961
</div>
6062

6163
<h3>[property:boolean isPaused]</h3>
6264
<div>
63-
todo
65+
Indicates whether the animation is paused. This shouldn't be adapted by user code.
6466
</div>
6567

6668
<h3>[property:boolean loop]</h3>
6769
<div>
68-
todo
70+
Set to make the animation restart when the animation ends.
6971
</div>
7072

71-
<h3>[property:boolean JITCompile]</h3>
72-
<div>
73-
todo
74-
</div>
75-
7673
<h2>Methods</h2>
7774

78-
<h3>[method:todo play]()</h3>
75+
<h3>[method:null play]([page:Number startTime])</h3>
7976
<div>
80-
todo
77+
Starts the animation at the startTime (in seconds) of the animation.
8178
</div>
8279

83-
<h3>[method:todo pause]()</h3>
84-
<div>
85-
todo
86-
</div>
87-
88-
<h3>[method:todo stop]()</h3>
89-
<div>
90-
todo
91-
</div>
92-
93-
<h3>[method:todo update]([page:todo deltaTimeMS])</h3>
94-
<div>
95-
deltaTimeMS -- todo
96-
</div>
80+
<h3>[method:null stop]()</h3>
9781
<div>
98-
todo
82+
Stops the animation.
9983
</div>
10084

101-
<h3>[method:todo interpolateCatmullRom]([page:todo points], [page:todo scale])</h3>
85+
<h3>[method:null update]([page:Float deltaTime])</h3>
10286
<div>
103-
points -- todo <br />
104-
scale -- todo
87+
deltaTime -- The change in time in seconds
10588
</div>
10689
<div>
107-
todo
90+
Updates the keyframe animation
10891
</div>
10992

110-
<h3>[method:todo getNextKeyWith]([page:todo sid], [page:todo h], [page:todo key])</h3>
93+
<h3>[method:Object getNextKeyWith]([page:String sid], [page:Integer h], [page:Integer key])</h3>
11194
<div>
112-
sid -- todo <br />
113-
h -- todo <br />
114-
key -- todo
95+
sid -- The string id <br />
96+
h -- The index in the heirarchy to use<br />
97+
key -- The index of which key to start from
11598
</div>
11699
<div>
117-
todo
100+
Used internally to traverse the animation
118101
</div>
119102

120-
<h3>[method:todo getPrevKeyWith]([page:todo sid], [page:todo h], [page:todo key])</h3>
103+
<h3>[method:Object getPrevKeyWith]([page:String sid], [page:Integer h], [page:Integer key])</h3>
121104
<div>
122-
sid -- todo <br />
123-
h -- todo <br />
124-
key -- todo
105+
sid -- The string id <br />
106+
h -- The index in the heirarchy to use<br />
107+
key -- The index of which key to start from
125108
</div>
126109
<div>
127-
todo
110+
Used internally to traverse the animation
128111
</div>
129-
<h2>Source</h2>
130112

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

‎docs/api/extras/core/Curve.html‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@
99
<body>
1010
<h1>[name]</h1>
1111

12-
<div class="desc">An extensible curve object which contains methods for interpolation.</div>
12+
<div class="desc">
13+
An abstract base class for creating a curve object that contains methods for interpolation.
14+
For an array of Curves see [page:CurvePath].
15+
</div>
1316

1417
<h2>Examples</h2>
1518

@@ -27,7 +30,7 @@ <h3>[name]()</h3>
2730
<h2>Methods</h2>
2831

2932
<h3>[method:Vector getPoint]( t )</h3>
30-
<div>Returns a vector for point t of the curve where t is between 0 and 1</div>
33+
<div>Returns a vector for point t of the curve where t is between 0 and 1. Must be implemented in the extending class.</div>
3134

3235
<h3>[method:Vector getPointAt]( u )</h3>
3336
<div>Returns a vector for point at relative position in curve according to arc length</div>

0 commit comments

Comments
 (0)