Class Shape

Defines a 2d shape plane using paths.

Hierarchy

Path
- Shape

Constructors

constructor

new Shape(points?: THREE.Vector2[]): THREE.Shape
Parameters
- Optional points: THREE.Vector2[]
Returns THREE.Shape
Overrides Path.constructor
- Defined in node_modules/@types/three/src/extras/core/Shape.d.ts:8

Properties

arcLengthDivisions

arcLengthDivisions: number

This value determines the amount of divisions when calculating the cumulative segment lengths of a curve via .getLengths. To ensure precision when using methods like .getSpacedPoints, it is recommended to increase .arcLengthDivisions if the curve is very large.

Default

200

autoClose

autoClose: boolean

Default

false

currentPoint

currentPoint: THREE.Vector2

Default

new THREE.Vector2()

curves

curves: Curve<THREE.Vector2>[]

Default

[]

holes

holes: Path[]

Default

[]

type

type: string

Default

'Shape'

uuid

uuid: string

Methods

absarc

absarc(aX: number, aY: number, aRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean): THREE.Shape
Parameters
- aX: number
- aY: number
- aRadius: number
- aStartAngle: number
- aEndAngle: number
- aClockwise: boolean
Returns THREE.Shape
Inherited from Path.absarc
- Defined in node_modules/@types/three/src/extras/core/Path.d.ts:31

absellipse

absellipse(aX: number, aY: number, xRadius: number, yRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean, aRotation: number): THREE.Shape
Parameters
- aX: number
- aY: number
- xRadius: number
- yRadius: number
- aStartAngle: number
- aEndAngle: number
- aClockwise: boolean
- aRotation: number
Returns THREE.Shape
Inherited from Path.absellipse
- Defined in node_modules/@types/three/src/extras/core/Path.d.ts:42

add

add(curve: Curve<THREE.Vector2>): void
Parameters
- curve: Curve<THREE.Vector2>
Returns void
Inherited from Path.add
- Defined in node_modules/@types/three/src/extras/core/CurvePath.d.ts:22

arc

arc(aX: number, aY: number, aRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean): THREE.Shape
Parameters
- aX: number
- aY: number
- aRadius: number
- aStartAngle: number
- aEndAngle: number
- aClockwise: boolean
Returns THREE.Shape
Inherited from Path.arc
- Defined in node_modules/@types/three/src/extras/core/Path.d.ts:30

bezierCurveTo

bezierCurveTo(aCP1x: number, aCP1y: number, aCP2x: number, aCP2y: number, aX: number, aY: number): THREE.Shape
Parameters
- aCP1x: number
- aCP1y: number
- aCP2x: number
- aCP2y: number
- aX: number
- aY: number
Returns THREE.Shape
Inherited from Path.bezierCurveTo
- Defined in node_modules/@types/three/src/extras/core/Path.d.ts:28

clone

clone(): THREE.Shape
Returns THREE.Shape
Inherited from Path.clone
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:92

closePath

closePath(): void
Returns void
Inherited from Path.closePath
- Defined in node_modules/@types/three/src/extras/core/CurvePath.d.ts:23

computeFrenetFrames

computeFrenetFrames(segments: number, closed?: boolean): {
    binormals: THREE.Vector3[];
    normals: THREE.Vector3[];
    tangents: THREE.Vector3[];
}
Generate Frenet frames of the curve
Parameters
- segments: number
- Optional closed: boolean
Returns {
    binormals: THREE.Vector3[];
    normals: THREE.Vector3[];
    tangents: THREE.Vector3[];
}
- binormals: THREE.Vector3[]
- normals: THREE.Vector3[]
- tangents: THREE.Vector3[]
Inherited from Path.computeFrenetFrames
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:83

copy

copy(source: Curve<THREE.Vector2>): THREE.Shape
Parameters
- source: Curve<THREE.Vector2>
Returns THREE.Shape
Inherited from Path.copy
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:93

ellipse

ellipse(aX: number, aY: number, xRadius: number, yRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean, aRotation: number): THREE.Shape
Parameters
- aX: number
- aY: number
- xRadius: number
- yRadius: number
- aStartAngle: number
- aEndAngle: number
- aClockwise: boolean
- aRotation: number
Returns THREE.Shape
Inherited from Path.ellipse
- Defined in node_modules/@types/three/src/extras/core/Path.d.ts:32

extractPoints

extractPoints(divisions: number): {
holes: THREE.Vector2[][];
shape: THREE.Vector2[];
}
Parameters
- divisions: number
Returns {
holes: THREE.Vector2[][];
shape: THREE.Vector2[];
}
- holes: THREE.Vector2[][]
- shape: THREE.Vector2[]
- Defined in node_modules/@types/three/src/extras/core/Shape.d.ts:24

fromJSON

fromJSON(json: object): THREE.Shape
Parameters
- json: object
Returns THREE.Shape
Inherited from Path.fromJSON
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:95

fromPoints

fromPoints(vectors: THREE.Vector2[]): THREE.Shape
Deprecated
Use .setFromPoints() instead.
Parameters
- vectors: THREE.Vector2[]
Returns THREE.Shape
Inherited from Path.fromPoints
- Defined in node_modules/@types/three/src/extras/core/Path.d.ts:23

getCurveLengths

getCurveLengths(): number[]
Returns number[]
Inherited from Path.getCurveLengths
- Defined in node_modules/@types/three/src/extras/core/CurvePath.d.ts:25

getLength

getLength(): number
Get total curve arc length

Returns number
Inherited from Path.getLength
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:50

getLengths

getLengths(divisions?: number): number[]
Get list of cumulative segment lengths
Parameters
- Optional divisions: number
Returns number[]
Inherited from Path.getLengths
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:55

getPoint

getPoint(t: number, optionalTarget?: THREE.Vector2): THREE.Vector2
Returns a vector for point t of the curve where t is between 0 and 1 getPoint(t: number, optionalTarget?: T): T;
Parameters
- t: number
- Optional optionalTarget: THREE.Vector2
Returns THREE.Vector2
Inherited from Path.getPoint
- Defined in node_modules/@types/three/src/extras/core/CurvePath.d.ts:24

getPointAt

getPointAt(u: number, optionalTarget?: THREE.Vector2): THREE.Vector2
Returns a vector for point at relative position in curve according to arc length getPointAt(u: number, optionalTarget?: T): T;
Parameters
- u: number
- Optional optionalTarget: THREE.Vector2
Returns THREE.Vector2
Inherited from Path.getPointAt
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:33

getPoints

getPoints(divisions?: number): THREE.Vector2[]
Get sequence of points using getPoint( t ) getPoints(divisions?: number): T[];
Parameters
- Optional divisions: number
Returns THREE.Vector2[]
Inherited from Path.getPoints
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:39

getPointsHoles

getPointsHoles(divisions: number): THREE.Vector2[][]
Parameters
- divisions: number
Returns THREE.Vector2[][]
- Defined in node_modules/@types/three/src/extras/core/Shape.d.ts:22

getSpacedPoints

getSpacedPoints(divisions?: number): THREE.Vector2[]
Get sequence of equi-spaced points using getPointAt( u ) getSpacedPoints(divisions?: number): T[];
Parameters
- Optional divisions: number
Returns THREE.Vector2[]
Inherited from Path.getSpacedPoints
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:45

getTangent

getTangent(t: number, optionalTarget?: THREE.Vector2): THREE.Vector2
Returns a unit vector tangent at t. If the subclassed curve do not implement its tangent derivation, 2 points a small delta apart will be used to find its gradient which seems to give a reasonable approximation getTangent(t: number, optionalTarget?: T): T;
Parameters
- t: number
- Optional optionalTarget: THREE.Vector2
Returns THREE.Vector2
Inherited from Path.getTangent
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:72

getTangentAt

getTangentAt(u: number, optionalTarget?: THREE.Vector2): THREE.Vector2
Returns tangent at equidistance point u on the curve getTangentAt(u: number, optionalTarget?: T): T;
Parameters
- u: number
- Optional optionalTarget: THREE.Vector2
Returns THREE.Vector2
Inherited from Path.getTangentAt
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:78

getUtoTmapping

getUtoTmapping(u: number, distance: number): number
Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equi distance
Parameters
- u: number
- distance: number
Returns number
Inherited from Path.getUtoTmapping
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:65

lineTo

lineTo(x: number, y: number): THREE.Shape
Parameters
- x: number
- y: number
Returns THREE.Shape
Inherited from Path.lineTo
- Defined in node_modules/@types/three/src/extras/core/Path.d.ts:26

moveTo

moveTo(x: number, y: number): THREE.Shape
Parameters
- x: number
- y: number
Returns THREE.Shape
Inherited from Path.moveTo
- Defined in node_modules/@types/three/src/extras/core/Path.d.ts:25

quadraticCurveTo

quadraticCurveTo(aCPx: number, aCPy: number, aX: number, aY: number): THREE.Shape
Parameters
- aCPx: number
- aCPy: number
- aX: number
- aY: number
Returns THREE.Shape
Inherited from Path.quadraticCurveTo
- Defined in node_modules/@types/three/src/extras/core/Path.d.ts:27

setFromPoints

setFromPoints(vectors: THREE.Vector2[]): THREE.Shape
Parameters
- vectors: THREE.Vector2[]
Returns THREE.Shape
Inherited from Path.setFromPoints
- Defined in node_modules/@types/three/src/extras/core/Path.d.ts:24

splineThru

splineThru(pts: THREE.Vector2[]): THREE.Shape
Parameters
- pts: THREE.Vector2[]
Returns THREE.Shape
Inherited from Path.splineThru
- Defined in node_modules/@types/three/src/extras/core/Path.d.ts:29

toJSON

toJSON(): object
Returns object
Inherited from Path.toJSON
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:94

updateArcLengths

updateArcLengths(): void
Update the cumlative segment distance cache

Returns void
Inherited from Path.updateArcLengths
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:60

`Static` create

create(constructorFunc: (() => void), getPointFunc: (() => void)): (() => void)
Deprecated
since r84.
Parameters
- constructorFunc: (() => void)
  - - (): void
    - Returns void
- getPointFunc: (() => void)
  - - (): void
    - Returns void
Returns (() => void)
- - (): void
  - Deprecated
    since r84.
    
    Returns void
Inherited from Path.create
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:100

Class Shape

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional points: THREE.Vector2[]

Returns THREE.Shape

Properties

arcLengthDivisions

Default

autoClose

Default

currentPoint

Default

curves

Default

holes

Default

type

Default

uuid

Methods

absarc

Parameters

aX: number

aY: number

aRadius: number

aStartAngle: number

aEndAngle: number

aClockwise: boolean

Returns THREE.Shape

absellipse

Parameters

aX: number

aY: number

xRadius: number

yRadius: number

aStartAngle: number

aEndAngle: number

aClockwise: boolean

aRotation: number

Returns THREE.Shape

add

Parameters

curve: Curve<THREE.Vector2>

Returns void

arc

Parameters

aX: number

aY: number

aRadius: number

aStartAngle: number

aEndAngle: number

aClockwise: boolean

Returns THREE.Shape

bezierCurveTo

Parameters

aCP1x: number

aCP1y: number

aCP2x: number

aCP2y: number

aX: number

aY: number

Returns THREE.Shape

clone

Returns THREE.Shape

closePath

Returns void

computeFrenetFrames

Parameters

segments: number

Optional closed: boolean

Returns { binormals: THREE.Vector3[]; normals: THREE.Vector3[]; tangents: THREE.Vector3[]; }

binormals: THREE.Vector3[]

normals: THREE.Vector3[]

tangents: THREE.Vector3[]

`Optional` points: THREE.Vector2[]

`Optional` closed: boolean

Returns {
binormals: THREE.Vector3[];
normals: THREE.Vector3[];
tangents: THREE.Vector3[];
}

Returns {
holes: THREE.Vector2[][];
shape: THREE.Vector2[];
}

`Optional` divisions: number

`Optional` optionalTarget: THREE.Vector2

`Optional` optionalTarget: THREE.Vector2

`Optional` divisions: number

`Optional` divisions: number

`Optional` optionalTarget: THREE.Vector2

`Optional` optionalTarget: THREE.Vector2