Class FramedCurve

Immutable framed curve.

Hierarchy (View Summary)

Curve
- FramedCurve

Implements

IFramedCurve

Index

Constructors

constructor

new FramedCurve(frames: Frame[], distances: number[]): FramedCurve
Parameters
- frames: Frame[]
- distances: number[]
Returns FramedCurve
Overrides Curve.constructor

Accessors

closed

get closed(): boolean
Returns boolean
Overrides Curve.closed

distances

get distances(): readonly number[]
Returns readonly number[]
Implementation of IFramedCurve.distances

frames

get frames(): readonly IFrame[]
Returns readonly IFrame[]
Implementation of IFramedCurve.frames

length

get length(): number
Returns number
Overrides Curve.length

type

get type(): CurveType
Returns CurveType
Overrides Curve.type

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 framed curve at the specified distance.
Parameters
- s: number
  The distance.
Returns Vec3
The normal to the framed 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 framed curve at the specified distance.
Parameters
- s: number
  The distance.
Returns Vec3
The point on the framed curve.

Overrides Curve.point

projectedLength

projectedLength(point: IVec3): number
Calculates the distance for the specified point when projected onto the framed 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 framed curve at the specified distance.
Parameters
- s: number
  The distance.
Returns Vec3
The tangent to the framed curve.

Overrides Curve.tangent

`Static`constantOrientation

constantOrientation(
    curve: Curve,
    sagitta: number,
    maxPoints: number,
    start: number,
    end: number,
    orientation: Quat,
    auxiliary: number[],
): null | FramedCurve
Creates a framed curve by discretizing the specified source curve. The orientation of the framed curve is constant along the curve.
Parameters
- curve: Curve
  The source curve.
- sagitta: number
  The maximum sagitta, used to control the discretization.
- maxPoints: number
  The maximum number of discrete points.
- start: number
- end: number
- orientation: Quat
  The constant orientation at every point along the curve.
- auxiliary: number[]
Returns null | FramedCurve
The generated framed curve, or null if the generation failed.

Remarks
This function will return null if the number of discrete points generated exceeds the specified maximum point count.

`Static`discretize

discretize(
    curve: Curve,
    sagitta: number,
    maxPoints: number,
    start: number,
    end: number,
): null | FramedCurve
Creates a framed curve by discretizing the specified source curve. The orientation of the framed curve matches the orientation of the source curve at every discrete point.
Parameters
- curve: Curve
  The source curve.
- sagitta: number
  The maximum sagitta, used to control the discretization.
- maxPoints: number
  The maximum number of discrete points.
- start: number
- end: number
Returns null | FramedCurve
The generated framed curve, or null if the generation failed.

Remarks
This function will return null if the number of discrete points generated exceeds the specified maximum point count.

`Static`rotationMinimizing

rotationMinimizing(
    curve: Curve,
    sagitta: number,
    maxPoints: number,
    start: number,
    end: number,
    startNormal: IVec3,
    rotationOffset: IQuat,
    auxiliary: number[],
): null | FramedCurve
Parameters
- curve: Curve
- sagitta: number
- maxPoints: number
- start: number
- end: number
- startNormal: IVec3
- rotationOffset: IQuat
- auxiliary: number[]
Returns null | FramedCurve

Class FramedCurve

Hierarchy (View Summary)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns FramedCurve

Accessors

closed

Returns boolean

distances

Returns readonly number[]

frames

Returns readonly IFrame[]

length

Returns number

type

Returns CurveType

Methods

frame

Parameters

Returns Frame

normal

Parameters

Returns Vec3

Protectednormalize

Parameters

Returns number

point

Parameters

Returns Vec3

projectedLength

Parameters

Returns number

ProtectedsegmentIndex

Parameters

Returns number

tangent

Parameters

Returns Vec3

StaticconstantOrientation

Parameters

Returns null | FramedCurve

Remarks

Staticdiscretize

Parameters

Returns null | FramedCurve

Remarks

StaticrotationMinimizing

Parameters

Returns null | FramedCurve

Settings

On This Page

`Protected`normalize

`Protected`segmentIndex

`Static`constantOrientation

`Static`discretize

`Static`rotationMinimizing