Class CatmullRomCurve3

A smooth 3d spline curve from a series of points using the Catmull-Rom algorithm.

References: https://en.wikipedia.org/wiki/Centripetal_Catmull%E2%80%93Rom_spline

http://www.cemyuksel.com/research/catmullrom_param/

Example

//Create a closed wavey loop
const curve = new CatmullRomCurve3( [
  new Vector3( -10, 0, 10 ),
  new Vector3( -5, 5, 5 ),
  new Vector3( 0, 0, 0 ),
  new Vector3( 5, -5, 5 ),
  new Vector3( 10, 0, 10 )
] );

const points = curve.getPoints( 50 );

Hierarchy

Curve<Vector3>
- CatmullRomCurve3

Constructors

constructor

new CatmullRomCurve3(points?: Vector3[], isClosed?: boolean, curveType?: CatmullRomCurveType, tension?: number): CatmullRomCurve3
Parameters
- Optional points: Vector3[]
  
  An array of Vector3 points. Default is [].
- Optional isClosed: boolean
  
  Whether the curve is closed. Default is false.
- Optional curveType: CatmullRomCurveType
  
  Curve paramertization name. Default is 'centripetal'.
- Optional tension: number
  
  Tension of the curve. Default is 0.5.
Returns CatmullRomCurve3
Overrides Curve.constructor
- Defined in curves/CatmullRomCurve3.d.ts:74

Properties

arcLengthDivisions

arcLengthDivisions: number

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

closed

closed: boolean

The curve will loop back onto itself when this is true.

curveType

curveType: CatmullRomCurveType

When curveType is catmullrom, defines catmullrom's tension.

`Readonly` isArcCurve

isArcCurve: boolean

subclass should override

Default Value

false

`Readonly` isCatmullRomCurve3

isCatmullRomCurve3: boolean

Default Value

true

`Readonly` isCubicBezierCurve

isCubicBezierCurve: boolean

subclass should override

Default Value

false

`Readonly` isCubicBezierCurve3

isCubicBezierCurve3: boolean

subclass should override

Default Value

false

`Readonly` isEllipseCurve

isEllipseCurve: boolean

subclass should override

Default Value

false

`Readonly` isLineCurve

isLineCurve: boolean

subclass should override

Default Value

false

`Readonly` isLineCurve3

isLineCurve3: boolean

subclass should override

Default Value

false

`Readonly` isQuadraticBezierCurve

isQuadraticBezierCurve: boolean

subclass should override

Default Value

false

`Readonly` isQuadraticBezierCurve3

isQuadraticBezierCurve3: boolean

subclass should override

Default Value

false

`Readonly` isSplineCurve

isSplineCurve: boolean

subclass should override

Default Value

false

points

points: Vector3[]

The array of Vector3 points that define the curve. It needs at least two entries.

Default Value

[]

tension

tension: number

When curveType is catmullrom, defines catmullrom's tension.

`Readonly` type

type: string

Default Value

'CatmullRomCurve3'

Methods

clone

clone(): Curve<Vector3>
Creates a new instance with same property values as this curve.

Returns
A new Curve instance exactly like this curve.

Returns Curve<Vector3>
Inherited from Curve.clone
- Defined in core/Curve.d.ts:134

computeFrenetFrames

computeFrenetFrames(segments: number, closed?: boolean): { binormals: Vector3[]; normals: Vector3[]; tangents: Vector3[] }
Generates the Frenet frames. Learn more at http://www.cs.indiana.edu/pub/techreports/TR425.pdf

Returns
An object with shape: { tangents: Vector3[]; normals: Vector3[]; binormals: Vector3[]; }
Parameters
- segments: number
  
  Number of segments
- Optional closed: boolean
  
  True if this curve is closed.
Returns { binormals: Vector3[]; normals: Vector3[]; tangents: Vector3[] }
- binormals: Vector3[]
- normals: Vector3[]
- tangents: Vector3[]
Inherited from Curve.computeFrenetFrames
- Defined in core/Curve.d.ts:121

copy

copy(source: Curve<Vector3>): CatmullRomCurve3
Copies another Curve object's properties to this instance.

Returns
This instance.
Parameters
- source: Curve<Vector3>
  
  The source curve.
Returns CatmullRomCurve3
Inherited from Curve.copy
- Defined in core/Curve.d.ts:141

fromJSON

fromJSON(json: object): CatmullRomCurve3
Copies the data from the given JSON object to this instance.

Returns
This instance.
Parameters
- json: object
  
  The source JSON object.
Returns CatmullRomCurve3
Inherited from Curve.fromJSON
- Defined in core/Curve.d.ts:154

getLength

getLength(): number
Get total curve arc length.

Returns
The total arc length.

Returns number
Inherited from Curve.getLength
- Defined in core/Curve.d.ts:64

getLengths

getLengths(divisions?: number): number[]
Get list of cumulative segment lengths.

Returns
Array of points
Parameters
- Optional divisions: number
Returns number[]
Inherited from Curve.getLengths
- Defined in core/Curve.d.ts:71

getPoint

getPoint(t: number, optionalTarget?: Vector3): Vector3
Find the point (vector) for point t of the curve where t is between 0 and 1.

Returns
The point.
Parameters
- t: number
  
  A position on the curve. Must be in the range [ 0, 1 ].
- Optional optionalTarget: Vector3
  
  (optional) If specified, the result will be copied into this Vector, otherwise a new Vector will be created.
Returns Vector3
Inherited from Curve.getPoint
- Defined in core/Curve.d.ts:35

getPointAt

getPointAt(u: number, optionalTarget?: Vector3): Vector3
Find a vector for point at relative position in curve according to arc length

Returns
The point.
Parameters
- u: number
  
  A position on the curve according to the arc length. Must be in the range [ 0, 1 ].
- Optional optionalTarget: Vector3
  
  (optional) If specified, the result will be copied into this Vector, otherwise a new Vector will be created.
Returns Vector3
Inherited from Curve.getPointAt
- Defined in core/Curve.d.ts:44

getPoints

getPoints(divisions?: number): Vector3[]
Compute a set of divisions + 1 points using getPoint( t ).

Returns
Array of point vectors.
Parameters
- Optional divisions: number
  
  number of pieces to divide the curve into. Default is 5.
Returns Vector3[]
Inherited from Curve.getPoints
- Defined in core/Curve.d.ts:51

getSpacedPoints

getSpacedPoints(divisions?: number): Vector3[]
Compute a set of divisions + 1 equi-spaced points using getPointAt( u ).

Returns
Array of point vectors.
Parameters
- Optional divisions: number
  
  number of pieces to divide the curve into. Default is 5.
Returns Vector3[]
Inherited from Curve.getSpacedPoints
- Defined in core/Curve.d.ts:58

getTangent

getTangent(t: number, optionalTarget?: Vector3): Vector3
Compute 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;

Returns
A vector tangent to t.
Parameters
- t: number
  
  A position on the curve. Must be in the range [ 0, 1 ].
- Optional optionalTarget: Vector3
  
  — (optional) If specified, the result will be copied into this Vector, otherwise a new Vector will be created.
Returns Vector3
Inherited from Curve.getTangent
- Defined in core/Curve.d.ts:93

getTangentAt

getTangentAt(u: number, optionalTarget?: Vector3): Vector3
Compute the tangent at a point which is equidistant to the ends of the curve from the point given in getTangent().

Returns
a vector tangent to u.
Parameters
- u: number
  
  A position on the curve according to the arc length. Must be in the range [ 0, 1 ].
- Optional optionalTarget: Vector3
  
  (optional) If specified, the result will be copied into this Vector, otherwise a new Vector will be created.
Returns Vector3
Inherited from Curve.getTangentAt
- Defined in core/Curve.d.ts:108

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 Curve.getUtoTmapping
- Defined in core/Curve.d.ts:81

toJSON

toJSON(): object
Create a JSON object representation of this instance.

Returns
A JSON object

Returns object
Inherited from Curve.toJSON
- Defined in core/Curve.d.ts:147

updateArcLengths

updateArcLengths(): void
Update the cumlative segment distance cache

Returns void
Inherited from Curve.updateArcLengths
- Defined in core/Curve.d.ts:76

Class CatmullRomCurve3

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional points: Vector3[]

Optional isClosed: boolean

Optional curveType: CatmullRomCurveType

Optional tension: number

Returns CatmullRomCurve3

Properties

arcLengthDivisions

Default

closed

curveType

Readonly isArcCurve

Default Value

Readonly isCatmullRomCurve3

Default Value

Readonly isCubicBezierCurve

Default Value

Readonly isCubicBezierCurve3

Default Value

Readonly isEllipseCurve

Default Value

Readonly isLineCurve

Default Value

Readonly isLineCurve3

Default Value

Readonly isQuadraticBezierCurve

Default Value

Readonly isQuadraticBezierCurve3

Default Value

Readonly isSplineCurve

Default Value

points

Default Value

tension

Readonly type

Default Value

Methods

clone

Returns

Returns Curve<Vector3>

computeFrenetFrames

Returns

Parameters

segments: number

Optional closed: boolean

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

binormals: Vector3[]

normals: Vector3[]

tangents: Vector3[]

copy

Returns

Parameters

source: Curve<Vector3>

Returns CatmullRomCurve3

fromJSON

Returns

Parameters

json: object

Returns CatmullRomCurve3

getLength

Returns

Returns number

getLengths

Returns

Parameters

Optional divisions: number

Returns number[]

getPoint

Returns

Parameters

t: number

`Optional` points: Vector3[]

`Optional` isClosed: boolean

`Optional` curveType: CatmullRomCurveType

`Optional` tension: number

`Readonly` isArcCurve

`Readonly` isCatmullRomCurve3

`Readonly` isCubicBezierCurve

`Readonly` isCubicBezierCurve3

`Readonly` isEllipseCurve

`Readonly` isLineCurve

`Readonly` isLineCurve3

`Readonly` isQuadraticBezierCurve

`Readonly` isQuadraticBezierCurve3

`Readonly` isSplineCurve

`Readonly` type

`Optional` closed: boolean

`Optional` divisions: number

`Optional` optionalTarget: Vector3

`Optional` optionalTarget: Vector3

`Optional` divisions: number

`Optional` divisions: number

`Optional` optionalTarget: Vector3

`Optional` optionalTarget: Vector3