From f18e779f8d8f91f740bb0a583783f5855b5899f1 Mon Sep 17 00:00:00 2001 From: Lewy Blue Date: Sun, 13 Nov 2016 06:49:58 +0000 Subject: [PATCH] Created doc for ShapePath (#10091) --- docs/api/extras/core/ShapePath.html | 91 +++++++++++++++++++++++++++++ docs/list.js | 3 +- 2 files changed, 93 insertions(+), 1 deletion(-) create mode 100644 docs/api/extras/core/ShapePath.html diff --git a/docs/api/extras/core/ShapePath.html b/docs/api/extras/core/ShapePath.html new file mode 100644 index 0000000000..bab5446729 --- /dev/null +++ b/docs/api/extras/core/ShapePath.html @@ -0,0 +1,91 @@ + + + + + + + + + + + [page:CurvePath] → + +

[name]

+ +
+ This is class is used to convert a series of shapes to an array of [page:Path]s, for example an SVG shape to a + path (see the example below). It is used internally by [page:Font] to convert a font in JSON format to a + series of paths. +
+ +

Example

+ + [example:webgl_geometry_extrude_shapes2 geometry / extrude / shapes2] + +

Constructor

+ + +

[name]( )

+
+ Creates a new ShapePath. Unlike a [page:Path], no points are passed in as the ShapePath is designed to + be generated after creation. +
+ + +

Properties

+ +

[property:array subPaths]

+
+ Array of [page:Path]s. +
+ +

[property:array currentPath]

+
+ The current [page:Path] that is being generated. +
+ +

Methods

+ +

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

+
+ Starts a new [page:Path] and calls [page:Path.moveTo]( x, y ) on that [page:Path]. + Also points [page:ShapePath.currentPath currentPath] to that [page:Path]. +
+ +

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

+
This creates a line from the [page:ShapePath.currentPath currentPath]'s + offset to X and Y and updates the offset to X and Y.
+ +

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

+
This creates a quadratic curve from the [page:ShapePath.currentPath currentPath]'s + offset to x and y with cpX and cpY as control point and updates the [page:ShapePath.currentPath currentPath]'s + offset to x and y.
+ +

[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 [page:ShapePath.currentPath currentPath]'s + offset to x and y with cp1X, cp1Y and cp1X, cp1Y as control points and updates the + [page:ShapePath.currentPath currentPath]'s offset to x and y.
+ +

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

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

[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 [page:ShapePath.subPaths subPaths] array 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

+ + [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 64ce82897b..d879860019 100644 --- a/docs/list.js +++ b/docs/list.js @@ -88,7 +88,8 @@ var list = { [ "CurvePath", "api/extras/core/CurvePath" ], [ "Font", "api/extras/core/Font" ], [ "Path", "api/extras/core/Path" ], - [ "Shape", "api/extras/core/Shape" ] + [ "Shape", "api/extras/core/Shape" ], + [ "ShapePath", "api/extras/core/ShapePath" ] ], "Extras / Curves": [ -- GitLab