Home Explore Help
Sign In
javascript
/
three.js
mirror of https://github.com/tazdij/three.js.git
2
0
Fork 0
Files Issues 0 Wiki
Browse Source

Completed small todos

Greg Tatum 10 years ago
parent
e3cea8e1a2
commit
d843b3afbd
25 changed files with 67 additions and 81 deletions
Split View Show Diff Stats
  1. 3 3
      docs/api/extras/SceneUtils.html
  2. 4 19
      docs/api/extras/animation/Animation.html
  3. 13 13
      docs/api/extras/cameras/CombinedCamera.html
  4. 10 10
      docs/api/extras/core/Curve.html
  5. 2 2
      docs/api/extras/geometries/ExtrudeGeometry.html
  6. 1 1
      docs/api/extras/geometries/ShapeGeometry.html
  7. 3 3
      docs/api/extras/helpers/ArrowHelper.html
  8. 1 1
      docs/api/extras/helpers/BoundingBoxHelper.html
  9. 1 1
      docs/api/extras/helpers/GridHelper.html
  10. 1 1
      docs/api/extras/objects/ImmediateRenderObject.html
  11. 2 2
      docs/api/materials/Material.html
  12. 2 5
      docs/api/materials/MeshLambertMaterial.html
  13. 2 2
      docs/api/materials/MeshPhongMaterial.html
  14. 1 1
      docs/api/materials/ShaderMaterial.html
  15. 1 1
      docs/api/math/Frustum.html
  16. 1 1
      docs/api/math/Ray.html
  17. 10 6
      docs/api/math/Spline.html
  18. 1 1
      docs/api/math/Vector4.html
  19. 2 2
      docs/api/objects/Mesh.html
  20. 1 1
      docs/api/objects/PointCloud.html
  21. 1 1
      docs/api/objects/SkinnedMesh.html
  22. 1 1
      docs/api/objects/Sprite.html
  23. 1 1
      docs/api/renderers/webgl/plugins/LensFlarePlugin.html
  24. 1 1
      docs/api/renderers/webgl/plugins/ShadowMapPlugin.html
  25. 1 1
      docs/api/renderers/webgl/plugins/SpritePlugin.html

+ 3 - 3
docs/api/extras/SceneUtils.html
View File 

@@ -9,7 +9,7 @@
 
 	<body>
 
 		<h1>[name]</h1>
 
 
-		<div class="desc">A class containing usefull utility functions for scene manipulation.</div>
 
+		<div class="desc">A class containing useful utility functions for scene manipulation.</div>
 
 
 
 		<h2>Methods</h2>
 
@@ -25,7 +25,7 @@
 
 		This is mostly useful for object that need a material and a wireframe implementation.
 
 		</div>
 
 
-		<h3>[method:todo attach]([page:Object3D child], [page:Object3D scene], [page:Object3D parent])</h3>
 
+		<h3>[method:null attach]([page:Object3D child], [page:Object3D scene], [page:Object3D parent])</h3>
 
 		<div>
 
 		child -- The object to add to the parent  <br />
 
 		scene -- The scene to detach the object on. <br />
 
@@ -35,7 +35,7 @@
 
 		Attaches the object to the parent without the moving the object in the worldspace.
 
 		</div>
 
 
-		<h3>[method:todo detach]([page:Object3D child], [page:Object3D parent], [page:Object3D scene])</h3>
 
+		<h3>[method:null detach]([page:Object3D child], [page:Object3D parent], [page:Object3D scene])</h3>
 
 		<div>
 
 		child -- The object to remove from the parent  <br />
 
 		scene -- The scene to attach the object on. <br />

+ 4 - 19
docs/api/extras/animation/Animation.html
View File 

@@ -9,7 +9,7 @@
 
 	<body>
 
 		<h1>[name]</h1>
 
 
-		<div class="desc">This class animates an object based on an hierarchy.This hierarchy can be Object3Ds or bones.</div>
 
+		<div class="desc">This class animates an object based on an hierarchy. This hierarchy can be Object3ds or bones.</div>
 
 
 
 		<h2>Constructor</h2>
 
@@ -71,34 +71,19 @@
 
 		The type to indicate how to interpolate between 2 data points.
 
 		</div> 
 
-		<h3>[property:array points]</h3>
 
-		<div>
 
-		This should be removed from the code.(TODO).
 
-		</div>
 
-		
-		<h3>[property:Vector3 target]</h3>
 
-		<div>
 
-		This should be removed from the code.(TODO).
 
-		</div>
 
-
 
 		<h2>Methods</h2>
 
 		
-		<h3>[method:todo play]([page:Number startTime])</h3>
 
+		<h3>[method:null play]([page:Number startTime])</h3>
 
 		<div>
 
 		Starts the animation from a moment startTime in the animation.
 
 		</div>
 
 
-		<h3>[method:todo pause]()</h3>
 
-		<div>
 
-		Pauses the animation or restarts the animation after pausing it.
 
-		</div>
 
-
 
-		<h3>[method:todo stop]()</h3>
 
+		<h3>[method:null stop]()</h3>
 
 		<div>
 
 		Stops the animation.
 
 		</div>
 
 
-		<h3>[method:todo update]([page:Number deltaTimeMS])</h3>
 
+		<h3>[method:Boolean update]([page:Number deltaTimeMS])</h3>
 
 		<div>
 
 		deltaTimeMS -- The time of the between the previous frame and this frame in miliseconds. 
 		</div>

+ 13 - 13
docs/api/extras/cameras/CombinedCamera.html
View File 

@@ -101,7 +101,7 @@
 
 
 		<h2>Methods</h2>
 
 
-		<h3>[method:todo setFov]([page:Number fov])</h3>
 
+		<h3>[method:null setFov]([page:Number fov])</h3>
 
 		<div>
 
 		fov --  Camera frustum vertical field of view in perspective view.
 
 		</div>
 
@@ -109,7 +109,7 @@
 
 		sets the camera frustum vertical field of view in perspective view.
 
 		</div>
 
 
-		<h3>[method:todo setZoom]([page:Number zoom])</h3>
 
+		<h3>[method:null setZoom]([page:Number zoom])</h3>
 
 		<div>
 
 		zoom -- The zoom factor.
 
 		</div>
 
@@ -117,7 +117,7 @@
 
 		Sets the zoomfactor.
 
 		</div>
 
 
-		<h3>[method:todo setLens]([page:number focalLength], [page:Number frameHeight])</h3>
 
+		<h3>[method:null setLens]([page:number focalLength], [page:Number frameHeight])</h3>
 
 		<div>
 
 		focalLength -- The focal length of a lens is defined as the distance from the optical center of a lens (or, the secondary principal point for a complex lens like a camera lens) to the focal point (sensor) when the lens is focused on an object at infinity. <br />
 
 		frameHeight -- the size of the frame in mm. (default is *35*)
 
@@ -126,37 +126,37 @@
 
 		Sets the fov based on lens data.
 
 		</div>
 
 
-		<h3>[method:todo toFrontView]()</h3>
 
+		<h3>[method:null toFrontView]()</h3>
 
 		<div>
 
 		Sets the camera to view the front of the target.
 
 		</div>
 
 
-		<h3>[method:todo toBackView]()</h3>
 
+		<h3>[method:null toBackView]()</h3>
 
 		<div>
 
 		Sets the camera to view the back of the target.
 
 		</div>
 
 
-		<h3>[method:todo toLeftView]()</h3>
 
+		<h3>[method:null toLeftView]()</h3>
 
 		<div>
 
 		Sets the camera to view the left of the target.
 
 		</div>
 
 
-		<h3>[method:todo toRightView]()</h3>
 
+		<h3>[method:null toRightView]()</h3>
 
 		<div>
 
 		Sets the camera to view the right of the target.
 
 		</div>
 
 
-		<h3>[method:todo toTopView]()</h3>
 
+		<h3>[method:null toTopView]()</h3>
 
 		<div>
 
 		Sets the camera to view the top.
 
 		</div>
 
 
-		<h3>[method:todo toBottomView]()</h3>
 
+		<h3>[method:null toBottomView]()</h3>
 
 		<div>
 
 		Sets the camera to view the bottom.
 
 		</div>
 
 
-		<h3>[method:todo setSize]([page:Number width], [page:Number height])</h3>
 
+		<h3>[method:null setSize]([page:Number width], [page:Number height])</h3>
 
 		<div>
 
 		width -- The width of the orthographic view.<br />
 
 		height -- The height of the orthographic view.
 
@@ -165,17 +165,17 @@
 
 		Sets the size of the orthographic view.
 
 		</div>
 
 
-		<h3>[method:todo toOrthographic]()</h3>
 
+		<h3>[method:null toOrthographic]()</h3>
 
 		<div>
 
 		Change the camera to orthographic view.
 
 		</div>
 
 
-		<h3>[method:todo toPerspective]()</h3>
 
+		<h3>[method:null toPerspective]()</h3>
 
 		<div>
 
 		Change the camera to Perspective view.
 
 		</div>
 
 
-		<h3>[method:todo updateProjectionMatrix]()</h3>
 
+		<h3>[method:null updateProjectionMatrix]()</h3>
 
 		<div>
 
 		Updates the ProjectionMatrix.
 
 		</div>

+ 10 - 10
docs/api/extras/core/Curve.html
View File 

@@ -23,34 +23,34 @@
 
 
 		<h2>Methods</h2>
 
 
-		<h3>[method:todo getPoint]( t )</h3>
 
+		<h3>[method:Vector getPoint]( t )</h3>
 
 		<div>Returns a vector for point t of the curve where t is between 0 and 1</div>
 
 
-		<h3>[method:todo getPointAt]( u )</h3>
 
+		<h3>[method:Vector getPointAt]( u )</h3>
 
 		<div>Returns a vector for point at relative position in curve according to arc length</div>
 
 
-		<h3>[method:todo getPoints]( divisions )</h3>
 
+		<h3>[method:Array getPoints]( divisions )</h3>
 
 		<div>Get sequence of points using getPoint( t ) </div>
 
 
-		<h3>[method:todo getSpacedPoints]( divisions )</h3>
 
+		<h3>[method:Array getSpacedPoints]( divisions )</h3>
 
 		<div>Get sequence of equi-spaced points using getPointAt( u )</div>
 
 
-		<h3>[method:todo getLength]()</h3>
 
+		<h3>[method:Float getLength]()</h3>
 
 		<div>Get total curve arc length</div>
 
 
-		<h3>[method:todo getLengths]( divisions )</h3>
 
+		<h3>[method:Array getLengths]( divisions )</h3>
 
 		<div>Get list of cumulative segment lengths</div>
 
 
-		<h3>[method:todo updateArcLengths]()</h3>
 
+		<h3>[method:null updateArcLengths]()</h3>
 
 		<div>Update the cumlative segment distance cache</div>
 
 
-		<h3>[method:todo getUtoTmapping]( u, distance )</h3>
 
+		<h3>[method:Float getUtoTmapping]( u, distance )</h3>
 
 		<div>Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equidistant</div>
 
 
-		<h3>[method:todo getTangent]( t )</h3>
 
+		<h3>[method:Vector getTangent]( t )</h3>
 
 		<div>Returns a unit vector tangent at t. If the subclassed curve do not implement its tangent derivation, 2 points a small delta apart will be used to find its gradient which seems to give a reasonable approximation</div>
 
 
-		<h3>[method:todo getTangentAt]( u )</h3>
 
+		<h3>[method:Vector getTangentAt]( u )</h3>
 
 		<div>Returns tangent at equidistant point u on the curve</div>

+ 2 - 2
docs/api/extras/geometries/ExtrudeGeometry.html
View File 

@@ -48,7 +48,7 @@
 
 
 		<h2>Methods</h2>
 
 
-		<h3>[method:todo addShapeList]([page:Array shapes], [page:Object options])</h3>
 
+		<h3>[method:null addShapeList]([page:Array shapes], [page:Object options])</h3>
 
 		<div>
 
 			shapes — An Array of shapes to add. <br />
 
 			options — Object that can contain the following parameters.
 
@@ -69,7 +69,7 @@
 
 	</div>
 
 		<div>Adds the shapes to the list to extrude.</div>
 
 
-		<h3>[method:todo addShape]([page:Shape shape], [page:Object options])</h3>
 
+		<h3>[method:null addShape]([page:Shape shape], [page:Object options])</h3>
 
 		<div>
 
 			shape — A shape to add. <br />
 
 			options — Object that can contain the following parameters.

+ 1 - 1
docs/api/extras/geometries/ShapeGeometry.html
View File 

@@ -59,7 +59,7 @@
 
 		Adds a list of shapes to the geometry.
 
 		</div>
 
 
-		<h3>[method:todo addShape]([page:Shape shape], [page:Object options])</h3>
 
+		<h3>[method:null addShape]([page:Shape shape], [page:Object options])</h3>
 
 		<div>
 
 		shape — [page:Shape] <br />
 
 		options — See options in constructor

+ 3 - 3
docs/api/extras/helpers/ArrowHelper.html
View File 

@@ -62,7 +62,7 @@
 
 
 
 
-		<h3>[method:todo setColor]([page:Number hex])</h3>
 
+		<h3>[method:null setColor]([page:Number hex])</h3>
 
 		<div>
 
 		hex -- The hexadicmal value of the color
 
 		</div>
 
@@ -70,7 +70,7 @@
 
 		Sets the color of the arrowHelper.
 
 		</div>
 
 
-		<h3>[method:todo setLength]([page:Number length], [page:Number headLength], [page:Number headWidth])</h3>
 
+		<h3>[method:null setLength]([page:Number length], [page:Number headLength], [page:Number headWidth])</h3>
 
 		<div>
 
 		length -- The desired length<br />
 
 		headLength -- The length of the head of the arrow<br />
 
@@ -80,7 +80,7 @@
 
 		Sets the length of the arrowhelper.
 
 		</div>
 
 
-		<h3>[method:todo setDirection]([page:vector3 dir])</h3>
 
+		<h3>[method:null setDirection]([page:vector3 dir])</h3>
 
 		<div>
 
 		dir -- The desired direction in euler format.
 
 		</div>

+ 1 - 1
docs/api/extras/helpers/BoundingBoxHelper.html
View File 

@@ -58,7 +58,7 @@
 
 
 		<h2>Methods</h2>
 
 
-		<h3>[method:todo update]()</h3>
 
+		<h3>[method:null update]()</h3>
 
 		<div>
 
 		Updates the BoundingBoxHelper based on the object property.
 
 		</div>

+ 1 - 1
docs/api/extras/helpers/GridHelper.html
View File 

@@ -37,7 +37,7 @@
 
 		
 		<h2>Methods</h2>
 
 
-		<h3>[method:todo setColors]([page:number colorCenterLine], [page:Number colorGrid])</h3>
 
+		<h3>[method:null setColors]([page:number colorCenterLine], [page:Number colorGrid])</h3>
 
 		<div>
 
 		colorCenterLine -- The color of the centerline. This can be a [page:Color], a hexadecimal value and an CSS-Color name. <br />
 
 		colorGrid -- The color of the lines of the grid. This can be a [page:Color], a hexadecimal value and an CSS-Color name.

+ 1 - 1
docs/api/extras/objects/ImmediateRenderObject.html
View File 

@@ -26,7 +26,7 @@
 
 		<h2>Methods</h2>
 
 
 
-		<h3>[method:todo render]([page:Function renderCallback])</h3>
 
+		<h3>[method:null render]([page:Function renderCallback])</h3>
 
 		<div>
 
 		renderCallback -- A function to render the generated object.
 
 		</div>

+ 2 - 2
docs/api/materials/Material.html
View File 

@@ -145,12 +145,12 @@
 
 		This clones the material in the optional parameter and returns it.
 
 		</div>
 
 
-		<h3>[method:todo dispose]()</h3>
 
+		<h3>[method:null dispose]()</h3>
 
 		<div>
 
 		This disposes the material.
 
 		</div>
 
 
-		<h3>[method:todo setValues]([page:object values])</h3>
 
+		<h3>[method:null setValues]([page:object values])</h3>
 
 		<div>
 
 		values -- a container with parameters.
 
 		</div>

+ 2 - 5
docs/api/materials/MeshLambertMaterial.html
View File 

@@ -17,12 +17,9 @@
 
 		<h2>Constructor</h2>
 
 
 
-		<h3>[name]([page:todo parameters])</h3>
 
+		<h3>[name]([page:Object parameters])</h3>
 
 		<div>
 
-		parameters -- todo
 
-		</div>
 
-		<div>
 
-		todo
 
+		parameters -- parameters is an object with one or more properties defining the material's appearance.
 
 		</div>

+ 2 - 2
docs/api/materials/MeshPhongMaterial.html
View File 

@@ -17,9 +17,9 @@
 
 		<h2>Constructor</h2>
 
 
 
-		<h3>[name]([page:todo parameters])</h3>
 
+		<h3>[name]([page:Object parameters])</h3>
 
 		<div>
 
-		parameters -- A JSON object with settable parameters.
 
+		parameters -- an object with one or more of the material's properties defining the its appearance.
 
 		</div>
 
 		<div>
 
 		Example:<br>

+ 1 - 1
docs/api/materials/ShaderMaterial.html
View File 

@@ -319,7 +319,7 @@
 
 
 		<h2>Methods</h2>
 
 
-		<h3>[method:todo clone]()</h3>
 
+		<h3>[method:ShaderMaterial clone]()</h3>
 
 		<div>
 
 		Generates a shallow copy of this material. Note that the vertexShader and fragmentShader are copied <emph>by reference</emph>, as are the definitions of the *attributes*; this means that clones of the material will share the same compiled [page:WebGLProgram]. However, the *uniforms* are copied <emph>by value</emph>, which allows you to have different sets of uniforms for different copies of the material. 
 		</div>

+ 1 - 1
docs/api/math/Frustum.html
View File 

@@ -39,7 +39,7 @@
 
 
 		<h2>Methods</h2>
 
 
-		<h3>[method:todo setFromMatrix]( [page:Matrix4 matrix] )</h3>
 
+		<h3>[method:Frustum setFromMatrix]( [page:Matrix4 matrix] )</h3>
 
 
 		<h3>[method:Boolean intersectsObject]( [page:Object3D object] )</h3>
 
 		<div>

+ 1 - 1
docs/api/math/Ray.html
View File 

@@ -165,7 +165,7 @@
 
 		Return whether or not this [page:Ray] intersects with the [page:Sphere].
 
 		</div>
 
 
-		<h3>[method:todo recast]([page:Float t])</h3>
 
+		<h3>[method:Ray recast]([page:Float t])</h3>
 
 		<div>
 
 		t -- The distance along the [page:Ray] to interpolate.
 
 		</div>

+ 10 - 6
docs/api/math/Spline.html
View File 

@@ -27,30 +27,34 @@
 
 
 		<h2>Methods</h2>
 
 
-		<h3>[method:todo initFromArray]( [page:Array a] )</h3>
 
+		<h3>[method:null initFromArray]( [page:Array a] )</h3>
 
 		<div>
 
 		a — array of triplets containing x, y, z coordinates<br />
 
 		</div>
 
 		<div>Initialises using the data in the array as a series of points. Each value in *a* must be another array with three values, where a[n] is v, the value for the *nth* point, and v[0], v[1] and v[2] are the x, y and z coordinates of that point n, respectively.
 
 		</div>
 
 
-		<h3>[method:todo getPoint]( [page:Integer k] )</h3>
 
+		<h3>[method:Vector3 getPoint]( [page:Integer k] )</h3>
 
 		<div>
 
 		k — point index
 
 		</div>
 
 		<div>Return the interpolated point at *k*.</div>
 
 		
-		<h3>[method:todo getControlPointsArray]( )</h3>
 
+		<h3>[method:Array getControlPointsArray]( )</h3>
 
 		<div>Returns an array with triplets of x, y, z coordinates that correspond to the current control points.
 
 		</div>
 
 		
-		<h3>[method:todo getLength]( [page:Integer nSubDivisions] )</h3>
 
+		<h3>[method:Object getLength]( [page:Integer nSubDivisions] )</h3>
 
 		<div>
 
 		nSubDivisions — number of subdivisions between control points. Default is *100*.
 
 		</div>
 
-		<div>Returns the length of the spline when using nSubDivisions.</div>
 
+		<div>
 
+			Returns an object with the two properties. The property .[page:Number total]</strong> contains
 
+			the length of the spline when using nSubDivisions. The property .[page:Array chunkLength]
 
+			contains an array with the total length from the beginning of the spline to the end of that chunk.
 
+		</div>
 
 		
-		<h3>[method:todo reparametrizeByArcLength]( [page:Float samplingCoef] )</h3>
 
+		<h3>[method:null reparametrizeByArcLength]( [page:Float samplingCoef] )</h3>
 
 		<div>
 
 		samplingCoef — how many intermediate values to use between spline points
 
 		</div>

+ 1 - 1
docs/api/math/Vector4.html
View File 

@@ -234,7 +234,7 @@
 
  
 		</div>
 
 
-		<h3>[method:todo setComponent]([page:Integer index], [page:Float value])</h3>
 
+		<h3>[method:null setComponent]([page:Integer index], [page:Float value])</h3>
 
 		<div>
 
 		index -- [page:Integer] 0 - 3 <br />
 
 		value -- [page:Float]

+ 2 - 2
docs/api/objects/Mesh.html
View File 

@@ -46,7 +46,7 @@
 
 
 		<h2>Methods</h2>
 
 
-		<h3>[method:todo getMorphTargetIndexByName]( [page:String name] )</h3>
 
+		<h3>[method:Integer getMorphTargetIndexByName]( [page:String name] )</h3>
 
 		<div>
 
 		name — a morph target name<br />
 
 		</div>
 
@@ -55,7 +55,7 @@
 
 		</div>
 
 
 
-		<h3>[method:todo updateMorphTargets]()</h3>
 
+		<h3>[method:null updateMorphTargets]()</h3>
 
 		<div>
 
 		Updates the morphtargets to have no influence on the object.
 
 		</div>

+ 1 - 1
docs/api/objects/PointCloud.html
View File 

@@ -41,7 +41,7 @@
 
 
 		<h2>Methods</h2>
 
 
-		<h3>[method:todo clone]()</h3>
 
+		<h3>[method:PointCloud clone]()</h3>
 
 		<div>
 
 		This creates a clone of the particle system.
 
 		</div>

+ 1 - 1
docs/api/objects/SkinnedMesh.html
View File 

@@ -54,7 +54,7 @@
 
 
 		<h2>Methods</h2>
 
 
-		<h3>[method:todo pose]()</h3>
 
+		<h3>[method:null pose]()</h3>
 
 		<div>
 
 		This method sets the skinnedmesh in the rest pose.
 
 		</div>

+ 1 - 1
docs/api/objects/Sprite.html
View File 

@@ -43,7 +43,7 @@
 
 -
 
            	<h2>Methods</h2>
 
 
-                <h3>[method:todo clone]()</h3>
 
+                <h3>[method:Sprite clone]()</h3>
 
                 <div>
 
                 This creates a new clone of the sprite.
 
                 </div>

+ 1 - 1
docs/api/renderers/webgl/plugins/LensFlarePlugin.html
View File 

@@ -22,7 +22,7 @@
 
 
 		<h2>Methods</h2>
 
 
-		<h3>[method:todo render]([page:Scene scene], [page:Camera camera], [page:Number viewportWidth], [page:Number viewportHeight])</h3>
 
+		<h3>[method:null render]([page:Scene scene], [page:Camera camera], [page:Number viewportWidth], [page:Number viewportHeight])</h3>
 
 		<div>
 
 		scene -- The scene to render. <br />
 
 		camera -- The camera to render. <br />

+ 1 - 1
docs/api/renderers/webgl/plugins/ShadowMapPlugin.html
View File 

@@ -22,7 +22,7 @@
 
 
 		<h2>Methods</h2>
 
 
-		<h3>[method:todo render]([page:Scene scene], [page:Camera camera])</h3>
 
+		<h3>[method:null render]([page:Scene scene], [page:Camera camera])</h3>
 
 		<div>
 
 		scene -- The scene to render. <br />
 
 		camera -- The camera to render.

+ 1 - 1
docs/api/renderers/webgl/plugins/SpritePlugin.html
View File 

@@ -22,7 +22,7 @@
 
 
 		<h2>Methods</h2>
 
 
-		<h3>[method:todo render]([page:Scene scene], [page:Camera camera])</h3>
 
+		<h3>[method:null render]([page:Scene scene], [page:Camera camera])</h3>
 
 		<div>
 
 		scene -- The scene to render. <br />
 
 		camera -- The camera to render.