Class Vector

constructor

• new Vector(x, y, z): Vector

• Parameters

  • x: number

    X component of the vector.

  • y: number

    Y component of the vector.

  • z: number

    Z component of the vector.

  Returns Vector

  Remarks

  Creates a new instance of an abstract vector.

x

y

z

Static Readonly back

Static Readonly down

Static Readonly forward

Static Readonly left

Static Readonly one

Static Readonly right

Static Readonly up

Static Readonly zero

equals

• equals(other): boolean

• Parameters

  • other: Vector

    Other vector to compare this vector to.

  Returns boolean

  True if the two vectors are equal.

  Remarks

  Compares this vector and another vector to one another.

length

• length(): number

• Returns number

  Remarks

  Returns the length of this vector.

lengthSquared

• lengthSquared(): number

• Returns number

  Remarks

  Returns the squared length of this vector.

normalized

• normalized(): Vector

• Returns Vector

  Remarks

  Returns this vector as a normalized vector.

Static add

• add(a, b): Vector

• Parameters

  • a: Vector

  • b: Vector

  Returns Vector

  Remarks

  Returns the addition of these vectors.

Static cross

• cross(a, b): Vector

• Parameters

  • a: Vector

  • b: Vector

  Returns Vector

  Remarks

  Returns the cross product of these two vectors.

Static distance

• distance(a, b): number

• Parameters

  • a: Vector

  • b: Vector

  Returns number

  Remarks

  Returns the distance between two vectors.

Static divide

• divide(a, b): Vector

• Parameters

  • a: Vector

  • b: number | Vector

  Returns Vector

  Remarks

  Returns the component-wise division of these vectors.

Static lerp

• lerp(a, b, t): Vector

• Parameters

  • a: Vector

  • b: Vector

  • t: number

  Returns Vector

  Remarks

  Returns the linear interpolation between a and b using t as the control.

Static max

• max(a, b): Vector

• Parameters

  • a: Vector

  • b: Vector

  Returns Vector

  Remarks

  Returns a vector that is made from the largest components of two vectors.

Static min

• min(a, b): Vector

• Parameters

  • a: Vector

  • b: Vector

  Returns Vector

  Remarks

  Returns a vector that is made from the smallest components of two vectors.

Static multiply

• multiply(a, b): Vector

• Parameters

  • a: Vector

  • b: number | Vector

  Returns Vector

  Remarks

  Returns the component-wise product of these vectors.

Static slerp

• slerp(a, b, s): Vector

• Parameters

  • a: Vector

  • b: Vector

  • s: number

  Returns Vector

  Remarks

  Returns the spherical linear interpolation between a and b using s as the control.

Static subtract

• subtract(a, b): Vector

• Parameters

  • a: Vector

  • b: Vector

  Returns Vector

  Remarks

  Returns the subtraction of these vectors.