Class Line

Immutable line segment.

Hierarchy (View Summary)

Curve
- Line

Implements

ILine

Index

Constructors

Properties

direction length origin surfaceNormal

Accessors

closed type default

Methods

frame normal normalize point projectedLength segmentIndex tangent

Constructors

constructor

new Line(
    origin: Vec3,
    direction: Vec3,
    length: number,
    surfaceNormal?: Vec3,
): Line
Constructor.
Parameters
- origin: Vec3
  The origin.
- direction: Vec3
  The direction.
- length: number
  The length.
- surfaceNormal: Vec3 = Vec3.zero
  The (optional) surface normal.
Returns Line
Overrides Curve.constructor

Properties

`Readonly`direction

direction: Vec3

The direction of the line segment.

`Readonly`length

length: number

The length of the line segment.

`Readonly`origin

origin: Vec3

The origin of the line segment.

`Readonly`surfaceNormal

surfaceNormal: Vec3

The surface normal of the line segment.

Accessors

closed

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

Returns boolean
Overrides Curve.closed

type

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

Returns CurveType
Overrides Curve.type

`Static`default

get default(): Line
Returns Line

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

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

Overrides Curve.point

projectedLength

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

Overrides Curve.tangent