Class Vector4

constructor

• new Vector4(x?: number, y?: number, z?: number, w?: number): Vector4

  Parameters

  • Optionalx: number

    The x component.

  • Optionaly: number

    The y component.

  • Optionalz: number

    The z component.

  • Optionalw: number

    The w component.

  Returns Vector4

w

x

y

z

add

• add(v: Vector2 | Vector4 | Vector3): Vector4

  Add a given Vector to this Vector. Addition is component-wise.

  Parameters

  • v: Vector2 | Vector4 | Vector3

    The Vector to add to this Vector.

  Returns Vector4

  This Vector4.

clone

• clone(): Vector4

  Make a clone of this Vector4.undefined

  Returns Vector4

  A clone of this Vector4.

copy

• copy(src: Vector4): Vector4

  Copy the components of a given Vector into this Vector.

  Parameters

  • src: Vector4

    The Vector to copy the components from.

  Returns Vector4

  This Vector4.

distance

• distance(v: Vector2 | Vector4 | Vector3): number

  Calculate the distance between this Vector and the given Vector.

  Parameters

  • v: Vector2 | Vector4 | Vector3

    The Vector to calculate the distance to.

  Returns number

  The distance from this Vector to the given Vector.

distanceSq

• distanceSq(v: Vector2 | Vector4 | Vector3): number

  Calculate the distance between this Vector and the given Vector, squared.

  Parameters

  • v: Vector2 | Vector4 | Vector3

    The Vector to calculate the distance to.

  Returns number

  The distance from this Vector to the given Vector, squared.

divide

• divide(v: Vector2 | Vector4 | Vector3): Vector4

  Perform a component-wise division between this Vector and the given Vector.

  Divides this Vector by the given Vector.

  Parameters

  • v: Vector2 | Vector4 | Vector3

    The Vector to divide this Vector by.

  Returns Vector4

  This Vector4.

dot

• dot(v: Vector4): number

  Calculate the dot product of this Vector and the given Vector.

  Parameters

  • v: Vector4

    The Vector4 to dot product with this Vector4.

  Returns number

  The dot product of this Vector and the given Vector.

equals

• equals(v: Vector4): boolean

  Check whether this Vector is equal to a given Vector.

  Performs a strict equality check against each Vector's components.

  Parameters

  • v: Vector4

    The vector to check equality with.

  Returns boolean

  A boolean indicating whether the two Vectors are equal or not.

length

• length(): number

  Calculate the length (or magnitude) of this Vector.undefined

  Returns number

  The length of this Vector.

lengthSq

• lengthSq(): number

  Calculate the length of this Vector squared.undefined

  Returns number

  The length of this Vector, squared.

lerp

• lerp(v: Vector4, t?: number): Vector4

  Linearly interpolate between this Vector and the given Vector.

  Interpolates this Vector towards the given Vector.

  Parameters

  • v: Vector4

    The Vector4 to interpolate towards.

  • Optionalt: number

    The interpolation percentage, between 0 and 1. Default 0.

  Returns Vector4

  This Vector4.

multiply

• multiply(v: Vector2 | Vector4 | Vector3): Vector4

  Perform a component-wise multiplication between this Vector and the given Vector.

  Multiplies this Vector by the given Vector.

  Parameters

  • v: Vector2 | Vector4 | Vector3

    The Vector to multiply this Vector by.

  Returns Vector4

  This Vector4.

negate

• negate(): Vector4

  Negate the x, y, z and w components of this Vector.undefined

  Returns Vector4

  This Vector4.

normalize

• normalize(): Vector4

  Normalize this Vector.

  Makes the vector a unit length vector (magnitude of 1) in the same direction.undefined

  Returns Vector4

  This Vector4.

reset

• reset(): Vector4

  Make this Vector the zero vector (0, 0, 0, 0).undefined

  Returns Vector4

  This Vector4.

scale

• scale(scale: number): Vector4

  Scale this Vector by the given value.

  Parameters

  • scale: number

    The value to scale this Vector by.

  Returns Vector4

  This Vector4.

set

• set(x: number | object, y: number, z: number, w: number): Vector4

  Set the x, y, z and w components of the this Vector to the given x, y, z and w values.

  Parameters

  • x: number | object

    The x value to set for this Vector, or an object containing x, y, z and w components.

  • y: number

    The y value to set for this Vector.

  • z: number

    The z value to set for this Vector.

  • w: number

    The w value to set for this Vector.

  Returns Vector4

  This Vector4.

subtract

• subtract(v: Vector2 | Vector4 | Vector3): Vector4

  Subtract the given Vector from this Vector. Subtraction is component-wise.

  Parameters

  • v: Vector2 | Vector4 | Vector3

    The Vector to subtract from this Vector.

  Returns Vector4

  This Vector4.

transformMat4

• transformMat4(mat: Matrix4): Vector4

  Transform this Vector with the given Matrix.

  Parameters

  • mat: Matrix4

    The Matrix4 to transform this Vector4 with.

  Returns Vector4

  This Vector4.

transformQuat

• transformQuat(q: Quaternion): Vector4

  Transform this Vector with the given Quaternion.

  Parameters

  • q: Quaternion

    The Quaternion to transform this Vector with.

  Returns Vector4

  This Vector4.