From 9a4afcb914c97eae1e4cf6ac4f87116fae00c1cf Mon Sep 17 00:00:00 2001 From: cjshannon Date: Wed, 1 May 2013 10:59:58 -0400 Subject: [PATCH] added documentation --- docs/api/extras/animation/Animation.html | 105 +++++++++++++++++- .../animation/AnimationMorphTarget.html | 66 +++++++++++ .../extras/animation/KeyFrameAnimation.html | 92 +++++++++++++++ .../api/extras/geometries/CircleGeometry.html | 3 - docs/api/extras/geometries/LatheGeometry.html | 8 -- .../extras/geometries/ParametricGeometry.html | 8 -- docs/api/extras/geometries/PlaneGeometry.html | 3 - .../extras/geometries/PolyhedronGeometry.html | 10 +- docs/api/extras/geometries/RingGeometry.html | 8 -- docs/api/extras/geometries/TorusGeometry.html | 4 - .../extras/geometries/TorusKnotGeometry.html | 4 - docs/api/extras/geometries/TubeGeometry.html | 50 ++++++++- .../extras/helpers/HemisphereLightHelper.html | 14 +++ docs/api/lights/Light.html | 2 - docs/api/materials/LineBasicMaterial.html | 1 - docs/api/renderers/CanvasRenderer.html | 85 ++++++++++++++ docs/api/renderers/WebGLRenderer.html | 83 +++++++++++--- 17 files changed, 481 insertions(+), 65 deletions(-) diff --git a/docs/api/extras/animation/Animation.html b/docs/api/extras/animation/Animation.html index 930f07b140..90c2afcd07 100644 --- a/docs/api/extras/animation/Animation.html +++ b/docs/api/extras/animation/Animation.html @@ -25,13 +25,116 @@ todo -

Properties

+

.[page:todo root]

+
+ todo +
+ +

.[page:todo data]

+
+ todo +
+ +

.[page:todo hierarchy]

+
+ todo +
+ +

.[page:number currentTime]

+
+ todo +
+ +

.[page:number timeScale]

+
+ todo +
+ +

.[page:boolean isPlaying]

+
+ todo +
+ +

.[page:boolean isPaused]

+
+ todo +
+ +

.[page:boolean loop]

+
+ todo +
+ +

.[page:number interpolationType]

+
+ todo +
+

.[page:array points]

+
+ todo +
+ +

.[page:Vector3 target]

+
+ todo +

Methods

+ +

.play() [page:todo]

+
+ todo +
+

.pause() [page:todo]

+
+ todo +
+ +

.stop() [page:todo]

+
+ todo +
+ +

.update([page:todo deltaTimeMS]) [page:todo]

+
+ deltaTimeMS -- todo +
+
+ todo +
+ +

.interpolateCatmullRom([page:todo points], [page:todo scale]) [page:todo]

+
+ points -- todo
+ scale -- todo +
+
+ todo +
+ +

.getNextKeyWith([page:todo type], [page:todo h], [page:todo key]) [page:todo]

+
+ type -- todo
+ h -- todo
+ key -- todo +
+
+ todo +
+ +

.getPrevKeyWith([page:todo type], [page:todo h], [page:todo key]) [page:todo]

+
+ type -- todo
+ h -- todo
+ key -- todo +
+
+ todo +

Source

diff --git a/docs/api/extras/animation/AnimationMorphTarget.html b/docs/api/extras/animation/AnimationMorphTarget.html index e65878cb75..4fd7e355a6 100644 --- a/docs/api/extras/animation/AnimationMorphTarget.html +++ b/docs/api/extras/animation/AnimationMorphTarget.html @@ -25,11 +25,77 @@

Properties

+ +

.[page:todo root]

+
+ todo +
+

.[page:todo data]

+
+ todo +
+ +

.[page:todo hierarchy]

+
+ todo +
+ +

.[page:number currentTime]

+
+ todo +
+ +

.[page:number timeScale]

+
+ todo +
+ +

.[page:boolean isPlaying]

+
+ todo +
+ +

.[page:boolean isPaused]

+
+ todo +
+ +

.[page:boolean loop]

+
+ todo +
+ +

.[page:number influence]

+
+ todo +

Methods

+

.play() [page:todo]

+
+ todo +
+ +

.pause() [page:todo]

+
+ todo +
+ +

.stop() [page:todo]

+
+ todo +
+ +

.update([page:todo deltaTimeMS]) [page:todo]

+
+ deltaTimeMS -- todo +
+
+ todo +

Source

diff --git a/docs/api/extras/animation/KeyFrameAnimation.html b/docs/api/extras/animation/KeyFrameAnimation.html index c1999cfa60..135b3f6a22 100644 --- a/docs/api/extras/animation/KeyFrameAnimation.html +++ b/docs/api/extras/animation/KeyFrameAnimation.html @@ -28,12 +28,104 @@

Properties

+

.[page:todo root]

+
+ todo +
+ +

.[page:todo data]

+
+ todo +
+ +

.[page:todo hierarchy]

+
+ todo +
+ +

.[page:number currentTime]

+
+ todo +
+ +

.[page:number timeScale]

+
+ todo +
+

.[page:boolean isPlaying]

+
+ todo +
+ +

.[page:boolean isPaused]

+
+ todo +
+ +

.[page:boolean loop]

+
+ todo +
+ +

.[page:boolean JITCompile]

+
+ todo +

Methods

+ +

.play() [page:todo]

+
+ todo +
+ +

.pause() [page:todo]

+
+ todo +
+ +

.stop() [page:todo]

+
+ todo +
+ +

.update([page:todo deltaTimeMS]) [page:todo]

+
+ deltaTimeMS -- todo +
+
+ todo +
+

.interpolateCatmullRom([page:todo points], [page:todo scale]) [page:todo]

+
+ points -- todo
+ scale -- todo +
+
+ todo +
+

.getNextKeyWith([page:todo sid], [page:todo h], [page:todo key]) [page:todo]

+
+ sid -- todo
+ h -- todo
+ key -- todo +
+
+ todo +
+

.getPrevKeyWith([page:todo sid], [page:todo h], [page:todo key]) [page:todo]

+
+ sid -- todo
+ h -- todo
+ key -- todo +
+
+ todo +

Source

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js] diff --git a/docs/api/extras/geometries/CircleGeometry.html b/docs/api/extras/geometries/CircleGeometry.html index ce21ff5f52..be956c11d7 100644 --- a/docs/api/extras/geometries/CircleGeometry.html +++ b/docs/api/extras/geometries/CircleGeometry.html @@ -25,9 +25,6 @@ thetaLength — Circumference of the circle, default = 2*Pi (360°). -

Properties

- -

Methods

Source

diff --git a/docs/api/extras/geometries/LatheGeometry.html b/docs/api/extras/geometries/LatheGeometry.html index 0da8a89f43..06de658717 100644 --- a/docs/api/extras/geometries/LatheGeometry.html +++ b/docs/api/extras/geometries/LatheGeometry.html @@ -27,14 +27,6 @@ -

Properties

- - - -

Methods

- - -

Source

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js] diff --git a/docs/api/extras/geometries/ParametricGeometry.html b/docs/api/extras/geometries/ParametricGeometry.html index 502caa14d8..f92c89aaf1 100644 --- a/docs/api/extras/geometries/ParametricGeometry.html +++ b/docs/api/extras/geometries/ParametricGeometry.html @@ -27,14 +27,6 @@ -

Properties

- - - -

Methods

- - -

Source

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js] diff --git a/docs/api/extras/geometries/PlaneGeometry.html b/docs/api/extras/geometries/PlaneGeometry.html index 8f8341d534..cfa13b7678 100644 --- a/docs/api/extras/geometries/PlaneGeometry.html +++ b/docs/api/extras/geometries/PlaneGeometry.html @@ -51,9 +51,6 @@ todo -

Methods

- -

Source

diff --git a/docs/api/extras/geometries/PolyhedronGeometry.html b/docs/api/extras/geometries/PolyhedronGeometry.html index c790f16857..e872afb2b9 100644 --- a/docs/api/extras/geometries/PolyhedronGeometry.html +++ b/docs/api/extras/geometries/PolyhedronGeometry.html @@ -25,15 +25,7 @@
todo
- - -

Properties

- - - -

Methods

- - +

Source

diff --git a/docs/api/extras/geometries/RingGeometry.html b/docs/api/extras/geometries/RingGeometry.html index 3df69d88b3..83f593d1c3 100644 --- a/docs/api/extras/geometries/RingGeometry.html +++ b/docs/api/extras/geometries/RingGeometry.html @@ -29,14 +29,6 @@ -

Properties

- - - -

Methods

- - -

Source

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js] diff --git a/docs/api/extras/geometries/TorusGeometry.html b/docs/api/extras/geometries/TorusGeometry.html index 06e1169cef..3603f15a9b 100644 --- a/docs/api/extras/geometries/TorusGeometry.html +++ b/docs/api/extras/geometries/TorusGeometry.html @@ -31,7 +31,6 @@

Properties

-

.[page:number radialSegments]

todo @@ -57,9 +56,6 @@ todo
-

Methods

- -

Source

diff --git a/docs/api/extras/geometries/TorusKnotGeometry.html b/docs/api/extras/geometries/TorusKnotGeometry.html index 3b89dd83d1..00b809e2d5 100644 --- a/docs/api/extras/geometries/TorusKnotGeometry.html +++ b/docs/api/extras/geometries/TorusKnotGeometry.html @@ -33,7 +33,6 @@

Properties

-

.[page:number radialSegments]

todo @@ -74,9 +73,6 @@ todo
-

Methods

- -

Source

diff --git a/docs/api/extras/geometries/TubeGeometry.html b/docs/api/extras/geometries/TubeGeometry.html index c96445cf98..abcb1be759 100644 --- a/docs/api/extras/geometries/TubeGeometry.html +++ b/docs/api/extras/geometries/TubeGeometry.html @@ -31,12 +31,60 @@

Properties

+

.[page:todo path]

+
+ todo +
+ +

.[page:number segments]

+
+ todo +
+

.[page:number radius]

+
+ todo +
-

Methods

+

.[page:number radiusSegments]

+
+ todo +
+ +

.[page:boolean closed]

+
+ todo +
+ +

.[page:array tangents]

+
+ todo +
+ +

.[page:array normals]

+
+ todo +
+

.[page:array binormals]

+
+ todo +
+

Methods

+ + +

.FrenetFrames([page:todo path], [page:number segments], [page:boolean closed]) [page:todo]

+
+ path -- todo
+ segments -- todo
+ closed -- todo +
+
+ todo +
+

Source

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js] diff --git a/docs/api/extras/helpers/HemisphereLightHelper.html b/docs/api/extras/helpers/HemisphereLightHelper.html index 43aaa4eefc..ea37ac7d57 100644 --- a/docs/api/extras/helpers/HemisphereLightHelper.html +++ b/docs/api/extras/helpers/HemisphereLightHelper.html @@ -30,10 +30,24 @@

Properties

+

.[page:Mesh lightSphere]

+
+ todo +
+ +

.[page:HemisphereLight light]

+
+ todo +
+

Methods

+

.update() [page:todo]

+
+ todo +

Source

diff --git a/docs/api/lights/Light.html b/docs/api/lights/Light.html index ceda906c3c..e4427ff7b5 100644 --- a/docs/api/lights/Light.html +++ b/docs/api/lights/Light.html @@ -32,8 +32,6 @@
Color of the light.
- -

Methods

Source

diff --git a/docs/api/materials/LineBasicMaterial.html b/docs/api/materials/LineBasicMaterial.html index 6669a46297..33e629b113 100644 --- a/docs/api/materials/LineBasicMaterial.html +++ b/docs/api/materials/LineBasicMaterial.html @@ -53,7 +53,6 @@
Define whether the material color is affected by global fog settings.
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.
-

Methods

Source

diff --git a/docs/api/renderers/CanvasRenderer.html b/docs/api/renderers/CanvasRenderer.html index aad36cf61b..72cd10bc95 100644 --- a/docs/api/renderers/CanvasRenderer.html +++ b/docs/api/renderers/CanvasRenderer.html @@ -27,10 +27,95 @@

Properties

+

.[page:object info]

+
+ todo +
+ +

.[page:object domElement]

+
+ todo +
+ +

.[page:number devicePixelRatio]

+
+ todo +
+ +

.[page:boolean autoClear]

+
+ todo +
+ +

.[page:boolean sortObjects]

+
+ todo +
+ +

.[page:boolean sortElements]

+
+ todo +

Methods

+

.getMaxAnisotropy() [page:todo]

+
+ todo +
+ +

.render([page:todo scene], [page:todo camera]) [page:todo]

+
+ scene -- todo
+ camera -- todo +
+
+ todo +
+ +

.clear() [page:todo]

+
+ todo +
+ +

.setClearColor([page:todo color], [page:todo alpha]) [page:todo]

+
+ color -- todo
+ alpha -- todo +
+
+ todo +
+ +

.setFaceCulling() [page:todo]

+
+ todo +
+ +

.supportsVertexTextures() [page:todo]

+
+ todo +
+ +

.setSize([page:todo width], [page:todo height], [page:todo updateStyle]) [page:todo]

+
+ width -- todo
+ height -- todo
+ updateStyle -- todo +
+
+ todo +
+ +

.setClearColorHex([page:todo hex], [page:todo alpha]) [page:todo]

+
+ hex -- todo
+ alpha -- todo +
+
+ todo +

Source

diff --git a/docs/api/renderers/WebGLRenderer.html b/docs/api/renderers/WebGLRenderer.html index 5ee0053741..ba69c630eb 100644 --- a/docs/api/renderers/WebGLRenderer.html +++ b/docs/api/renderers/WebGLRenderer.html @@ -40,7 +40,7 @@
A [page:Canvas] where the renderer draws its output.
This is automatically created by the renderer in the constructor (if not provided already); you just need to add it to your page.
-

.context

+

.[page:todo context]

The HTML5 Canvas's 'webgl' context obtained from the canvas where the renderer will draw.
@@ -77,13 +77,6 @@
TODO
- -

.[page:Boolean autoUpdateScene]

- -
Defines whether the renderer should auto update the scene. Default is true.
- -
TODO
-

.[page:Boolean gammaInput]

@@ -117,7 +110,7 @@
Options are THREE.BasicShadowMap, THREE.PCFShadowMap, THREE.PCFSoftShadowMap. Default is THREE.PCFShadowMap.
-

.[page:Boolean shadowMapCullFrontFaces]

+

.[page:Boolean shadowMapCullFace]

Default is true. TODO
@@ -182,6 +175,21 @@ +

.[page:ShadowMapPlugin shadowMapPlugin]

+
+ todo +
+ +

.[page:number shadowMapCullFace]

+
+ todo +
+ +

.[page:number devicePixelRatio]

+
+ todo +
+

Methods

.getContext()

@@ -282,10 +290,6 @@
If cullFace is false, culling will be disabled.
-

.setObjectFaces( object )

-
TODO.
- -

.setDepthTest( depthTest )

TODO.
@@ -307,6 +311,59 @@ +

.supportsCompressedTextureS3TC() [page:todo]

+
+ todo +
+ +

.getMaxAnisotropy() [page:todo]

+
+ todo +
+ +

.getPrecision() [page:todo]

+
+ todo +
+ +

.setMaterialFaces([page:todo material]) [page:todo]

+
+ material -- todo +
+
+ todo +
+ +

.supportsStandardDerivatives() [page:todo]

+
+ todo +
+ +

.supportsFloatTextures() [page:todo]

+
+ todo +
+ +

.clearTarget([page:todo renderTarget], [page:todo color], [page:todo depth], [page:todo stencil]) [page:todo]

+
+ renderTarget -- todo
+ color -- todo
+ depth -- todo
+ stencil -- todo +
+
+ todo +
+ +

.setClearColorHex([page:todo hex], [page:todo alpha]) [page:todo]

+
+ hex -- todo
+ alpha -- todo +
+
+ todo +
+

Source

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