RSX Code Reference
    Preparing search index...

    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
    _direction: Vector3
    _origin: Vector3
    • Copies all properties defined by the prototype of Ray from other to this instance.

      Parameters

      Returns Ray

    • Clones this instance and returns a new Ray with identical values.

      Returns Ray

    • Transforms the ray by the specified matrix. If the matrix is affine use transformAffine as it is faster.

      Parameters

      Returns Ray

    • Transforms the ray by the specified affine matrix.

      Parameters

      Returns Ray

    • 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.

    • Returns a string representation of an object.

      Returns string

    • 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.