From 267583f32be9c0afc3cb6505a10a9e14671ef889 Mon Sep 17 00:00:00 2001 From: zz85 Date: Sun, 25 Nov 2012 12:35:22 +0800 Subject: [PATCH] [docs] Added skeleton methods for THREE.Path THREE.Shape THREE.CurvePath THREE.Curve THREE.SubdivisionModifier THREE.ExtrudeGeometry @sole you might be interested in the script i used to help generate this. p = new THREE.Path() for (i in p) { p.hasOwnProperty(i) && console.log('\n

.' + i + '

'); } console.log('-------------') for (i in p) { var pp = p[i].toString().replace(/function/,''); THREE.Path.prototype.hasOwnProperty(i) && console.log('\n

.' + i + pp.substring(0, pp.indexOf('{')-1).replace(/\s+/g, ' ') + '

\n
todo
' ); } --- docs/api/extras/core/Curve.html | 36 +++++++++++-- docs/api/extras/core/CurvePath.html | 49 ++++++++++++++++-- docs/api/extras/core/Path.html | 51 ++++++++++++++++--- docs/api/extras/core/Shape.html | 37 +++++++++++--- .../extras/geometries/ExtrudeGeometry.html | 5 +- .../extras/modifiers/SubdivisionModifier.html | 17 +++++-- docs/list.js | 3 +- 7 files changed, 169 insertions(+), 29 deletions(-) diff --git a/docs/api/extras/core/Curve.html b/docs/api/extras/core/Curve.html index 9c1227640a..901575b567 100644 --- a/docs/api/extras/core/Curve.html +++ b/docs/api/extras/core/Curve.html @@ -24,10 +24,38 @@

Methods

-

.todo( [page:Vector3 todo] )

-
- todo — todo
-
+

.getPoint ( t )

+
todo
+ +

.getPointAt ( u )

+
todo
+ +

.getPoints ( divisions )

+
todo
+ +

.getSpacedPoints ( divisions )

+
todo
+ +

.getLength ()

+
todo
+ +

.getLengths ( divisions )

+
todo
+ +

.updateArcLengths ()

+
todo
+ +

.getUtoTmapping ( u, distance )

+
todo
+ +

.getNormalVector ( t )

+
todo
+ +

.getTangent ( t )

+
todo
+ +

.getTangentAt ( u )

+
todo

Source

diff --git a/docs/api/extras/core/CurvePath.html b/docs/api/extras/core/CurvePath.html index 9c1227640a..837e55cc5f 100644 --- a/docs/api/extras/core/CurvePath.html +++ b/docs/api/extras/core/CurvePath.html @@ -18,17 +18,56 @@

Properties

+

.curves

-

.[page:Vector3 todo]

+

.bends

+

.autoClose

Methods

-

.todo( [page:Vector3 todo] )

-
- todo — todo
-
+

.add ( curve )

+
todo
+ +

.checkConnection ()

+
todo
+ +

.closePath ()

+
todo
+ +

.getPoint ( t )

+
todo
+ +

.getLength ()

+
todo
+ +

.getCurveLengths ()

+
todo
+ +

.getBoundingBox ()

+
todo
+ +

.createPointsGeometry ( divisions )

+
todo
+ +

.createSpacedPointsGeometry ( divisions )

+
todo
+ +

.createGeometry ( points )

+
todo
+ +

.addWrapPath ( bendpath )

+
todo
+ +

.getTransformedPoints ( segments, bends )

+
todo
+ +

.getTransformedSpacedPoints ( segments, bends )

+
todo
+ +

.getWrapPoints ( oldPts, path )

+
todo

Source

diff --git a/docs/api/extras/core/Path.html b/docs/api/extras/core/Path.html index 9c1227640a..a2e8cd3a29 100644 --- a/docs/api/extras/core/Path.html +++ b/docs/api/extras/core/Path.html @@ -9,7 +9,7 @@

[name]

-
todo
+
a 2d path representation, comprising of points, lines, and cubes, similar to the html5 2d canvas api. It extends CurvePath.

Constructor

@@ -19,15 +19,54 @@

Properties

-

.[page:Vector3 todo]

+

.curves

+

.bends

+ +

.autoClose

+ +

.actions

Methods

-

.todo( [page:Vector3 todo] )

-
- todo — todo
-
+

.fromPoints ( vectors )

+
todo
+ +

.moveTo ( x, y )

+
todo
+ +

.lineTo ( x, y )

+
todo
+ +

.quadraticCurveTo ( aCPx, aCPy, aX, aY )

+
todo
+ +

.bezierCurveTo ( aCP1x, aCP1y, aCP2x, aCP2y, aX, aY )

+
todo
+ +

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

+
todo
+ +

.arc ( aX, aY, aRadius, aStartAngle, aEndAngle, aClockwise )

+
todo
+ +

.absarc ( aX, aY, aRadius, aStartAngle, aEndAngle, aClockwise )

+
todo
+ +

.ellipse ( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise )

+
todo
+ +

.absellipse ( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise )

+
todo
+ +

.getSpacedPoints ( divisions, closedPath )

+
todo
+ +

.getPoints ( divisions, closedPath )

+
todo
+ +

.toShapes ()

+
todo

Source

diff --git a/docs/api/extras/core/Shape.html b/docs/api/extras/core/Shape.html index 9c1227640a..e2f4d7ff0d 100644 --- a/docs/api/extras/core/Shape.html +++ b/docs/api/extras/core/Shape.html @@ -9,7 +9,7 @@

[name]

-
todo
+
Defines a 2d shape plane using paths.

Constructor

@@ -19,15 +19,40 @@

Properties

-

.[page:Vector3 todo]

+

.curves

+ +

.bends

+ +

.autoClose

+ +

.actions

+ +

.holes

+

Methods

-

.todo( [page:Vector3 todo] )

-
- todo — todo
-
+

.extrude ( options )

+
todo
+ +

.makeGeometry ( options )

+
todo
+ +

.getPointsHoles ( divisions )

+
todo
+ +

.getSpacedPointsHoles ( divisions )

+
todo
+ +

.extractAllPoints ( divisions )

+
todo
+ +

.extractPoints ( divisions )

+
todo
+ +

.extractAllSpacedPoints ( divisions )

+
todo

Source

diff --git a/docs/api/extras/geometries/ExtrudeGeometry.html b/docs/api/extras/geometries/ExtrudeGeometry.html index 9c1227640a..7063bc6401 100644 --- a/docs/api/extras/geometries/ExtrudeGeometry.html +++ b/docs/api/extras/geometries/ExtrudeGeometry.html @@ -19,8 +19,11 @@

Properties

-

.[page:Vector3 todo]

+

.addShapeList ( shapes, options )

+
todo
+

.addShape ( shape, options )

+
todo

Methods

diff --git a/docs/api/extras/modifiers/SubdivisionModifier.html b/docs/api/extras/modifiers/SubdivisionModifier.html index 9c1227640a..29d5090c41 100644 --- a/docs/api/extras/modifiers/SubdivisionModifier.html +++ b/docs/api/extras/modifiers/SubdivisionModifier.html @@ -19,15 +19,22 @@

Properties

-

.[page:Vector3 todo]

+

.subdivisions

+

.useOldVertexColors

+ +

.supportUVs

+ +

.debug

Methods

-

.todo( [page:Vector3 todo] )

-
- todo — todo
-
+

.modify ( geometry )

+
todo
+ +

.smooth ( oldGeometry )

+
todo
+

Source

diff --git a/docs/list.js b/docs/list.js index 7c417f83f4..5f513a6a58 100644 --- a/docs/list.js +++ b/docs/list.js @@ -142,8 +142,7 @@ var list = { [ "EventTarget", "api/extras/core/EventTarget" ], [ "Gyroscope", "api/extras/core/Gyroscope" ], [ "Path", "api/extras/core/Path" ], - [ "Shape", "api/extras/core/Shape" ], - [ "TextPath", "api/extras/core/TextPath" ] + [ "Shape", "api/extras/core/Shape" ] ], "Extras / Geometries": [ -- GitLab