From 76ecc66174d3e872cde29262cd29e6dc761ea005 Mon Sep 17 00:00:00 2001 From: Greg Tatum Date: Tue, 14 Oct 2014 08:28:58 -0500 Subject: [PATCH] Completed half of curve documentation --- docs/api/extras/curves/ArcCurve.html | 32 +----------- .../api/extras/curves/ClosedSplineCurve3.html | 37 +++++++------- docs/api/extras/curves/EllipseCurve.html | 51 +++++++++++++------ docs/api/extras/curves/LineCurve.html | 27 ++++------ docs/api/extras/curves/LineCurve3.html | 28 ++++------ docs/api/extras/curves/SplineCurve.html | 37 ++++++++------ docs/api/extras/curves/SplineCurve3.html | 37 +++++++------- 7 files changed, 120 insertions(+), 129 deletions(-) diff --git a/docs/api/extras/curves/ArcCurve.html b/docs/api/extras/curves/ArcCurve.html index 7e8838b072..f423ad9532 100644 --- a/docs/api/extras/curves/ArcCurve.html +++ b/docs/api/extras/curves/ArcCurve.html @@ -11,38 +11,10 @@

[name]

-
todo
- -

Example

- - todo - -

Constructor

- - -

todo

-
- - -

Properties

- -

todo

-
- todo -
- - -

Methods

- - -

todo

-
todo
-
- todo -
+
Alias for [page:EllipseCurve]

Source

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js] - + \ No newline at end of file diff --git a/docs/api/extras/curves/ClosedSplineCurve3.html b/docs/api/extras/curves/ClosedSplineCurve3.html index ef09419a3a..09239ab0aa 100644 --- a/docs/api/extras/curves/ClosedSplineCurve3.html +++ b/docs/api/extras/curves/ClosedSplineCurve3.html @@ -11,38 +11,41 @@

[name]

-
todo
+
Create a smooth 3d spline curve from a series of points that loops back onto itself

Example

- todo + +//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 } ); +

Constructor

-

todo

-
+

[name]([page:Array points])

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

Properties

-

todo

-
- todo -
- +

.[page:Array points]

Methods

- -

todo

-
todo
-
- todo -
+

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 ef09419a3a..f32f791bdd 100644 --- a/docs/api/extras/curves/EllipseCurve.html +++ b/docs/api/extras/curves/EllipseCurve.html @@ -11,35 +11,56 @@

[name]

-
todo
+
Creates a 2d curve in the shape of an ellipse.

Example

- todo + +var curve = new THREE.EllipseCurve( + 0, 0, // ax, aY + 10, 10, // xRadius, yRadius + 0, 2 * Math.PI, // aStartAngle, aEndAngle + false // aClockwise +); + +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 +var ellipse = new THREE.Line( geometry, material ); +

Constructor

-

todo

-
+

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

+
+ 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

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

Properties

-

todo

-
- todo -
- +

.[page:Float aX]

+

.[page:Float aY]

+

.[page:Radians xRadius]

+

.[page:Radians yRadius]

+

.[page:Float aStartAngle]

+

.[page:Float aEndAngle]

+

.[page:Boolean aClockwise]

Methods

- -

todo

-
todo
-
- todo -
+

See [page:Curve] for inherited methods

Source

diff --git a/docs/api/extras/curves/LineCurve.html b/docs/api/extras/curves/LineCurve.html index ef09419a3a..e5cb25f34c 100644 --- a/docs/api/extras/curves/LineCurve.html +++ b/docs/api/extras/curves/LineCurve.html @@ -8,38 +8,31 @@ [page:Curve] → - +

[name]

-
todo
- -

Example

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

Constructor

-

todo

-
+

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

+
+ v1 – The start point
+ v2 - The end point +

Properties

-

todo

-
- todo -
+

.[page:Vector2 v1]

+

.[page:Vector2 v2]

Methods

+

See [page:Curve] for inherited methods

-

todo

-
todo
-
- todo -

Source

diff --git a/docs/api/extras/curves/LineCurve3.html b/docs/api/extras/curves/LineCurve3.html index ef09419a3a..0c6f3b8c12 100644 --- a/docs/api/extras/curves/LineCurve3.html +++ b/docs/api/extras/curves/LineCurve3.html @@ -8,38 +8,30 @@ [page:Curve] → - +

[name]

-
todo
- -

Example

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

Constructor

-

todo

-
+

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

+
+ v1 – The start point
+ v2 - The end point +

Properties

-

todo

-
- todo -
+

.[page:Vector3 v1]

+

.[page:Vector3 v2]

Methods

- -

todo

-
todo
-
- todo -
+

See [page:Curve] for inherited methods

Source

diff --git a/docs/api/extras/curves/SplineCurve.html b/docs/api/extras/curves/SplineCurve.html index ef09419a3a..fed4161e6c 100644 --- a/docs/api/extras/curves/SplineCurve.html +++ b/docs/api/extras/curves/SplineCurve.html @@ -11,35 +11,42 @@

[name]

-
todo
+
Create a smooth 2d spline curve from a series of points

Example

- todo + +//Create a sine-like wave +var curve = new THREE.SplineCurve([ + new THREE.Vector2(-10, 0), + new THREE.Vector2(-5, 5), + new THREE.Vector2( 0, 0), + new THREE.Vector2( 5, -5), + new THREE.Vector2(10, 0) +]); + +var path = new THREE.Path( curve.getPoints(50) ); + +var geometry = path.createPointsGeometry( 50 ); +var material = new THREE.LineBasicMaterial( { color: 0xff0000 } ); + +var object3d = new THREE.Line( geometry, material ); +

Constructor

-

todo

-
+

[name]([page:Array points])

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

Properties

-

todo

-
- todo -
- +

.[page:Array points]

Methods

- -

todo

-
todo
-
- todo -
+

See [page:Curve] for inherited methods

Source

diff --git a/docs/api/extras/curves/SplineCurve3.html b/docs/api/extras/curves/SplineCurve3.html index ef09419a3a..d722bdbe68 100644 --- a/docs/api/extras/curves/SplineCurve3.html +++ b/docs/api/extras/curves/SplineCurve3.html @@ -11,38 +11,41 @@

[name]

-
todo
+
Create a smooth 3d spline curve from a series of points

Example

- todo + +//Create a closed bent a sine-like wave +var curve = new THREE.SplineCurve3([ + 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 } ); +

Constructor

-

todo

-
+

[name]([page:Array points])

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

Properties

-

todo

-
- todo -
- +

.[page:Array points]

Methods

- -

todo

-
todo
-
- todo -
+

See [page:Curve] for inherited methods

-

Source

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