Class Frame

Immutable affine frame.

Implements

IFrame

Index

Constructors

Properties

position rotation

Accessors

Methods

equals lerp multiply notEquals rotation slerp translation

Constructors

constructor

new Frame(rotation: Quat, position: Vec3): Frame
Constructor.
Parameters
- rotation: Quat
  The rotation of the frame.
- position: Vec3
  The origin of the frame.
Returns Frame

Properties

`Readonly`position

position: Vec3

The origin of the frame.

`Readonly`rotation

rotation: Quat

The rotation of the frame.

Accessors

`Static`identity

get identity(): Frame
Creates the identity frame.

Returns Frame

Methods

`Static`equals

equals(lhs: IFrame, rhs: IFrame): boolean
Determines whether two frames are exactly equal.
Parameters
- lhs: IFrame
  The first frame.
- rhs: IFrame
  The second frame.
Returns boolean
True if the two frames are exactly equal, false otherwise.

`Static`lerp

lerp(start: IFrame, end: IFrame, weight: number): Frame
Linearly interpolates between the two frames.
Parameters
- start: IFrame
  The start frame.
- end: IFrame
  The end frame.
- weight: number
  The interpolation fraction [0, 1] between the two frames.
Returns Frame
The interpolated frame.

`Static`multiply

multiply(lhs: IFrame, rhs: IFrame): Frame
Multiplies the first frame by the second frame.
Parameters
- lhs: IFrame
  The first frame.
- rhs: IFrame
  The second frame.
Returns Frame
The first frame multiplied by the second frame.

`Static`notEquals

notEquals(lhs: IFrame, rhs: IFrame): boolean
Determines whether two frames are not exactly equal.
Parameters
- lhs: IFrame
  The first frame.
- rhs: IFrame
  The second frame.
Returns boolean
True if the two frames are different, false otherwise.

`Static`rotation

rotation(value: Quat): Frame
Creates a frame from a rotation.
Parameters
- value: Quat
  The rotation.
Returns Frame
The rotation frame.

`Static`slerp

slerp(start: IFrame, end: IFrame, weight: number): Frame
Spherically interpolates between two frames.
Parameters
- start: IFrame
  The start frame.
- end: IFrame
  The end frame.
- weight: number
  The interpolation fraction [0, 1] between the two frames.
Returns Frame
The interpolated frame.

`Static`translation

translation(value: Vec3): Frame
Creates a frame from a translation.
Parameters
- value: Vec3
  The translation.
Returns Frame
The translation frame.