Class CurvePath<T>

An abstract base class extending Curve. A CurvePath is simply an array of connected curves, but retains the api of a curve.

Type Parameters

T extends Vector

Hierarchy

Curve<T>
- CurvePath
  - Path

Constructors

constructor

new CurvePath<T>(): CurvePath<T>
Ceates a new Curve instance.
Type Parameters
- T extends Vector<T>
Returns CurvePath<T>
Inherited from Curve.constructor
- Defined in core/Curve.d.ts:26

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

autoClose

autoClose: boolean

Whether or not to automatically close the path.

Default Value

false

curves

curves: Curve<T>[]

The array of Curves.

Default Value

[]

`Readonly` isArcCurve

isArcCurve: boolean

subclass should override

Default Value

false

`Readonly` isCatmullRomCurve3

isCatmullRomCurve3: boolean

subclass should override

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

`Readonly` type

type: string

Default Value

'CurvePath'

Methods

add

add(curve: Curve<T>): void
Add a curve to the curves array.
Parameters
- curve: Curve<T>
  
  The curve to add.
Returns void
- Defined in core/CurvePath.d.ts:30

clone

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

Returns
A new Curve instance exactly like this curve.

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

closePath

closePath(): void
Adds a lineCurve to close the path if start and end of lines are not connected.

Returns void
- Defined in core/CurvePath.d.ts:36

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<T>): CurvePath<T>
Copies another Curve object's properties to this instance.

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

fromJSON

fromJSON(json: object): CurvePath<T>
Copies the data from the given JSON object to this instance.

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

getCurveLengths

getCurveLengths(): number[]
Get list of cumulative curve lengths of this instance curves.

Returns
The lengths of each curve.

Returns number[]
- Defined in core/CurvePath.d.ts:42

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?: T): T
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: T
  
  (optional) If specified, the result will be copied into this Vector, otherwise a new Vector will be created.
Returns T
Inherited from Curve.getPoint
- Defined in core/Curve.d.ts:35

getPointAt

getPointAt(u: number, optionalTarget?: T): T
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: T
  
  (optional) If specified, the result will be copied into this Vector, otherwise a new Vector will be created.
Returns T
Inherited from Curve.getPointAt
- Defined in core/Curve.d.ts:44

getPoints

getPoints(divisions?: number): T[]
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 12.
Returns T[]
Overrides Curve.getPoints
- Defined in core/CurvePath.d.ts:49

getSpacedPoints

getSpacedPoints(divisions?: number): T[]
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 40.
Returns T[]
Overrides Curve.getSpacedPoints
- Defined in core/CurvePath.d.ts:56

getTangent

getTangent(t: number, optionalTarget?: T): T
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: T
  
  — (optional) If specified, the result will be copied into this Vector, otherwise a new Vector will be created.
Returns T
Inherited from Curve.getTangent
- Defined in core/Curve.d.ts:93

getTangentAt

getTangentAt(u: number, optionalTarget?: T): T
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: T
  
  (optional) If specified, the result will be copied into this Vector, otherwise a new Vector will be created.
Returns T
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 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

Default

autoClose

Default Value

curves

Default Value

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

Readonly type

Default Value

Methods

add

Parameters

curve: Curve<T>

Returns void

clone

Returns

Returns Curve<T>

closePath

Returns void

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<T>

Returns CurvePath<T>

fromJSON

Returns

Parameters

json: object

Returns CurvePath<T>

getCurveLengths

Returns

Returns number[]

getLength

Returns

Returns number

getLengths

Returns

Parameters

`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: T

`Optional` optionalTarget: T

`Optional` divisions: number

`Optional` divisions: number

`Optional` optionalTarget: T

`Optional` optionalTarget: T