Class Ray

The Ray implements a ray in 3D space represented with an origin and direction. The class follows the 'copy-on-write' pattern, which means that every operation such as Ray.multiplyScalar returns a copy of the ray with updates values. It also implies that the values of the ray cannot be directly modified.

The concept of immutability improves sharing of objects as all types in TypeScript are assigned by identity, instead of by-value (e.g. a copy) as in other programming languages like C.

Index

Constructors

Properties

_direction _origin

Accessors

direction origin

Methods

assign clone doTransform doTransformAffine isEqual multiplyScalar project toString isEqual multiplyScalar transformAffine transformed

Constructors

constructor

new Ray(origin?, direction?): Ray
Parameters
- Optionalorigin: Immutable<Vector3>
- Optionaldirection: Immutable<Vector3>
Returns Ray
Inherited from RayGenerated.constructor

Properties

`Protected`_direction

_direction: Vector3

`Protected`_origin

_origin: Vector3

Accessors

direction

get direction(): Vector3
Returns Vector3
Inherited from RayGenerated.direction
set direction(value): void
Parameters
- value: Immutable<Vector3>
Returns void
Inherited from RayGenerated.direction

origin

get origin(): Vector3
Returns Vector3
Inherited from RayGenerated.origin
set origin(value): void
Parameters
- value: Immutable<Vector3>
Returns void
Inherited from RayGenerated.origin

Methods

assign

assign(other): Ray
Copies all properties defined by the prototype of Ray from other to this instance.
Parameters
- other: Immutable<Ray>
Returns Ray
Inherited from RayGenerated.assign

clone

clone(): Ray
Clones this instance and returns a new Ray with identical values.

Returns Ray
Inherited from RayGenerated.clone

doTransform

doTransform(matrix): Ray
Transforms the ray by the specified matrix. If the matrix is affine use transformAffine as it is faster.
Parameters
- matrix: Immutable<Matrix4>
  Matrix to transform the ray by.
Returns Ray

doTransformAffine

doTransformAffine(matrix): Ray
Transforms the ray by the specified affine matrix.
Parameters
- matrix: Immutable<Matrix4>
  Affine matrix to transform the ray by.
Returns Ray

isEqual

isEqual(this, other): boolean
Determines if this Ray instance is equal to the other instance.
Parameters
- this: Immutable<Ray>
- other: Immutable<Ray>
Returns boolean
Inherited from RayGenerated.isEqual

multiplyScalar

multiplyScalar(t): Vector3
Multiplies this ray by a scalar and returns a point along the ray.
Parameters
- t: number
  How far along the ray to retrieve the point.
Returns Vector3
Point along the ray t units away from the origin.

project

project(point): Vector3
Project a point on the ray.
Parameters
- point: Immutable<Vector3>
  Point to project.
Returns Vector3

toString

toString(): string
Returns a string representation of an object.

Returns string

`Static`isEqual

isEqual(lhs, rhs): boolean
Determines if both Ray instances are equal.
Parameters
- lhs: Immutable<Ray>
- rhs: Immutable<Ray>
Returns boolean
Inherited from RayGenerated.isEqual

`Static`multiplyScalar

multiplyScalar(ray, t): Vector3
Multiples a ray by a scalar and retrieves a point along the ray.
Parameters
- ray: Immutable<Ray>
  Ray to transform.
- t: number
  How far along the ray to retrieve the point.
Returns Vector3
Point along the ray t units away from the origin.

`Static`transformAffine

transformAffine(ray, matrix): Ray
Transforms the ray by the specified affine matrix.
Parameters
- ray: Immutable<Ray>
  Ray to transform.
- matrix: Immutable<Matrix4>
  Matrix to transform the ray by.
Returns Ray
The transformed Ray

`Static`transformed

transformed(ray, matrix): Ray
Transforms the ray by the specified matrix. If the matrix is affine use transformAffine as it is faster.
Parameters
- ray: Immutable<Ray>
  Ray to transform.
- matrix: Immutable<Matrix4>
  Matrix to transform the ray by.
Returns Ray
The transformed Ray