Class CurvePath<T>

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

Type Parameters

T extends Vector

Hierarchy

Curve<T>
- CurvePath
  - Path2

Index

Constructors

constructor

new CurvePath<T>(): CurvePath<T>
Type Parameters
- T extends Vector<T>
Returns CurvePath<T>

Inherited from Curve.constructor

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[]

curves

curves: Curve<T>[] = []

needsUpdate

needsUpdate: boolean = false

Methods

add

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

closePath

closePath(): void
Returns void
- 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 Curve.computeFrenetFrames
- Defined in src/math/shape/core/Curve.ts:240

getCurveLengths

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

getLength

getLength(): number
Get total curve arc length

Returns number
Overrides Curve.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 Curve.getLengths
- Defined in src/math/shape/core/Curve.ts:97

getPoint

getPoint(t: number): T
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 T
Overrides Curve.getPoint
- Defined in src/math/shape/core/CurvePath.ts:41

getPointAt

getPointAt(u: number, optionalTarget?: T): T
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: T
Returns T
Inherited from Curve.getPointAt
- Defined in src/math/shape/core/Curve.ts:46

getPoints

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

getResolution

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

getSpacedPoints

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

getTangent

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

getTangentAt

getTangentAt(u: number, optionalTarget: T): T
Returns tangent at equidistance point u on the curve getTangentAt(u: number, optionalTarget?: T): T;
Parameters
- u: number
- optionalTarget: T
Returns T
Inherited from Curve.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 Curve.getUtoTmapping
- Defined in src/math/shape/core/Curve.ts:140

updateArcLengths

updateArcLengths(): void
Update the cumlative segment distance cache

Returns void
Overrides Curve.updateArcLengths
- Defined in src/math/shape/core/CurvePath.ts:78

Class CurvePath<T>

Type Parameters

T extends Vector

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends Vector<T>

Returns CurvePath<T>

Properties

arcLengthDivisions

autoClose

cacheArcLengths

cacheLengths

curves

needsUpdate

Methods

add

Parameters

curve: Curve<T>

Returns void

closePath

Returns void

computeFrenetFrames

Parameters

segments: number

closed: boolean

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

binormals: Vector3[]

normals: Vector3[]

tangents: Vector3[]

getCurveLengths

Returns number[]

getLength

Returns number

getLengths

Parameters

Optional divisions: number

Returns number[]

getPoint

Parameters

t: number

Returns T

getPointAt

Parameters

u: number

Optional optionalTarget: T

Returns T

getPoints

Parameters

divisions: number = 12

Returns T[]

getResolution

Parameters

divisions: number

Returns number

getSpacedPoints

Parameters

divisions: number = 40

Returns T[]

getTangent

Parameters

t: number

optionalTarget: T

Returns T

getTangentAt

Parameters

u: number

optionalTarget: T

Returns T

getUtoTmapping

Parameters

u: number

Optional distance: number

Returns number

updateArcLengths

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

`Optional` divisions: number

`Optional` optionalTarget: T

`Optional` distance: number