@lakuna/umath
    Preparing search index...

    Interface Vector

    A quantity with magnitude and direction.

    interface Vector {
        get magnitude(): number;
        get squaredMagnitude(): number;
        add(vector: Vector4Like): VectorLike;
        ceil(): VectorLike;
        clone(): VectorLike;
        copy(vector: Vector4Like): this;
        distance(vector: Vector4Like): number;
        divide(vector: Vector4Like): VectorLike;
        dot(vector: Vector4Like): number;
        equals(vector: Vector4Like): boolean;
        exactEquals(vector: Vector4Like): boolean;
        floor(): VectorLike;
        invert(): VectorLike;
        lerp(vector: Vector4Like, t: number): VectorLike;
        max(vector: Vector4Like): VectorLike;
        min(vector: Vector4Like): VectorLike;
        multiply(vector: Vector4Like): VectorLike;
        negate(): VectorLike;
        normalize(): VectorLike;
        random(magnitude: number): this;
        round(): VectorLike;
        scale(scalar: number): VectorLike;
        scaleAndAdd(vector: Vector4Like, scalar: number): VectorLike;
        squaredDistance(vector: Vector4Like): number;
        subtract(vector: Vector4Like): VectorLike;
        zero(): this;
        [key: number]: number;
    }

    Hierarchy (View Summary)

    Implemented by

    Indexable

    • [key: number]: number
    Index

    Accessors

    • get squaredMagnitude(): number

      Get the squared magnitude (length) of this vector.

      Returns number

    Methods

    • Determine whether this vector is roughly equivalent to another.

      Parameters

      Returns boolean

      Whether the vectors are equivalent.

    • Determine whether this vector is exactly equivalent to another.

      Parameters

      Returns boolean

      Whether the vectors are equivalent.

    • Set this vector to a random value with the given magnitude.

      Parameters

      • magnitude: number

        The magnitude.

      Returns this

      This vector.

    • Calculate the squared Euclidean distance between this vector and another.

      Parameters

      Returns number

      The squared distance.