Class CompositeCurve

Immutable composite curve.

Remarks

A Composite curve is a curve formed from several curves.

Hierarchy (View Summary)

Curve
- CompositeCurve

Index

Constructors

Accessors

closed curves length type default

Methods

frame normal normalize point projectedLength segmentIndex tangent

Constructors

constructor

new CompositeCurve(curves: readonly Curve[]): CompositeCurve
Constructor.
Parameters
- curves: readonly Curve[]
  The curves that form the composite curve.
Returns CompositeCurve
Overrides Curve.constructor

Accessors

closed

get closed(): boolean
Whether the curve is closed.

Returns boolean
Overrides Curve.closed

curves

get curves(): readonly Curve[]
The individual curves that form the composite curve.

Returns readonly Curve[]

length

get length(): number
The length of the curve.

Returns number
Overrides Curve.length

type

get type(): CurveType
The type of the curve.

Returns CurveType
Overrides Curve.type

`Static`default

get default(): CompositeCurve
Empty composite curve.

Returns CompositeCurve

Methods

frame

frame(s: number): Frame
Evaluates the frame at the specified distance.
Parameters
- s: number
  The distance.
Returns Frame
The frame.

Overrides Curve.frame

normal

normal(s: number): Vec3
Evaluates the normal to the composite curve at the specified distance.
Parameters
- s: number
  The distance.
Returns Vec3
The normal to the curve.

Overrides Curve.normal

`Protected`normalize

normalize(s: number): number
Parameters
- s: number
Returns number
Inherited from Curve.normalize

point

point(s: number): Vec3
Evaluates the point on the composite curve at the specified distance.
Parameters
- s: number
  The distance.
Returns Vec3
The point on the curve.

Overrides Curve.point

projectedLength

projectedLength(point: IVec3): number
Calculates the distance for the specified point when projected onto the composite curve.
Parameters
- point: IVec3
  The point.
Returns number
The distance (arc-length) for the projected point.

Overrides Curve.projectedLength

`Protected`segmentIndex

segmentIndex(s: number, distances: number[]): number
Parameters
- s: number
- distances: number[]
Returns number
Inherited from Curve.segmentIndex

tangent

tangent(s: number): Vec3
Evaluates the tangent to the composite curve at the specified distance.
Parameters
- s: number
  The distance.
Returns Vec3
The tangent to the curve.

Overrides Curve.tangent