Class Shape2

Curved Path - a curve path is simply a array of connected curves, but retains the api of a curve

Hierarchy

Path2
- Shape2

Constructors

constructor

new Shape2(points?: Vector2[]): Shape2
Parameters
- Optional points: Vector2[]
Returns Shape2
Overrides Path2.constructor
- Defined in src/math/shape/core/Shape2.ts:9

Properties

arcLengthDivisions

arcLengthDivisions: number = 200

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.

autoClose

autoClose: boolean = false

cacheArcLengths

cacheArcLengths: number[]

cacheLengths

cacheLengths: number[]

currentPoint

currentPoint: Vector2

curves

curves: Curve<Vector2>[] = []

holes

holes: Path2[]

needsUpdate

needsUpdate: boolean = false

Methods

absarc

absarc(aX?: number, aY?: number, aRadius?: number, aStartAngle?: number, aEndAngle?: number, aClockwise?: boolean): Shape2
Parameters
- aX: number = 0
- aY: number = 0
- aRadius: number = 1
- aStartAngle: number = 0
- aEndAngle: number = ...
- aClockwise: boolean = false
Returns Shape2
Inherited from Path2.absarc
- Defined in src/math/shape/core/Path2.ts:107

absellipse

absellipse(aX?: number, aY?: number, xRadius?: number, yRadius?: number, aStartAngle?: number, aEndAngle?: number, aClockwise?: boolean, aRotation?: number): Shape2
Parameters
- aX: number = 0
- aY: number = 0
- xRadius: number = 1
- yRadius: number = 1
- aStartAngle: number = 0
- aEndAngle: number = ...
- aClockwise: boolean = false
- aRotation: number = 0
Returns Shape2
Inherited from Path2.absellipse
- Defined in src/math/shape/core/Path2.ts:124

add

add(curve: Curve<Vector2>): void
Parameters
- curve: Curve<Vector2>
Returns void
Inherited from Path2.add
- Defined in src/math/shape/core/CurvePath.ts:15

arc

arc(aX?: number, aY?: number, aRadius?: number, aStartAngle?: number, aEndAngle?: number, aClockwise?: boolean): Shape2
Parameters
- aX: number = 0
- aY: number = 0
- aRadius: number = 1
- aStartAngle: number = 0
- aEndAngle: number = ...
- aClockwise: boolean = false
Returns Shape2
Inherited from Path2.arc
- Defined in src/math/shape/core/Path2.ts:96

bezierCurveTo

bezierCurveTo(aCP1x: number, aCP1y: number, aCP2x: number, aCP2y: number, aX: number, aY: number): Shape2
Parameters
- aCP1x: number
- aCP1y: number
- aCP2x: number
- aCP2y: number
- aX: number
- aY: number
Returns Shape2
Inherited from Path2.bezierCurveTo
- Defined in src/math/shape/core/Path2.ts:67

closePath

closePath(): void
Returns void
Inherited from Path2.closePath
- Defined in src/math/shape/core/CurvePath.ts:20

computeFrenetFrames

computeFrenetFrames(segments: number, closed: boolean): {
    binormals: Vector3[];
    normals: Vector3[];
    tangents: Vector3[];
}
Parameters
- segments: number
- closed: boolean
Returns {
    binormals: Vector3[];
    normals: Vector3[];
    tangents: Vector3[];
}
- binormals: Vector3[]
- normals: Vector3[]
- tangents: Vector3[]
Inherited from Path2.computeFrenetFrames
- Defined in src/math/shape/core/Curve.ts:240

ellipse

ellipse(aX?: number, aY?: number, xRadius?: number, yRadius?: number, aStartAngle?: number, aEndAngle?: number, aClockwise?: boolean, aRotation?: number): Shape2
Parameters
- aX: number = 0
- aY: number = 0
- xRadius: number = 1
- yRadius: number = 1
- aStartAngle: number = 0
- aEndAngle: number = ...
- aClockwise: boolean = false
- aRotation: number = 0
Returns Shape2
Inherited from Path2.ellipse
- Defined in src/math/shape/core/Path2.ts:114

extractArray

extractArray(divisions?: number): {
holes: number[][];
points: number[];
}
Parameters
- Optional divisions: number
Returns {
holes: number[][];
points: number[];
}
- holes: number[][]
- points: number[]
- Defined in src/math/shape/core/Shape2.ts:37

extractPoints

extractPoints(divisions: number): {
holes: Vector2[][];
shape: Vector2[];
}
Parameters
- divisions: number
Returns {
holes: Vector2[][];
shape: Vector2[];
}
- holes: Vector2[][]
- shape: Vector2[]
- Defined in src/math/shape/core/Shape2.ts:29

fromPoints

fromPoints(points: Vector2[]): Shape2
Parameters
- points: Vector2[]
Returns Shape2
Inherited from Path2.fromPoints
- Defined in src/math/shape/core/Path2.ts:23

getCurveLengths

getCurveLengths(): number[]
Returns number[]
Inherited from Path2.getCurveLengths
- Defined in src/math/shape/core/CurvePath.ts:87

getLength

getLength(): number
Get total curve arc length

Returns number
Inherited from Path2.getLength
- Defined in src/math/shape/core/CurvePath.ts:70

getLengths

getLengths(divisions?: number): number[]
Get list of cumulative segment lengths
Parameters
- Optional divisions: number
Returns number[]
Inherited from Path2.getLengths
- Defined in src/math/shape/core/Curve.ts:97

getPoint

getPoint(t: number): Vector2
Virtual base class method to overwrite and implement in subclasses
- t [0 .. 1] Returns a vector for point t of the curve where t is between 0 and 1
Parameters
- t: number
Returns Vector2
Inherited from Path2.getPoint
- Defined in src/math/shape/core/CurvePath.ts:41

getPointAt

getPointAt(u: number, optionalTarget?: Vector2): Vector2
Get point at relative position in curve according to arc length Returns a vector for point at relative position in curve according to arc length
Parameters
- u: number
  
  [0 .. 1]
- Optional optionalTarget: Vector2
Returns Vector2
Inherited from Path2.getPointAt
- Defined in src/math/shape/core/Curve.ts:46

getPoints

getPoints(divisions?: number): Vector2[]
Get sequence of points using getPoint( t )
Parameters
- divisions: number = 12
Returns Vector2[]
Inherited from Path2.getPoints
- Defined in src/math/shape/core/CurvePath.ts:127

getPointsHoles

getPointsHoles(divisions: number): Vector2[][]
Parameters
- divisions: number
Returns Vector2[][]
- Defined in src/math/shape/core/Shape2.ts:16

getResolution

getResolution(divisions: number): number
Parameters
- divisions: number
Returns number
Inherited from Path2.getResolution
- Defined in src/math/shape/core/Curve.ts:21

getSpacedPoints

getSpacedPoints(divisions?: number): Vector2[]
Get sequence of equi-spaced points using getPointAt( u )
Parameters
- divisions: number = 40
Returns Vector2[]
Inherited from Path2.getSpacedPoints
- Defined in src/math/shape/core/CurvePath.ts:110

getTangent

getTangent(t: number, optionalTarget: Vector2): 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
- optionalTarget: Vector2
Returns Vector2
Inherited from Path2.getTangent
- Defined in src/math/shape/core/Curve.ts:208

getTangentAt

getTangentAt(u: number, optionalTarget: Vector2): Vector2
Returns tangent at equidistance point u on the curve getTangentAt(u: number, optionalTarget?: T): T;
Parameters
- u: number
- optionalTarget: Vector2
Returns Vector2
Inherited from Path2.getTangentAt
- Defined in src/math/shape/core/Curve.ts:233

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
- Optional distance: number
Returns number
Inherited from Path2.getUtoTmapping
- Defined in src/math/shape/core/Curve.ts:140

lineTo

lineTo(x: number, y: number): Shape2
Parameters
- x: number
- y: number
Returns Shape2
Inherited from Path2.lineTo
- Defined in src/math/shape/core/Path2.ts:41

moveTo

moveTo(x: number, y: number): Shape2
Parameters
- x: number
- y: number
Returns Shape2
Inherited from Path2.moveTo
- Defined in src/math/shape/core/Path2.ts:34

quadraticCurveTo

quadraticCurveTo(aCPx: number, aCPy: number, aX: number, aY: number): Shape2
Parameters
- aCPx: number
- aCPy: number
- aX: number
- aY: number
Returns Shape2
Inherited from Path2.quadraticCurveTo
- Defined in src/math/shape/core/Path2.ts:52

splineThru

splineThru(pts: Vector2[]): Shape2
Parameters
- pts: Vector2[]
Returns Shape2
Inherited from Path2.splineThru
- Defined in src/math/shape/core/Path2.ts:83

triangulate

triangulate(geometry?: {
    indices: number[];
    points: number[];
}): {
    indices: number[];
    points: number[];
}
Parameters
- geometry: {
  indices: number[];
  points: number[];
  } = ...
  - indices: number[]
  - points: number[]
Returns {
indices: number[];
points: number[];
}
- indices: number[]
- points: number[]
- Defined in src/math/shape/core/Shape2.ts:64

updateArcLengths

updateArcLengths(): void
Update the cumlative segment distance cache

Returns void
Inherited from Path2.updateArcLengths
- Defined in src/math/shape/core/CurvePath.ts:78

`Static` triangulate

triangulate(points: number[], holes?: number[][], geometry?: {
    indices: number[];
    points: number[];
}): {
    indices: number[];
    points: number[];
}
Parameters
- points: number[]
- holes: number[][] = []
- geometry: {
  indices: number[];
  points: number[];
  } = ...
  - indices: number[]
  - points: number[]
Returns {
indices: number[];
points: number[];
}
- indices: number[]
- points: number[]
- Defined in src/math/shape/core/Shape2.ts:74

Class Shape2

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional points: Vector2[]

Returns Shape2

Properties

arcLengthDivisions

autoClose

cacheArcLengths

cacheLengths

currentPoint

curves

holes

needsUpdate

Methods

absarc

Parameters

aX: number = 0

aY: number = 0

aRadius: number = 1

aStartAngle: number = 0

aEndAngle: number = ...

aClockwise: boolean = false

Returns Shape2

absellipse

Parameters

aX: number = 0

aY: number = 0

xRadius: number = 1

yRadius: number = 1

aStartAngle: number = 0

aEndAngle: number = ...

aClockwise: boolean = false

aRotation: number = 0

Returns Shape2

add

Parameters

curve: Curve<Vector2>

Returns void

arc

Parameters

aX: number = 0

aY: number = 0

aRadius: number = 1

aStartAngle: number = 0

aEndAngle: number = ...

aClockwise: boolean = false

Returns Shape2

bezierCurveTo

Parameters

aCP1x: number

aCP1y: number

aCP2x: number

aCP2y: number

aX: number

aY: number

Returns Shape2

closePath

Returns void

computeFrenetFrames

Parameters

segments: number

closed: boolean

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

binormals: Vector3[]

normals: Vector3[]

tangents: Vector3[]

ellipse

Parameters

aX: number = 0

aY: number = 0

xRadius: number = 1

yRadius: number = 1

aStartAngle: number = 0

`Optional` points: Vector2[]

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

`Optional` divisions: number

Returns {
holes: number[][];
points: number[];
}

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

`Optional` divisions: number

`Optional` optionalTarget: Vector2

`Optional` distance: number