diff --git a/docs/api/cameras/CubeCamera.html b/docs/api/cameras/CubeCamera.html index d4170ab9398edf01fbaf4f7c12edda725a2f71fa..18a0221b748fb7f9668bf0c8778f8ad00082261a 100644 --- a/docs/api/cameras/CubeCamera.html +++ b/docs/api/cameras/CubeCamera.html @@ -67,7 +67,7 @@ -

[method:todo updateCubeMap]([page:todo renderer], [page:todo scene])

+

[method:null updateCubeMap]([page:WebGLRenderer renderer], [page:Scene scene])

renderer -- The current WebGL renderer
scene -- The current scene diff --git a/docs/api/extras/ImageUtils.html b/docs/api/extras/ImageUtils.html index 72685bf531eab163587b4a0f55dbfc8c438212ca..0516023f00f047101c47878863314538c2b96327 100644 --- a/docs/api/extras/ImageUtils.html +++ b/docs/api/extras/ImageUtils.html @@ -44,18 +44,7 @@ Parses a DDS Image from the string into a CompressedTexture.
-

[method:todo loadCompressedTexture]([page:todo url], [page:todo mapping], [page:todo onLoad], [page:todo onError])

-
- url -- todo
- mapping -- todo
- onLoad -- todo
- onError -- todo -
-
- todo -
- -

[method:todo loadTexture]([page:String url], [page:UVMapping mapping], [page:Function onLoad], [page:Function onError])

+

[method:Texture loadTexture]([page:String url], [page:UVMapping mapping], [page:Function onLoad], [page:Function onError])

url -- the url of the texture
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.
Use undefined instead of null as a default value. See mapping property of [page:Texture texture] for more details.
@@ -63,38 +52,32 @@ onError -- callback function
- todo + A helper function to generates a [page:Texture THREE.Texture] from an image URL. Provides a load and error + callback.
-

[method:todo getNormalMap]([page:todo image], [page:todo depth])

+

[method:canvas getNormalMap]([page:Image image], [page:Float depth])

- image -- todo
- depth -- todo + image -- A loaded image element
+ depth -- The depth of the normal map. Defaults to between -1 and 1.
- todo + Translates an image element into a normal map with the range (-1, -1, -1) to (1, 1, 1) multiplied by the depth. + Returns a canvas element.
-

[method:todo loadCompressedTextureCube]([page:todo array], [page:todo mapping], [page:todo onLoad], [page:todo onError])

+

[method:CubeTexture loadTextureCube]([page:Array array], [page:Textures mapping], [page:function onLoad], [page:function onError])

- array -- todo
- mapping -- todo
- onLoad -- todo
- onError -- todo + array -- An array of 6 images
+ mapping -- Either [page:Textures THREE.CubeReflectionMapping] or [page:Textures THREE.CubeRefractionMapping]
+ onLoad -- callback
+ onError -- callback
- todo -
- -

[method:todo loadTextureCube]([page:todo array], [page:todo mapping], [page:todo onLoad], [page:todo onError])

-
- array -- todo
- mapping -- todo
- onLoad -- todo
- onError -- todo -
-
- todo + Creates a [page:CubeTexture] from 6 images.

+ + The images are loaded in the following order where p is positiive and n is negative: [ px, nx, py, ny, pz, nz ]. + See [page:CubeTexture] for an example in code.

Source

diff --git a/docs/api/extras/animation/Animation.html b/docs/api/extras/animation/Animation.html index 63d0726a417f766420c9dae9d5e21ef5b1e1bd02..ffde9733ece7a73c8cda30af9ee5953e1a211d7e 100644 --- a/docs/api/extras/animation/Animation.html +++ b/docs/api/extras/animation/Animation.html @@ -48,7 +48,7 @@

[property:number timeScale]

- The timez + How much to scale the speed of the animation. Defaults to 1.

[property:boolean isPlaying]

@@ -75,7 +75,7 @@

[method:null play]([page:Number startTime])

- Starts the animation from a moment startTime in the animation. + Starts the animation at the startTime (in seconds) of the animation.

[method:null stop]()

diff --git a/docs/api/extras/animation/AnimationMorphTarget.html b/docs/api/extras/animation/AnimationMorphTarget.html deleted file mode 100644 index 17a3c923bfe090ba13bbaed3ab444f80f1fb2723..0000000000000000000000000000000000000000 --- a/docs/api/extras/animation/AnimationMorphTarget.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - - - -

[name]

- -
todo
- - -

Constructor

- - -

[name]([page:todo root], [page:todo data])

-
- root -- todo
- data -- todo -
-
- todo -
- -

Properties

- -

[property:todo root]

-
- todo -
- -

[property:todo data]

-
- todo -
- -

[property:todo hierarchy]

-
- todo -
- -

[property:number currentTime]

-
- todo -
- -

[property:number timeScale]

-
- todo -
- -

[property:boolean isPlaying]

-
- todo -
- -

[property:boolean isPaused]

-
- todo -
- -

[property:boolean loop]

-
- todo -
- -

[property:number influence]

-
- todo -
- - -

Methods

- -

[method:todo play]()

-
- todo -
- -

[method:todo pause]()

-
- todo -
- -

[method:todo stop]()

-
- todo -
- -

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

-
- deltaTimeMS -- todo -
-
- todo -
- - -

Source

- - [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js] - - diff --git a/docs/api/extras/animation/KeyFrameAnimation.html b/docs/api/extras/animation/KeyFrameAnimation.html index f064146a1df333d207620420cb61e10d03aa8ca3..4120e8619c13f99915723507af94c1031fa44b1c 100644 --- a/docs/api/extras/animation/KeyFrameAnimation.html +++ b/docs/api/extras/animation/KeyFrameAnimation.html @@ -9,124 +9,106 @@

[name]

-
todo
+
Runs a keyframe animation as imported from the [page:ColladaLoader].
+ +

Examples

+ +
[example:webgl_loader_collada_keyframe loader / collada / keyframe ]

Constructor

-

[name]([page:todo root], [page:todo data], [page:todo JITCompile])

+

[name]([page:Object data])

- root -- todo
- data -- todo
- JITCompile -- todo + data -- An individual animation object from a the [page:ColladaLoader], e.g. loadedColladaObj.animations[0]
- todo + Creates a new keyframe animation and initializes it to the first keyframes.

Properties

-

[property:todo root]

+

[property:Object3D root]

- todo + The root object of the animation
-

[property:todo data]

+

[property:Object data]

- todo + The data containing the animation
-

[property:todo hierarchy]

+

[property:Array hierarchy]

- todo + The objects that are influenced by the animation.

[property:number currentTime]

- todo + The time elapsed since the last start/restart of the animation.

[property:number timeScale]

- todo + How much to scale the speed of the animation. Defaults to 1.

[property:boolean isPlaying]

- todo + Indicates whether the animation is playing. This shouldn't be adapted by user code.

[property:boolean isPaused]

- todo + Indicates whether the animation is paused. This shouldn't be adapted by user code.

[property:boolean loop]

- todo + Set to make the animation restart when the animation ends.
-

[property:boolean JITCompile]

-
- todo -
-

Methods

-

[method:todo play]()

+

[method:null play]([page:Number startTime])

- todo + Starts the animation at the startTime (in seconds) of the animation.
-

[method:todo pause]()

-
- todo -
- -

[method:todo stop]()

-
- todo -
- -

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

-
- deltaTimeMS -- todo -
+

[method:null stop]()

- todo + Stops the animation.
-

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

+

[method:null update]([page:Float deltaTime])

- points -- todo
- scale -- todo + deltaTime -- The change in time in seconds
- todo + Updates the keyframe animation
-

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

+

[method:Object getNextKeyWith]([page:String sid], [page:Integer h], [page:Integer key])

- sid -- todo
- h -- todo
- key -- todo + sid -- The string id
+ h -- The index in the heirarchy to use
+ key -- The index of which key to start from
- todo + Used internally to traverse the animation
-

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

+

[method:Object getPrevKeyWith]([page:String sid], [page:Integer h], [page:Integer key])

- sid -- todo
- h -- todo
- key -- todo + sid -- The string id
+ h -- The index in the heirarchy to use
+ key -- The index of which key to start from
- todo + Used internally to traverse the animation
-

Source

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js] diff --git a/docs/api/extras/core/Curve.html b/docs/api/extras/core/Curve.html index 6d15ea4292bf53232a1c4b3ecc56e57915dbd729..2b4b972eb70c5e29852cca05af705322f69ee956 100644 --- a/docs/api/extras/core/Curve.html +++ b/docs/api/extras/core/Curve.html @@ -9,7 +9,10 @@

[name]

-
An extensible curve object which contains methods for interpolation.
+
+ An abstract base class for creating a curve object that contains methods for interpolation. + For an array of Curves see [page:CurvePath]. +

Examples

@@ -27,7 +30,7 @@

Methods

[method:Vector getPoint]( t )

-
Returns a vector for point t of the curve where t is between 0 and 1
+
Returns a vector for point t of the curve where t is between 0 and 1. Must be implemented in the extending class.

[method:Vector getPointAt]( u )

Returns a vector for point at relative position in curve according to arc length
diff --git a/docs/api/extras/core/CurvePath.html b/docs/api/extras/core/CurvePath.html index 92437231e89bfd321c4010fce03ddfd906206d47..7626404a1f996fb6c3ecb93357f56bc01fca6870 100644 --- a/docs/api/extras/core/CurvePath.html +++ b/docs/api/extras/core/CurvePath.html @@ -11,7 +11,10 @@

[name]

-
todo
+
+ An abstract base class further extending [page:Curve]. A CurvePath is simply an array of connected curves, + but retains the api of a curve. +

Constructor

@@ -19,7 +22,7 @@

[name]()

- todo + The constructor take no parameters.
@@ -28,107 +31,107 @@

[property:array curves]

- todo + The array of [page:Curve]s

[property:array bends]

- todo + An array of [page:Curve]s used to transform and bend the curve using [page:CurvePath.getWrapPoints].

[property:boolean autoClose]

- todo + Whether or not to automatically close the path.

Methods

-

[method:todo getWrapPoints]([page:todo oldPts], [page:todo path])

+

[method:Array getWrapPoints]([page:Array vertices], [page:Curve curve])

- oldPts -- todo
- path -- todo + vertices -- An array of [page:Vector2]s to modify
+ curve -- An array of 2d [page:Curve]s
- todo + Modifies the array of vertices by warping it by the curve. The curve parameter also accepts objects with similar + interfaces such as [page:CurvePath], [page:Path], [page:SplineCurve], etc. Returns the original vertices after + modification.
-

[method:todo createPointsGeometry]([page:todo divisions])

+

[method:null addWrapPath]([page:Curve curve])

- divisions -- todo + curve -- A [page:Curve] or object with a similar interface.
- todo + Pushes a curve onto the bends array.
-

[method:todo addWrapPath]([page:todo bendpath])

+

[method:Geometry createGeometry]([page:Vector3 points])

- bendpath -- todo + points -- An array of [page:Vector3]s
- todo + Creates a geometry from points
-

[method:todo createGeometry]([page:todo points])

+

[method:Geometry createPointsGeometry]([page:Integer divisions])

- points -- todo + divisions -- How many segments to create with [page:Vector3]s. Defaults to 12.
- todo + Creates a [page:Geometry] object comprised of [page:Vector3]s
- -

[method:todo add]([page:todo curve])

+ +

[method:Geometry createSpacedPointsGeometry]([page:Integer divisions])

- curve -- todo + divisions -- How many segments to create with [page:Vector3]s. Defaults to 12.
- todo + Creates a [page:Geometry] object comprised of [page:Vector3]s that are equidistant.
+ -

[method:todo getTransformedSpacedPoints]([page:todo segments], [page:todo bends])

+

[method:null add]([page:Curve curve])

- segments -- todo
- bends -- todo + curve -- The [page:Curve curve] to add
- todo + Pushes a curve onto the curves array.
-

[method:todo createSpacedPointsGeometry]([page:todo divisions])

+

[method:null closePath]()

- divisions -- todo -
-
- todo + Adds a curve to close the path.
-

[method:todo closePath]()

+

[method:Object getBoundingBox]()

- todo + Returns an object with the keys minX, minY, maxX, maxY, (if 3d: maxZ, minZ)
-

[method:todo getBoundingBox]()

+

[method:Float getCurveLengths]()

- todo + Adds together the length of the curves
-

[method:todo getCurveLengths]()

+

[method:Array getTransformedPoints]([page:Integer segments], [page:Array bends])

- todo + segments -- The number of segments to create using the getPoints()
+ bends -- (optional) An array of [page:Curve]s used to transform the points. Defaults to this.bends if blank.
- -

[method:todo getTransformedPoints]([page:todo segments], [page:todo bends])

- segments -- todo
- bends -- todo + Uses this CurvePath to generate a series of points transformed by the curves in the bends array. Returns an + array of [page:Vector2]s.
+ +

[method:Array getTransformedSpacedPoints]([page:Integer segments], [page:Array bends])

- todo + segments -- The number of segments to create using the getPoints()
+ bends -- (optional) Defaults to this.bends if blank. An array of [page:Curve]s used to transform the points.
- -

[method:todo checkConnection]()

- todo + Uses this CurvePath to generate a series equidistant points that are then transformed by the curves in the bends. + Returns an array of [page:Vector2]s.

Source

diff --git a/docs/api/extras/core/Path.html b/docs/api/extras/core/Path.html index 38fb2fa64907d015dc7f9eefca6bfc17cb89930f..3ca482c1a9758e723e950ad1b8403404f6f7b09b 100644 --- a/docs/api/extras/core/Path.html +++ b/docs/api/extras/core/Path.html @@ -11,13 +11,16 @@

[name]

-
A 2d path representation, comprising of points, lines, and cubes, similar to the html5 2d canvas api. It extends CurvePath.
+
+ A 2d path representation, comprising of points, lines, and cubes, similar to the html5 2d canvas api. + It extends [page:CurvePath]. +

Constructor

-

[name]([page:todo points])

+

[name]([page:Array points])

points -- array of Vector2
@@ -36,40 +39,80 @@

Methods

-

[method:todo fromPoints]( vectors )

+

[method:null fromPoints]( [page:Array vector2s] )

Adds to the Path from the points. The first vector defines the offset. After that the lines get defined.
-

[method:todo moveTo]( x, y )

+

[method:null moveTo]( [page:Float x], [page:Float y] )

This moves the offset to x and y
-

[method:todo lineTo]( x, y )

+

[method:null lineTo]( [page:Float x], [page:Float y] )

This creates a line from the offset to X and Y and updates the offset to X and Y.
-

[method:todo quadraticCurveTo]( aCPx, aCPy, aX, aY )

-
This creates a quadratic curve from the offset to aX and aY with aCPx and aCPy as control point and updates the offset to aX and aY.
+

[method:null quadraticCurveTo]( [page:Float cpX], [page:Float cpY], [page:Float x], [page:Float y] )

+
This creates a quadratic curve from the offset to x and y with cpX and cpY as control point and updates the offset to x and y.
-

[method:todo bezierCurveTo]( aCP1x, aCP1y, aCP2x, aCP2y, aX, aY )

-
This creates a bezier curve from the offset to aX and aY with aCP1x, aCP1y and aCP1x, aCP1y as control points and updates the offset to aX and aY.
+

[method:null bezierCurveTo]( [page:Float cp1X], [page:Float cp1Y], [page:Float cp2X], [page:Float cp2Y], [page:Float x], [page:Float y] )

+
This creates a bezier curve from the last offset to x and y with cp1X, cp1Y and cp1X, cp1Y as control points and updates the offset to x and y.
-

.splineThru ( pts /*Array of Vector*/ )

-
todo
+

[method:null splineThru] ( [page:Array points] )

+
points - An array of [page:Vector2]s
+
Connects a new [page:SplineCurve] onto the path.
-

[method:todo arc]( aX, aY, aRadius, aStartAngle, aEndAngle, aClockwise )

-
todo
+

[method:null arc]( [page:Float x], [page:Float y], [page:Float radius], [page:Float startAngle], [page:Float endAngle], [page:Float clockwise] )

+
+ x, y -- The center of the arc offset from the last call + radius -- The radius of the arc + startAngle -- The start angle in radians + endAngle -- The end angle in radians + clockwise -- Sweep the arc clockwise. Defaults to false +
+
Draw an arc offset from the last call
-

[method:todo absarc]( aX, aY, aRadius, aStartAngle, aEndAngle, aClockwise )

-
todo
+

[method:null absarc]( [page:Float x], [page:Float y], [page:Float radius], [page:Float startAngle], [page:Float endAngle], [page:Float clockwise] )

+
+ x, y -- The absolute center of the arc + radius -- The radius of the arc + startAngle -- The start angle in radians + endAngle -- The end angle in radians + clockwise -- Sweep the arc clockwise. Defaults to false +
+
Draw an arc absolutely positioned
-

[method:todo ellipse]( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise )

-
todo
+

[method:null ellipse]( [page:Float x], [page:Float y], [page:Float xRadius], [page:Float yRadius], [page:Float startAngle], [page:Float endAngle], [page:Float clockwise] )

+
+ x, y -- The center of the ellipse offset from the last call + xRadius -- The radius of the ellipse in the x axis + yRadius -- The radius of the ellipse in the y axis + startAngle -- The start angle in radians + endAngle -- The end angle in radians + clockwise -- Sweep the ellipse clockwise. Defaults to false +
+
Draw an ellipse offset from the last call
-

[method:todo absellipse]( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise )

-
todo
+

[method:null absellipse]( [page:Float x], [page:Float y], [page:Float xRadius], [page:Float yRadius], [page:Float startAngle], [page:Float endAngle], [page:Float clockwise] )

+
+ x, y -- The absolute center of the ellipse + xRadius -- The radius of the ellipse in the x axis + yRadius -- The radius of the ellipse in the y axis + startAngle -- The start angle in radians + endAngle -- The end angle in radians + clockwise -- Sweep the ellipse clockwise. Defaults to false +
+
Draw an ellipse absolutely positioned
-

[method:todo toShapes]()

-
todo
+

[method:Array toShapes]( [page:Boolean isCCW], [page:Boolean noHoles] )

+
+ isCCW -- Changes how solids and holes are generated
+ noHoles -- Whether or not to generate holes +
+
+ Converts the Path into an array of Shapes. By default solid shapes are defined clockwise (CW) and holes are defined counterclockwise (CCW). If isCCW is set to true, + then those are flipped. If the paramater noHoles is set to true then all paths are set as solid shapes and isCCW is ignored. +
+ +

Source

diff --git a/docs/api/textures/CubeTexture.html b/docs/api/textures/CubeTexture.html new file mode 100644 index 0000000000000000000000000000000000000000..0cd112dbbfe43e93147d9b1aab41469a1a7d3612 --- /dev/null +++ b/docs/api/textures/CubeTexture.html @@ -0,0 +1,58 @@ + + + + + + + + + + [page:Texture] → + +

[name]

+ +
Creates a cube texture made up of six images.
+ +

Example

+ + + var path = "textures/cube/pisa/"; + var format = '.png'; + var urls = [ + path + 'px' + format, path + 'nx' + format, + path + 'py' + format, path + 'ny' + format, + path + 'pz' + format, path + 'nz' + format + ]; + + var textureCube = THREE.ImageUtils.loadTextureCube( urls ); + var material = new THREE.MeshBasicMaterial( { color: 0xffffff, envMap: textureCube } ); + + +

Constructor

+ + +

[name]( images, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy )

+ +
+ CubeTexture is almost equivalent in functionality and usage to [page:Texture]. The only differences are that the + images are an array of 6 images as opposed to a single image, and the mapping options are + [page:Textures THREE.CubeReflectionMapping] (default) or [page:Textures THREE.CubeRefractionMapping]
+
+ Generally [page:ImageUtils.loadTextureCube] is used instead of using CubeTexture directly. +
+ + +

Properties

+ +

See [page:Texture]

+ +

Methods

+ + +

See [page:Texture]

+ +

Source

+ + [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js] + + diff --git a/docs/list.js b/docs/list.js index 021b4d9c9797f14da916a00f0a2440e9c2e56873..6ef9a42bb8c0aba7d9f2d769976600c117265e6b 100644 --- a/docs/list.js +++ b/docs/list.js @@ -151,6 +151,7 @@ var list = { ], "Textures": [ + [ "CubeTexture", "api/textures/CubeTexture" ], [ "CompressedTexture", "api/textures/CompressedTexture" ], [ "DataTexture", "api/textures/DataTexture" ], [ "Texture", "api/textures/Texture" ] @@ -166,8 +167,7 @@ var list = { "Extras / Animation": [ [ "Animation", "api/extras/animation/Animation" ], [ "AnimationHandler", "api/extras/animation/AnimationHandler" ], - [ "KeyFrameAnimation", "api/extras/animation/KeyFrameAnimation" ], - [ "AnimationMorphTarget", "api/extras/animation/AnimationMorphTarget" ] + [ "KeyFrameAnimation", "api/extras/animation/KeyFrameAnimation" ] ], "Extras / Core": [