|
@@ -52,71 +52,37 @@
|
|
|
|
|
|
|
|
|
<h2>Properties</h2>
|
|
|
-
|
|
|
+ <div>See the base [page:Path] class for common properties.</div>
|
|
|
|
|
|
<h3>[property:array holes]</h3>
|
|
|
- <div>
|
|
|
- An array of [page:Path paths] that define the holes in the shape.
|
|
|
- </div>
|
|
|
+ <div>An array of [page:Path paths] that define the holes in the shape.</div>
|
|
|
|
|
|
<h2>Methods</h2>
|
|
|
-
|
|
|
-
|
|
|
- <h3>[method:ShapeGeometry makeGeometry]( [page:Object options] )</h3>
|
|
|
- <div>
|
|
|
- options -- This is passed as the second argument to [page:ShapeGeometry ShapeGeometry]
|
|
|
- </div>
|
|
|
- <div>
|
|
|
- Convenience method to return ShapeGeometry
|
|
|
- </div>
|
|
|
+ <div>See the base [page:Path] class for common methods.</div>
|
|
|
|
|
|
<h3>[method:Array extractAllPoints]( [page:Integer divisions] )</h3>
|
|
|
<div>
|
|
|
- divisions -- The number of divisions to create on the shape
|
|
|
- </div>
|
|
|
- <div>
|
|
|
- Get points of shape and holes (keypoints based on segments parameter)
|
|
|
- </div>
|
|
|
+ divisions -- The fineness of the result.<br /><br />
|
|
|
|
|
|
- <h3>[method:ExtrudeGeometry extrude]( [page:Object options] )</h3>
|
|
|
- <div>
|
|
|
- options -- This is passed as the second argument to [page:ExtrudeGeometry ExtrudeGeometry]
|
|
|
- </div>
|
|
|
- <div>
|
|
|
- Convenience method to return ExtrudeGeometry
|
|
|
+ Call [page:Curve.getPoints getPoints] on the shape and the [page:.holes] array, and return an object of the form:
|
|
|
+ <code>
|
|
|
+{
|
|
|
+ shape
|
|
|
+ holes
|
|
|
+}
|
|
|
+ </code>
|
|
|
+ where shape and holes are arrays of [page:Vector2 Vector2s].
|
|
|
</div>
|
|
|
|
|
|
<h3>[method:Object extractPoints]( [page:Integer divisions] )</h3>
|
|
|
- <div>
|
|
|
- divisions -- The number of divisions to create on the shape
|
|
|
- </div>
|
|
|
- <div>
|
|
|
- Returns an object with a *shape* and *holes* property that each reference an array of [page:Vector2 Vector2s].
|
|
|
- </div>
|
|
|
+ <div>This is identical to [page:.extractAllPoints].</div>
|
|
|
|
|
|
- <h3>[method:Object extractAllSpacedPoints]( [page:Integer divisions] )</h3>
|
|
|
- <div>
|
|
|
- divisions -- The number of divisions to create on the shape
|
|
|
- </div>
|
|
|
- <div>
|
|
|
- Returns an object with a *shape* and *holes* property that each reference an array of [page:Vector2 Vector2s]. The
|
|
|
- points will all be equally spaced along the shape.
|
|
|
- </div>
|
|
|
|
|
|
<h3>[method:Array getPointsHoles]( [page:Integer divisions] )</h3>
|
|
|
<div>
|
|
|
- divisions -- The number of divisions to create on the shape
|
|
|
- </div>
|
|
|
- <div>
|
|
|
- Get an array of [page Vector2 Vector2s] that represent the holes in the shape.
|
|
|
- </div>
|
|
|
+ divisions -- The fineness of the result.<br /><br />
|
|
|
|
|
|
- <h3>[method:Array getSpacedPointsHoles]( [page:Integer divisions] )</h3>
|
|
|
- <div>
|
|
|
- divisions -- The number of divisions to create on the shape
|
|
|
- </div>
|
|
|
- <div>
|
|
|
- Get an array of equally spaced [page Vector2 Vector2s] that represent the holes in the shape.
|
|
|
+ Get an array of [page:Vector2 Vector2s] that represent the holes in the shape.
|
|
|
</div>
|
|
|
|
|
|
<h2>Source</h2>
|