瀏覽代碼

added documentation

cjshannon 12 年之前
父節點
當前提交
9a4afcb914

+ 104 - 1
docs/api/extras/animation/Animation.html

@@ -25,13 +25,116 @@
 		todo
 		</div>
 
-
 		<h2>Properties</h2>
 
+		<h3>.[page:todo root]</h3>
+		<div>
+		todo
+		</div> 
+
+		<h3>.[page:todo data]</h3>
+		<div>
+		todo
+		</div> 
+		
+		<h3>.[page:todo hierarchy]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.[page:number currentTime]</h3>
+		<div>
+		todo
+		</div>
+		
+		<h3>.[page:number timeScale]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.[page:boolean isPlaying]</h3>
+		<div>
+		todo
+		</div>
+		
+		<h3>.[page:boolean isPaused]</h3>
+		<div>
+		todo
+		</div>
+		
+		<h3>.[page:boolean loop]</h3>
+		<div>
+		todo
+		</div> 
+		
+		<h3>.[page:number interpolationType]</h3>
+		<div>
+		todo
+		</div> 
 
+		<h3>.[page:array points]</h3>
+		<div>
+		todo
+		</div>
+		
+		<h3>.[page:Vector3 target]</h3>
+		<div>
+		todo
+		</div>
 
 		<h2>Methods</h2>
+		
+		<h3>.play() [page:todo]</h3>
+		<div>
+		todo
+		</div>
 
+		<h3>.pause() [page:todo]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.stop() [page:todo]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.update([page:todo deltaTimeMS]) [page:todo]</h3>
+		<div>
+		deltaTimeMS -- todo
+		</div>
+		<div>
+		todo
+		</div>
+
+		<h3>.interpolateCatmullRom([page:todo points], [page:todo scale]) [page:todo]</h3>
+		<div>
+		points -- todo <br />
+		scale -- todo
+		</div>
+		<div>
+		todo
+		</div>
+
+		<h3>.getNextKeyWith([page:todo type], [page:todo h], [page:todo key]) [page:todo]</h3>
+		<div>
+		type -- todo <br />
+		h -- todo <br />
+		key -- todo
+		</div>
+		<div>
+		todo
+		</div>
+
+		<h3>.getPrevKeyWith([page:todo type], [page:todo h], [page:todo key]) [page:todo]</h3>
+		<div>
+		type -- todo <br />
+		h -- todo <br />
+		key -- todo
+		</div>
+		<div>
+		todo
+		</div>
 
 
 		<h2>Source</h2>

+ 66 - 0
docs/api/extras/animation/AnimationMorphTarget.html

@@ -25,11 +25,77 @@
 		</div>
 
 		<h2>Properties</h2>
+		
+		<h3>.[page:todo root]</h3>
+		<div>
+		todo
+		</div> 
 
+		<h3>.[page:todo data]</h3>
+		<div>
+		todo
+		</div> 
+		
+		<h3>.[page:todo hierarchy]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.[page:number currentTime]</h3>
+		<div>
+		todo
+		</div>
+		
+		<h3>.[page:number timeScale]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.[page:boolean isPlaying]</h3>
+		<div>
+		todo
+		</div>
+		
+		<h3>.[page:boolean isPaused]</h3>
+		<div>
+		todo
+		</div>
+		
+		<h3>.[page:boolean loop]</h3>
+		<div>
+		todo
+		</div> 
+		
+		<h3>.[page:number influence]</h3>
+		<div>
+		todo
+		</div> 
 
 
 		<h2>Methods</h2>
 
+		<h3>.play() [page:todo]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.pause() [page:todo]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.stop() [page:todo]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.update([page:todo deltaTimeMS]) [page:todo]</h3>
+		<div>
+		deltaTimeMS -- todo
+		</div>
+		<div>
+		todo
+		</div>
 
 
 		<h2>Source</h2>

+ 92 - 0
docs/api/extras/animation/KeyFrameAnimation.html

@@ -28,12 +28,104 @@
 
 		<h2>Properties</h2>
 
+		<h3>.[page:todo root]</h3>
+		<div>
+		todo
+		</div> 
+
+		<h3>.[page:todo data]</h3>
+		<div>
+		todo
+		</div> 
+		
+		<h3>.[page:todo hierarchy]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.[page:number currentTime]</h3>
+		<div>
+		todo
+		</div>
+		
+		<h3>.[page:number timeScale]</h3>
+		<div>
+		todo
+		</div>
 
+		<h3>.[page:boolean isPlaying]</h3>
+		<div>
+		todo
+		</div>
+		
+		<h3>.[page:boolean isPaused]</h3>
+		<div>
+		todo
+		</div>
+		
+		<h3>.[page:boolean loop]</h3>
+		<div>
+		todo
+		</div> 
+		
+		<h3>.[page:boolean JITCompile]</h3>
+		<div>
+		todo
+		</div>
 
 		<h2>Methods</h2>
+		
+		<h3>.play() [page:todo]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.pause() [page:todo]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.stop() [page:todo]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.update([page:todo deltaTimeMS]) [page:todo]</h3>
+		<div>
+		deltaTimeMS -- todo
+		</div>
+		<div>
+		todo
+		</div>
 
+		<h3>.interpolateCatmullRom([page:todo points], [page:todo scale]) [page:todo]</h3>
+		<div>
+		points -- todo <br />
+		scale -- todo
+		</div>
+		<div>
+		todo
+		</div>
 
+		<h3>.getNextKeyWith([page:todo sid], [page:todo h], [page:todo key]) [page:todo]</h3>
+		<div>
+		sid -- todo <br />
+		h -- todo <br />
+		key -- todo
+		</div>
+		<div>
+		todo
+		</div>
 
+		<h3>.getPrevKeyWith([page:todo sid], [page:todo h], [page:todo key]) [page:todo]</h3>
+		<div>
+		sid -- todo <br />
+		h -- todo <br />
+		key -- todo
+		</div>
+		<div>
+		todo
+		</div>
 		<h2>Source</h2>
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

+ 0 - 3
docs/api/extras/geometries/CircleGeometry.html

@@ -25,9 +25,6 @@
 		thetaLength — Circumference of the circle, default = 2*Pi (360°).
 		</div>
 		
-		<h2>Properties</h2>
-		
-		<h2>Methods</h2>
 
 		<h2>Source</h2>
 

+ 0 - 8
docs/api/extras/geometries/LatheGeometry.html

@@ -27,14 +27,6 @@
 		</div>
 
 
-		<h2>Properties</h2>
-
-
-
-		<h2>Methods</h2>
-
-
-
 		<h2>Source</h2>
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

+ 0 - 8
docs/api/extras/geometries/ParametricGeometry.html

@@ -27,14 +27,6 @@
 		</div>
 
 
-		<h2>Properties</h2>
-
-
-
-		<h2>Methods</h2>
-
-
-
 		<h2>Source</h2>
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

+ 0 - 3
docs/api/extras/geometries/PlaneGeometry.html

@@ -51,9 +51,6 @@
 		todo
 		</div> 
 
-		<h2>Methods</h2>
-
-
 
 		<h2>Source</h2>
 

+ 1 - 9
docs/api/extras/geometries/PolyhedronGeometry.html

@@ -25,15 +25,7 @@
 		<div>
 		todo
 		</div>
-
-
-		<h2>Properties</h2>
-
-
-
-		<h2>Methods</h2>
-
-
+		
 
 		<h2>Source</h2>
 

+ 0 - 8
docs/api/extras/geometries/RingGeometry.html

@@ -29,14 +29,6 @@
 		</div>
 
 
-		<h2>Properties</h2>
-
-
-
-		<h2>Methods</h2>
-
-
-
 		<h2>Source</h2>
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

+ 0 - 4
docs/api/extras/geometries/TorusGeometry.html

@@ -31,7 +31,6 @@
 		<h2>Properties</h2>
 
 
-
 		<h3>.[page:number radialSegments]</h3>
 		<div>
 		todo
@@ -57,9 +56,6 @@
 		todo
 		</div> 
 
-		<h2>Methods</h2>
-
-
 
 		<h2>Source</h2>
 

+ 0 - 4
docs/api/extras/geometries/TorusKnotGeometry.html

@@ -33,7 +33,6 @@
 		<h2>Properties</h2>
 
 
-
 		<h3>.[page:number radialSegments]</h3>
 		<div>
 		todo
@@ -74,9 +73,6 @@
 		todo
 		</div> 
 
-		<h2>Methods</h2>
-
-
 
 		<h2>Source</h2>
 

+ 49 - 1
docs/api/extras/geometries/TubeGeometry.html

@@ -31,12 +31,60 @@
 
 		<h2>Properties</h2>
 
+		<h3>.[page:todo path]</h3>
+		<div>
+		todo
+		</div> 
+
+		<h3>.[page:number segments]</h3>
+		<div>
+		todo
+		</div> 
 
+		<h3>.[page:number radius]</h3>
+		<div>
+		todo
+		</div> 
 
-		<h2>Methods</h2>
+		<h3>.[page:number radiusSegments]</h3>
+		<div>
+		todo
+		</div> 
+
+		<h3>.[page:boolean closed]</h3>
+		<div>
+		todo
+		</div> 
+
+		<h3>.[page:array tangents]</h3>
+		<div>
+		todo
+		</div> 
+
+		<h3>.[page:array normals]</h3>
+		<div>
+		todo
+		</div> 
 
+		<h3>.[page:array binormals]</h3>
+		<div>
+		todo
+		</div> 
 
 
+		<h2>Methods</h2>
+		
+
+		<h3>.FrenetFrames([page:todo path], [page:number segments], [page:boolean closed]) [page:todo]</h3>
+		<div>
+		path -- todo <br />
+		segments -- todo <br />
+		closed -- todo
+		</div>
+		<div>
+		todo
+		</div>
+		
 		<h2>Source</h2>
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

+ 14 - 0
docs/api/extras/helpers/HemisphereLightHelper.html

@@ -30,10 +30,24 @@
 		<h2>Properties</h2>
 
 
+		<h3>.[page:Mesh lightSphere]</h3>
+		<div>
+		todo
+		</div> 
+
+		<h3>.[page:HemisphereLight light]</h3>
+		<div>
+		todo
+		</div> 
+
 
 		<h2>Methods</h2>
 
 
+		<h3>.update() [page:todo]</h3>
+		<div>
+		todo
+		</div>
 
 		<h2>Source</h2>
 

+ 0 - 2
docs/api/lights/Light.html

@@ -32,8 +32,6 @@
 		<div>
 		Color of the light.<br />
 		</div>
-		
-		<h2>Methods</h2>
 
 		<h2>Source</h2>
 

+ 0 - 1
docs/api/materials/LineBasicMaterial.html

@@ -53,7 +53,6 @@
 		<div>Define whether the material color is affected by global fog settings.</div>
 		<div>This setting might not have any effect when used with certain renderers. For example, it is ignored with the [page:CanvasRenderer Canvas] renderer, but does work with the [page:WebGLRenderer WebGL] renderer.</div>
 
-		<h2>Methods</h2>
 		
 		<h2>Source</h2>
 

+ 85 - 0
docs/api/renderers/CanvasRenderer.html

@@ -27,10 +27,95 @@
 		<h2>Properties</h2>
 
 
+		<h3>.[page:object info]</h3>
+		<div>
+		todo
+		</div> 
+
+		<h3>.[page:object domElement]</h3>
+		<div>
+		todo
+		</div> 
+
+		<h3>.[page:number devicePixelRatio]</h3>
+		<div>
+		todo
+		</div> 
+
+		<h3>.[page:boolean autoClear]</h3>
+		<div>
+		todo
+		</div> 
+
+		<h3>.[page:boolean sortObjects]</h3>
+		<div>
+		todo
+		</div> 
+
+		<h3>.[page:boolean sortElements]</h3>
+		<div>
+		todo
+		</div> 
 
 		<h2>Methods</h2>
 
 
+		<h3>.getMaxAnisotropy() [page:todo]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.render([page:todo scene], [page:todo camera]) [page:todo]</h3>
+		<div>
+		scene -- todo <br />
+		camera -- todo
+		</div>
+		<div>
+		todo
+		</div>
+
+		<h3>.clear() [page:todo]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.setClearColor([page:todo color], [page:todo alpha]) [page:todo]</h3>
+		<div>
+		color -- todo <br />
+		alpha -- todo
+		</div>
+		<div>
+		todo
+		</div>
+
+		<h3>.setFaceCulling() [page:todo]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.supportsVertexTextures() [page:todo]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.setSize([page:todo width], [page:todo height], [page:todo updateStyle]) [page:todo]</h3>
+		<div>
+		width -- todo <br />
+		height -- todo <br />
+		updateStyle -- todo
+		</div>
+		<div>
+		todo
+		</div>
+
+		<h3>.setClearColorHex([page:todo hex], [page:todo alpha]) [page:todo]</h3>
+		<div>
+		hex -- todo <br />
+		alpha -- todo
+		</div>
+		<div>
+		todo
+		</div>
 
 		<h2>Source</h2>
 

+ 70 - 13
docs/api/renderers/WebGLRenderer.html

@@ -40,7 +40,7 @@
 		<div>A [page:Canvas] where the renderer draws its output.<br />
 		This is automatically created by the renderer in the constructor (if not provided already); you just need to add it to your page.</div>
 
-		<h3>.context</h3>
+		<h3>.[page:todo context]</h3>
 
 		<div>The HTML5 Canvas's 'webgl' context obtained from the canvas where the renderer will draw.</div>
 
@@ -77,13 +77,6 @@
 
 		<div>TODO</div>
 
-
-		<h3>.[page:Boolean autoUpdateScene]</h3>
-
-		<div>Defines whether the renderer should auto update the scene. Default is true.</div>
-
-		<div>TODO</div>
-
 		<!-- Physically based shading -->
 
 		<h3>.[page:Boolean gammaInput]</h3>
@@ -117,7 +110,7 @@
 		<div>Options are THREE.BasicShadowMap, THREE.PCFShadowMap, THREE.PCFSoftShadowMap. Default is THREE.PCFShadowMap.</div>
 
 
-		<h3>.[page:Boolean shadowMapCullFrontFaces]</h3>
+		<h3>.[page:Boolean shadowMapCullFace]</h3>
 
 		<div>Default is true. TODO</div>
 
@@ -182,6 +175,21 @@
 		</ul>
 		</div>
 
+		<h3>.[page:ShadowMapPlugin shadowMapPlugin]</h3>
+		<div>
+		todo
+		</div> 
+
+		<h3>.[page:number shadowMapCullFace]</h3>
+		<div>
+		todo
+		</div> 
+
+		<h3>.[page:number devicePixelRatio]</h3>
+		<div>
+		todo
+		</div> 
+
 		<h2>Methods</h2>
 
 		<h3>.getContext()</h3>
@@ -282,10 +290,6 @@
 		<div>If cullFace is false, culling will be disabled.</div>
 
 
-		<h3>.setObjectFaces( object )</h3>
-		<div>TODO.</div>
-
-
 		<h3>.setDepthTest( depthTest )</h3>
 		<div>TODO.</div>
 
@@ -307,6 +311,59 @@
 
 
 
+		<h3>.supportsCompressedTextureS3TC() [page:todo]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.getMaxAnisotropy() [page:todo]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.getPrecision() [page:todo]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.setMaterialFaces([page:todo material]) [page:todo]</h3>
+		<div>
+		material -- todo
+		</div>
+		<div>
+		todo
+		</div>
+
+		<h3>.supportsStandardDerivatives() [page:todo]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.supportsFloatTextures() [page:todo]</h3>
+		<div>
+		todo
+		</div>
+
+		<h3>.clearTarget([page:todo renderTarget], [page:todo color], [page:todo depth], [page:todo stencil]) [page:todo]</h3>
+		<div>
+		renderTarget -- todo <br />
+		color -- todo <br />
+		depth -- todo <br />
+		stencil -- todo
+		</div>
+		<div>
+		todo
+		</div>
+
+		<h3>.setClearColorHex([page:todo hex], [page:todo alpha]) [page:todo]</h3>
+		<div>
+		hex -- todo <br />
+		alpha -- todo
+		</div>
+		<div>
+		todo
+		</div>
+
 		<h2>Source</h2>
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]