Interface ShapePath

This class is used to convert a series of shapes to an array of Paths, for example an SVG shape to a path (see the example below).

Examples

geometry / extrude / shapes2

Hierarchy

ShapePath
- SVGResultPaths

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ShapePath(): I3JS.ShapePath

- Defined in lib/threejs-library/types/three/extras.ts:491
Creates a new ShapePath. Unlike a Path, no points are passed in as the ShapePath is designed to be generated after creation.

Returns I3JS.ShapePath

Properties

color

color: I3JS.Color

default: new THREE.Color()

currentPath

currentPath: any

The current Path that is being generated.

default: null

subPaths

subPaths: any[]

Array of Paths.

default: []

type

type: string

default: 'ShapePath'

Methods

bezierCurveTo

bezierCurveTo(aCP1x: number, aCP1y: number, aCP2x: number, aCP2y: number, aX: number, aY: number): I3JS.ShapePath

- Defined in lib/threejs-library/types/three/extras.ts:533
This creates a bezier curve from .currentPoint with (cp1X, cp1Y) and (cp2X, cp2Y) as control points and updates .currentPoint to x and y.

Parameters
- aCP1x: number
- aCP1y: number
- aCP2x: number
- aCP2y: number
- aX: number
- aY: number
Returns I3JS.ShapePath

lineTo

lineTo(x: number, y: number): I3JS.ShapePath

- Defined in lib/threejs-library/types/three/extras.ts:523
Connects a LineCurve from .currentPoint to x, y onto the path.

Parameters
- x: number
- y: number
Returns I3JS.ShapePath

moveTo

moveTo(x: number, y: number): I3JS.ShapePath

- Defined in lib/threejs-library/types/three/extras.ts:518
Move the .currentPoint to x, y.

Parameters
- x: number
- y: number
Returns I3JS.ShapePath

quadraticCurveTo

quadraticCurveTo(aCPx: number, aCPy: number, aX: number, aY: number): I3JS.ShapePath

- Defined in lib/threejs-library/types/three/extras.ts:528
Creates a quadratic curve from .currentPoint with cpX and cpY as control point and updates .currentPoint to x and y.

Parameters
- aCPx: number
- aCPy: number
- aX: number
- aY: number
Returns I3JS.ShapePath

splineThru

splineThru(pts: I3JS.Vector2[]): I3JS.ShapePath

- Defined in lib/threejs-library/types/three/extras.ts:539
Connects a new SplineCurve onto the path.

Parameters
- pts: I3JS.Vector2[]
Returns I3JS.ShapePath

toShapes

toShapes(isCCW: boolean, noHoles?: boolean): I3JS.Shape[]

- Defined in lib/threejs-library/types/three/extras.ts:544
Parameters
- isCCW: boolean
- Optional noHoles: boolean
Returns I3JS.Shape[]

Generated using TypeDoc