Class CatmullRomCurve3

Centripetal CatmullRom Curve - which is useful for avoiding cusps and self-intersections in non-uniform catmull rom curves. http://www.cemyuksel.com/research/catmullrom_param/catmullrom.pdf

curve.type accepts centripetal(default), chordal and catmullrom curve.tension is used for catmullrom which defaults to 0.5

Hierarchy

Curve<Vector3>
- CatmullRomCurve3

Index

Constructors

constructor

new CatmullRomCurve3(points?: Vector3[], closed?: boolean, curveType?: string, tension?: number): CatmullRomCurve3
Parameters
- points: Vector3[] = []
- closed: boolean = false
- curveType: string = 'centripetal'
- tension: number = 0.5
Returns CatmullRomCurve3
Overrides Curve.constructor
- Defined in src/math/shape/curves/CatmullRomCurve3.ts:21

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.

cacheArcLengths

cacheArcLengths: number[]

closed

closed: boolean

curveType

curveType: string

isCatmullRomCurve3

isCatmullRomCurve3: boolean = true

needsUpdate

needsUpdate: boolean = false

points

points: Vector3[]

tension

tension: number

Methods

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

getLength

getLength(): number
Get total curve arc length

Returns number
Inherited from Curve.getLength
- Defined in src/math/shape/core/Curve.ts:87

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, optionalTarget?: Vector3): Vector3
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
- optionalTarget: Vector3 = ...
Returns Vector3
Overrides Curve.getPoint
- Defined in src/math/shape/curves/CatmullRomCurve3.ts:31

getPointAt

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

getPoints

getPoints(divisions?: number): Vector3[]
Get sequence of points using getPoint( t )
Parameters
- divisions: number = 5
Returns Vector3[]
Inherited from Curve.getPoints
- Defined in src/math/shape/core/Curve.ts:56

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): any[]
Get sequence of equi-spaced points using getPointAt( u )
Parameters
- divisions: number
Returns any[]
Inherited from Curve.getSpacedPoints
- Defined in src/math/shape/core/Curve.ts:71

getTangent

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

getTangentAt

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

Class CatmullRomCurve3

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

points: Vector3[] = []

closed: boolean = false

curveType: string = 'centripetal'

tension: number = 0.5

Returns CatmullRomCurve3

Properties

arcLengthDivisions

cacheArcLengths

closed

curveType

isCatmullRomCurve3

needsUpdate

points

tension

Methods

computeFrenetFrames

Parameters

segments: number

closed: boolean

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

binormals: Vector3[]

normals: Vector3[]

tangents: Vector3[]

getLength

Returns number

getLengths

Parameters

Optional divisions: number

Returns number[]

getPoint

Parameters

t: number

optionalTarget: Vector3 = ...

Returns Vector3

getPointAt

Parameters

u: number

Optional optionalTarget: Vector3

Returns Vector3

getPoints

Parameters

divisions: number = 5

Returns Vector3[]

getResolution

Parameters

divisions: number

Returns number

getSpacedPoints

Parameters

divisions: number

Returns any[]

getTangent

Parameters

t: number

optionalTarget: Vector3

Returns Vector3

getTangentAt

Parameters

u: number

optionalTarget: Vector3

Returns Vector3

getUtoTmapping

Parameters

u: number

Optional distance: number

Returns number

updateArcLengths

Returns void

Settings

Member Visibility

Theme

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

`Optional` divisions: number

`Optional` optionalTarget: Vector3

`Optional` distance: number