diff --git a/docs/api/extras/curves/CatmullRomCurve3.html b/docs/api/extras/curves/CatmullRomCurve3.html index 930e09be0b5e542d09a99be8315782a03179648d..d09d7da9e3ea89a9b763b332207331f2dcbf8de9 100644 --- a/docs/api/extras/curves/CatmullRomCurve3.html +++ b/docs/api/extras/curves/CatmullRomCurve3.html @@ -12,7 +12,8 @@

[name]

-
Create a smooth 3d spline curve from a series of points using the Catmull-Rom algorithm
+
Create a smooth 3d spline curve from a series of points using the + [link:https://en.wikipedia.org/wiki/Centripetal_Catmull-Rom_spline Catmull-Rom] algorithm.

Example

@@ -30,6 +31,9 @@ var geometry = new THREE.Geometry(); geometry.vertices = curve.getPoints( 50 ); var material = new THREE.LineBasicMaterial( { color : 0xff0000 } ); + +// Create the final object to add to the scene +var curveObject = new THREE.Line( geometry, material );

[example:webgl_geometry_extrude_splines geometry / extrude / splines]

@@ -37,23 +41,30 @@ var material = new THREE.LineBasicMaterial( { color : 0xff0000 } );

Constructor

-

[name]( [page:Array points] )

points – An array of [page:Vector3] points
+ + +

Properties

+
See the base [page:Curve] class for common properties.

[property:Array points]

- -

[property:Boolean closed] – curve loops back onto itself when true. False by default.

- -

[property:String type] - possible values are `centripetal` (default), `chordal` and `catmullrom`

- -

[property:float tension] - when type is `catmullrom`, defines catmullrom's tension. Defaults to 0.5

+
The array of array of [page:Vector3] points that define the curve.
-

Methods

+

[property:Boolean closed]

+
The curve will loop back onto itself when this is true. False by default
+ +

[property:String type]

+
Possible values are `centripetal` (default), `chordal` and `catmullrom`.
+ +

[property:float tension]

+
When [page:.type] is `catmullrom`, defines catmullrom's tension. Defaults is *0.5*.
-

See [page:Curve] for inherited methods

+ +

Methods

+
See the base [page:Curve] class for common methods.
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js] diff --git a/docs/api/extras/curves/ClosedSplineCurve3.html b/docs/api/extras/curves/ClosedSplineCurve3.html deleted file mode 100644 index d3944ea232aa4e499f4dd852536f215e4f103103..0000000000000000000000000000000000000000 --- a/docs/api/extras/curves/ClosedSplineCurve3.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - - - - [page:Curve] → - -

[name]

- -
Create a smooth 3d spline curve from a series of points that loops back onto itself. THREE.ClosedSplineCurve3 has been deprecated. Please use THREE.CatmullRomCurve3
- -

Example

- - -//Create a closed wavey loop -var curve = new THREE.ClosedSplineCurve3( [ - new THREE.Vector3( -10, 0, 10 ), - new THREE.Vector3( -5, 5, 5 ), - new THREE.Vector3( 0, 0, 0 ), - new THREE.Vector3( 5, -5, 5 ), - new THREE.Vector3( 10, 0, 10 ) -] ); - -var geometry = new THREE.Geometry(); -geometry.vertices = curve.getPoints( 50 ); - -var material = new THREE.LineBasicMaterial( { color : 0xff0000 } ); - - -

[example:webgl_geometry_extrude_splines geometry / extrude / splines] (choose SampleClosedSpline)

- - -

Constructor

- - -

[name]( [page:Array points] )

-
points – An array of [page:Vector3] points
- - -

Properties

- -

[property:Array points]

- -

Methods

- -

See [page:Curve] for inherited methods

- - [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js] - - diff --git a/docs/api/extras/curves/CubicBezierCurve.html b/docs/api/extras/curves/CubicBezierCurve.html index 3b556fd6d59ae649ec71f1d163210c667574d0d8..59e7dc854c2a2f99ec20f261cf4afff79b663a72 100644 --- a/docs/api/extras/curves/CubicBezierCurve.html +++ b/docs/api/extras/curves/CubicBezierCurve.html @@ -13,17 +13,19 @@

[name]

- Create a smooth 2d cubic bezier curve. + Create a smooth 2d + cubic bezier curve, + defined by a start point, endpoint and two control points.

Example

var curve = new THREE.CubicBezierCurve( - new THREE.Vector3( -10, 0, 0 ), - new THREE.Vector3( -5, 15, 0 ), - new THREE.Vector3( 20, 15, 0 ), - new THREE.Vector3( 10, 0, 0 ) + new THREE.Vector2( -10, 0, 0 ), + new THREE.Vector2( -5, 15, 0 ), + new THREE.Vector2( 20, 15, 0 ), + new THREE.Vector2( 10, 0, 0 ) ); var path = new THREE.Path( curve.getPoints( 50 ) ); @@ -31,7 +33,7 @@ var path = new THREE.Path( curve.getPoints( 50 ) ); var geometry = path.createPointsGeometry( 50 ); var material = new THREE.LineBasicMaterial( { color : 0xff0000 } ); -// Create the final Object3d to add to the scene +// Create the final object to add to the scene var curveObject = new THREE.Line( geometry, material ); @@ -40,26 +42,30 @@ var curveObject = new THREE.Line( geometry, material );

[name] ( [page:Vector2 v0], [page:Vector2 v1], [page:Vector2 v2], [page:Vector2 v3] )

- [page:Vector2 v0] – The starting point
- [page:Vector2 v1] – The first control point
- [page:Vector2 v2] – The second control point
- [page:Vector2 v3] – The ending point
+ [page:Vector2 v0] – The starting point.
+ [page:Vector2 v1] – The first control point.
+ [page:Vector2 v2] – The second control point.
+ [page:Vector2 v3] – The ending point.

Properties

+
See the base [page:Curve] class for common properties.

[property:Vector2 v0]

+
The starting point.

[property:Vector2 v1]

+
The first control point.

[property:Vector2 v2]

+
The second control point.

[property:Vector2 v3]

+
The ending point.

Methods

- -

See [page:Curve] for inherited methods

+
See the base [page:Curve] class for common Methods.

Source

diff --git a/docs/api/extras/curves/CubicBezierCurve3.html b/docs/api/extras/curves/CubicBezierCurve3.html index a8cd63ed603073d92ae19cde8e686bec4ec08c6b..37414cff23044255a9b97d81db5a170edf6ed896 100644 --- a/docs/api/extras/curves/CubicBezierCurve3.html +++ b/docs/api/extras/curves/CubicBezierCurve3.html @@ -13,7 +13,9 @@

[name]

- Create a smooth 3d cubic bezier curve. + Create a smooth 3d + cubic bezier curve, + defined by a start point, endpoint and two control points.

Example

@@ -31,7 +33,7 @@ geometry.vertices = curve.getPoints( 50 ); var material = new THREE.LineBasicMaterial( { color : 0xff0000 } ); -// Create the final Object3d to add to the scene +// Create the final object to add to the scene var curveObject = new THREE.Line( geometry, material ); @@ -41,26 +43,31 @@ var curveObject = new THREE.Line( geometry, material );

[name]( [page:Vector3 v0], [page:Vector3 v1], [page:Vector3 v2], [page:Vector3 v3] )

- [page:Vector3 v0] – The starting point
- [page:Vector3 v1] – The first control point
- [page:Vector3 v2] – The second control point
- [page:Vector3 v3] – The ending point
+ [page:Vector3 v0] – The starting point.
+ [page:Vector3 v1] – The first control point.
+ [page:Vector3 v2] – The second control point.
+ [page:Vector3 v3] – The ending point.

Properties

+
See the base [page:Curve] class for common properties.
-

[property:Vector3 v0]

+

[property:Vector2 v0]

+
The starting point.
-

[property:Vector3 v1]

+

[property:Vector2 v1]

+
The first control point.
-

[property:Vector3 v2]

+

[property:Vector2 v2]

+
The second control point.
-

[property:Vector3 v3]

+

[property:Vector2 v3]

+
The ending point.

Methods

+
See the base [page:Curve] class for common Methods.
-

See [page:Curve] for inherited methods

Source

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js] diff --git a/docs/api/extras/curves/EllipseCurve.html b/docs/api/extras/curves/EllipseCurve.html index 09fa7464d07ee7af1a9c2b5956bfb0e5beb4d9e2..3d27c0a8d68532931f3763069ad96e5ccd62bd57 100644 --- a/docs/api/extras/curves/EllipseCurve.html +++ b/docs/api/extras/curves/EllipseCurve.html @@ -12,7 +12,10 @@

[name]

-
Creates a 2d curve in the shape of an ellipse.
+
+ Creates a 2d curve in the shape of an ellipse. Setting the + [page:Number xRadius] equal to the [page:Number yRadius] will result in a circle. +

Example

@@ -22,14 +25,14 @@ var curve = new THREE.EllipseCurve( 10, 10, // xRadius, yRadius 0, 2 * Math.PI, // aStartAngle, aEndAngle false, // aClockwise - 0 // aRotation + 0 // aRotation ); var path = new THREE.Path( curve.getPoints( 50 ) ); var geometry = path.createPointsGeometry( 50 ); var material = new THREE.LineBasicMaterial( { color : 0xff0000 } ); -// Create the final Object3d to add to the scene +// Create the final object to add to the scene var ellipse = new THREE.Line( geometry, material ); @@ -38,33 +41,54 @@ var ellipse = new THREE.Line( geometry, material );

[name]( [page:Float aX], [page:Float aY], [page:Float xRadius], [page:Float yRadius], [page:Radians aStartAngle], [page:Radians aEndAngle], [page:Boolean aClockwise], [page:Radians aRotation] )

- aX – The X center of the ellipse
- aY – The Y center of the ellipse
- xRadius – The radius of the ellipse in the x direction
- yRadius – The radius of the ellipse in the y direction
- aStartAngle – The start angle of the curve in radians starting from the middle right side
- aEndAngle – The end angle of the curve in radians starting from the middle right side
- aClockwise – Whether the ellipse is clockwise
- aRotation – The rotation angle of the ellipse in radians, counterclockwise from the positive X axis (optional)

- - Note: When going clockwise it's best to set the start angle to (Math.PI * 2) and then work towards lower numbers. + [page:Float aX] – The X center of the ellipse.
+ [page:Float aY] – The Y center of the ellipse.
+ [page:Float xRadius] – The radius of the ellipse in the x direction.
+ [page:Float yRadius] – The radius of the ellipse in the y direction.
+ [page:Radians aStartAngle] – The start angle of the curve in radians starting from the middle right side.
+ [page:Radians aEndAngle] – The end angle of the curve in radians starting from the middle right side.
+ [page:Boolean aClockwise] – Whether the ellipse is drawn clockwise.
+ [page:Radians aRotation] – The rotation angle of the ellipse in radians, counterclockwise from the positive X axis (optional). Default is *0*.

+ + Note: When going clockwise it's best to set the start angle to (Math.PI * 2) and then work towards lower numbers.
-

Properties

+
See the base [page:Curve] class for common properties.

[property:Float aX]

+
The X center of the ellipse.
+

[property:Float aY]

+
The Y center of the ellipse.
+

[property:Radians xRadius]

+
The radius of the ellipse in the x direction.
+

[property:Radians yRadius]

+
The radius of the ellipse in the y direction.
+

[property:Float aStartAngle]

+
The start angle of the curve in radians starting from the middle right side.
+

[property:Float aEndAngle]

+
The end angle of the curve in radians starting from the middle right side.
+

[property:Boolean aClockwise]

+
Whether the ellipse is drawn clockwise.
+

[property:Float aRotation]

+
The rotation angle of the ellipse in radians, counterclockwise from the positive X axis (optional). Default is *0*.
-

Methods

+

[property:Boolean isEllipseCurve]

+
+ Used to check whether this or derived classes are ellipses. Default is *true*.

-

See [page:Curve] for inherited methods

+ You should not change this, as it used internally for optimisation. +
+ +

Methods

+
See the base [page:Curve] class for common methods.

Source

diff --git a/docs/api/extras/curves/LineCurve.html b/docs/api/extras/curves/LineCurve.html index a913822c5b837aba18a3740dd751898a5a9845e4..c77806d049f81e35cfc13a2d1fe94d9379fd1fb6 100644 --- a/docs/api/extras/curves/LineCurve.html +++ b/docs/api/extras/curves/LineCurve.html @@ -12,27 +12,36 @@

[name]

-
A curve representing a 2d line segment
+
A curve representing a 2d line segment.

Constructor

[name]( [page:Vector2 v1], [page:Vector2 v2] )

- v1 – The start point
- v2 - The end point + [page:Vector2 v1] – The start point.
+ [page:Vector2 v2] - The end point.

Properties

+
See the base [page:Curve] class for common properties.
+ +

[property:Boolean isLineCurve]

+
+ Used to check whether this or derived classes are LineCurves. Default is *true*.

+ + You should not change this, as it used internally for optimisation. +

[property:Vector2 v1]

-

[property:Vector2 v2]

+
The start point.
+

[property:Vector2 v2]

+
The end point

Methods

- -

See [page:Curve] for inherited methods

+
See the base [page:Curve] class for common methods.

Source

diff --git a/docs/api/extras/curves/LineCurve3.html b/docs/api/extras/curves/LineCurve3.html index 061baee15cee84657b2c57674e67430a682e2006..e9c5b4bc045ddc9320011f52dab3de7e73ff3cd1 100644 --- a/docs/api/extras/curves/LineCurve3.html +++ b/docs/api/extras/curves/LineCurve3.html @@ -12,27 +12,29 @@

[name]

-
A curve representing a 3d line segment
+
A curve representing a 3d line segment.

Constructor

[name]( [page:Vector3 v1], [page:Vector3 v2] )

- v1 – The start point
- v2 - The end point + [page:Vector3 v1] – The start point.
+ [page:Vector3 v2] - The end point.

Properties

+
See the base [page:Curve] class for common properties.

[property:Vector3 v1]

-

[property:Vector3 v2]

+
The start point.
+

[property:Vector3 v2]

+
The end point.

Methods

- -

See [page:Curve] for inherited methods

+
See the base [page:Curve] class for common methods.

Source

diff --git a/docs/api/extras/curves/QuadraticBezierCurve.html b/docs/api/extras/curves/QuadraticBezierCurve.html index a93db6d2dfb581b5966645698ef3c64625e6fea4..3d60080ba00200639e5a30d73d5d43145f072254 100644 --- a/docs/api/extras/curves/QuadraticBezierCurve.html +++ b/docs/api/extras/curves/QuadraticBezierCurve.html @@ -13,16 +13,18 @@

[name]

- Create a smooth 2d quadratic bezier curve. + Create a smooth 2d + quadratic bezier curve, + defined by a startpoint, endpoint and a single control point.

Example

var curve = new THREE.QuadraticBezierCurve( - new THREE.Vector3( -10, 0, 0 ), - new THREE.Vector3( 20, 15, 0 ), - new THREE.Vector3( 10, 0, 0 ) + new THREE.Vector2( -10, 0 ), + new THREE.Vector2( 20, 15 ), + new THREE.Vector2( 10, 0 ) ); var path = new THREE.Path( curve.getPoints( 50 ) ); @@ -30,7 +32,7 @@ var path = new THREE.Path( curve.getPoints( 50 ) ); var geometry = path.createPointsGeometry( 50 ); var material = new THREE.LineBasicMaterial( { color : 0xff0000 } ); -//Create the final Object3d to add to the scene +//Create the final object to add to the scene var curveObject = new THREE.Line( geometry, material ); @@ -39,26 +41,27 @@ var curveObject = new THREE.Line( geometry, material );

[name]( [page:Vector2 v0], [page:Vector2 v1], [page:Vector2 v2] )

- [page:Vector2 v0] – The starting point
- [page:Vector2 v1] – The middle control point
- [page:Vector2 v2] – The ending point
+ [page:Vector2 v0] – The startpoint.
+ [page:Vector2 v1] – The control point.
+ [page:Vector2 v2] – The endpoint.

Properties

+
See the base [page:Curve] class for common properties.

[property:Vector2 v0]

+
The startpoint.

[property:Vector2 v1]

+
The control point.

[property:Vector2 v2]

- +
The endpoint.

Methods

- - -

See [page:Curve] for inherited methods

+
See the base [page:Curve] class for common methods.

Source

diff --git a/docs/api/extras/curves/QuadraticBezierCurve3.html b/docs/api/extras/curves/QuadraticBezierCurve3.html index 90bfe81d843d12ac2253c69ecfb25f8aeb40c1ee..85ed095eb1918962d010b180e30f24ace5475a43 100644 --- a/docs/api/extras/curves/QuadraticBezierCurve3.html +++ b/docs/api/extras/curves/QuadraticBezierCurve3.html @@ -13,7 +13,9 @@

[name]

- Create a smooth 3d quadratic bezier curve. + Create a smooth 3d + quadratic bezier curve, + defined by a startpoint, endpoint and a single control point.

Example

@@ -30,7 +32,7 @@ geometry.vertices = curve.getPoints( 50 ); var material = new THREE.LineBasicMaterial( { color : 0xff0000 } ); -// Create the final Object3d to add to the scene +// Create the final object to add to the scene var curveObject = new THREE.Line( geometry, material ); @@ -47,18 +49,20 @@ var curveObject = new THREE.Line( geometry, material );

Properties

+
See the base [page:Curve] class for common properties.
+

[property:Vector3 v0]

+
The startpoint.

[property:Vector3 v1]

+
The control point.

[property:Vector3 v2]

- +
The endpoint.

Methods

- - -

See [page:Curve] for inherited methods

+
See the base [page:Curve] class for common methods.

Source

diff --git a/docs/api/extras/curves/SplineCurve.html b/docs/api/extras/curves/SplineCurve.html index aafde97d76d1f27991aac9cd699e994df1f5dc58..63371dd03c66249a0facaca3e247adb30a9cc582 100644 --- a/docs/api/extras/curves/SplineCurve.html +++ b/docs/api/extras/curves/SplineCurve.html @@ -12,7 +12,10 @@

[name]

-
Create a smooth 2d spline curve from a series of points
+
+ Create a smooth 2d spline curve from a series of points. Internally this uses + [page:CurveUtils.interpolate] to create the curve. +

Example

@@ -31,7 +34,7 @@ var path = new THREE.Path( curve.getPoints( 50 ) ); var geometry = path.createPointsGeometry( 50 ); var material = new THREE.LineBasicMaterial( { color : 0xff0000 } ); -// Create the final Object3d to add to the scene +// Create the final object to add to the scene var splineObject = new THREE.Line( geometry, material ); @@ -39,16 +42,21 @@ var splineObject = new THREE.Line( geometry, material );

[name]( [page:Array points] )

-
points – An array of [page:Vector2] points
+
points – An array of [page:Vector2] points that define the curve.

Properties

+
See the base [page:Curve] class for common properties.

[property:Array points]

+
The array of [page:Vector3] points that define the curve.
+ +

Methods

+
See the base [page:Curve] class for common methods.
+ -

See [page:Curve] for inherited methods

Source

diff --git a/docs/api/extras/curves/SplineCurve3.html b/docs/api/extras/curves/SplineCurve3.html index 4bbb3a4dd474ad3cac23547f03870e82fb97c7cd..479da41f6f5861395ef4e46453c76b6c8d12cde4 100644 --- a/docs/api/extras/curves/SplineCurve3.html +++ b/docs/api/extras/curves/SplineCurve3.html @@ -12,11 +12,19 @@

[name]

-
Create a smooth 3d spline curve from a series of points
+
+ Create a smooth 3d spline curve from a series of points. Internally this uses + [page:CurveUtils.interpolate] to create the curve.

+ + Note that this will be deprecated. Please use a [page:CatmullRomCurve3] instead. + +

Example

- +
[example:webgl_geometry_extrude_splines geometry / extrude / splines ] (choose PipeSpline)
+ + //Create a closed bent a sine-like wave var curve = new THREE.SplineCurve3( [ new THREE.Vector3( -10, 0, 10 ), @@ -31,18 +39,18 @@ geometry.vertices = curve.getPoints( 50 ); var material = new THREE.LineBasicMaterial( { color : 0xff0000 } ); -//Create the final Object3d to add to the scene +//Create the final object to add to the scene var splineObject = new THREE.Line( geometry, material ); - + + -

[example:webgl_geometry_extrude_splines geometry / extrude / splines ] (choose PipeSpline)

Constructor

[name]( [page:Array points] )

-
points – An array of [page:Vector3] points
+
points – An array of [page:Vector3] points that define the curve.

Properties

diff --git a/docs/list.js b/docs/list.js index c62337a6316480c73bc170c80c46e0768fd250e3..e4090b69d36ed91a691f3b029559986242e281fe 100644 --- a/docs/list.js +++ b/docs/list.js @@ -95,7 +95,6 @@ var list = { "Extras / Curves": [ [ "ArcCurve", "api/extras/curves/ArcCurve" ], [ "CatmullRomCurve3", "api/extras/curves/CatmullRomCurve3" ], - [ "ClosedSplineCurve3", "api/extras/curves/ClosedSplineCurve3" ], [ "CubicBezierCurve", "api/extras/curves/CubicBezierCurve" ], [ "CubicBezierCurve3", "api/extras/curves/CubicBezierCurve3" ], [ "EllipseCurve", "api/extras/curves/EllipseCurve" ],