Class Vector4

constructor

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

• Parameters

  • Optional x: number
  • Optional y: number
  • Optional z: number
  • Optional w: number

  Returns Vector4

height

Readonly isVector4

width

[iterator]

• [iterator](): Iterator<number, any, undefined>

• Iterating through a Vector4 instance will yield its components (x, y, z, w) in the corresponding order.

  Returns Iterator<number, any, undefined>

add

• add(v): this

• Adds v to this vector.

  Parameters

  • v: Vector4Like

  Returns this

addScalar

• addScalar(scalar): this

• Parameters

  • scalar: number

  Returns this

addScaledVector

• addScaledVector(v, s): this

• Parameters

  • v: Vector4Like
  • s: number

  Returns this

addVectors

• addVectors(a, b): this

• Sets this vector to a + b.

  Parameters

  • a: Vector4Like
  • b: Vector4Like

  Returns this

applyMatrix4

• applyMatrix4(m): this

• Parameters

  • m: Matrix4

  Returns this

ceil

• ceil(): this

• Returns this

clamp

• clamp(min, max): this

• Parameters

  • min: Vector4Like
  • max: Vector4Like

  Returns this

clampScalar

• clampScalar(min, max): this

• Parameters

  • min: number
  • max: number

  Returns this

copy

• copy(v): this

• Copies value of v to this vector.

  Parameters

  • v: Vector4Like

  Returns this

divideScalar

• divideScalar(s): this

• Divides this vector by scalar s. Set vector to ( 0, 0, 0 ) if s == 0.

  Parameters

  • s: number

  Returns this

dot

• dot(v): number

• Computes dot product of this vector and v.

  Parameters

  • v: Vector4Like

  Returns number

equals

• equals(v): boolean

• Checks for strict equality of this vector and v.

  Parameters

  • v: Vector4Like

  Returns boolean

floor

• floor(): this

• Returns this

fromArray

• fromArray(array, offset?): this

• Sets this vector's x, y, z and w value from the provided array or array-like.

  Parameters

  • array: number[] | ArrayLike<number>

    the source array or array-like.
  • Optional offset: number

    (optional) offset into the array. Default is 0.

  Returns this

fromBufferAttribute

• fromBufferAttribute(attribute, index): this

• Parameters

  • attribute: BufferAttribute
  • index: number

  Returns this

getComponent

• getComponent(index): number

• Parameters

  • index: number

  Returns number

length

• length(): number

• Computes length of this vector.

  Returns number

lengthSq

• lengthSq(): number

• Computes squared length of this vector.

  Returns number

lerp

• lerp(v, alpha): this

• Linearly interpolate between this vector and v with alpha factor.

  Parameters

  • v: Vector4Like
  • alpha: number

  Returns this

lerpVectors

• lerpVectors(v1, v2, alpha): this

• Parameters

  • v1: Vector4Like
  • v2: Vector4Like
  • alpha: number

  Returns this

manhattanLength

• manhattanLength(): number

• Computes the Manhattan length of this vector.

  see Taxicab Geometry

  Returns number

max

• max(v): this

• Parameters

  • v: Vector4Like

  Returns this

min

• min(v): this

• Parameters

  • v: Vector4Like

  Returns this

multiply

• multiply(v): this

• Parameters

  • v: Vector4Like

  Returns this

multiplyScalar

• multiplyScalar(s): this

• Multiplies this vector by scalar s.

  Parameters

  • s: number

  Returns this

negate

• negate(): this

• Inverts this vector.

  Returns this

normalize

• normalize(): this

• Normalizes this vector.

  Returns this

random

• random(): this

• Sets this vector's x, y, z and w from Math.random

  Returns this

round

• round(): this

• Returns this

roundToZero

• roundToZero(): this

• Returns this

set

• set(x, y, z, w): this

• Sets value of this vector.

  Parameters

  • x: number
  • y: number
  • z: number
  • w: number

  Returns this

setAxisAngleFromQuaternion

• setAxisAngleFromQuaternion(q): this

• http://www.euclideanspace.com/maths/geometry/rotations/conversions/quaternionToAngle/index.htm

  Parameters

  • q: QuaternionLike

    is assumed to be normalized

  Returns this

setAxisAngleFromRotationMatrix

• setAxisAngleFromRotationMatrix(m): this

• http://www.euclideanspace.com/maths/geometry/rotations/conversions/matrixToAngle/index.htm

  Parameters

  • m: Matrix4

    assumes the upper 3x3 of m is a pure rotation matrix (i.e, unscaled)

  Returns this

setComponent

• setComponent(index, value): this

• Parameters

  • index: number
  • value: number

  Returns this

setLength

• setLength(length): this

• Normalizes this vector and multiplies it by l.

  Parameters

  • length: number

  Returns this

setScalar

• setScalar(scalar): this

• Sets all values of this vector.

  Parameters

  • scalar: number

  Returns this

setW

• setW(w): this

• Sets w component of this vector.

  Parameters

  • w: number

  Returns this

setX

• setX(x): this

• Sets X component of this vector.

  Parameters

  • x: number

  Returns this

setY

• setY(y): this

• Sets Y component of this vector.

  Parameters

  • y: number

  Returns this

setZ

• setZ(z): this

• Sets Z component of this vector.

  Parameters

  • z: number

  Returns this

sub

• sub(v): this

• Subtracts v from this vector.

  Parameters

  • v: Vector4Like

  Returns this

subScalar

• subScalar(s): this

• Parameters

  • s: number

  Returns this

subVectors

• subVectors(a, b): this

• Sets this vector to a - b.

  Parameters

  • a: Vector4Like
  • b: Vector4Like

  Returns this

toArray

• toArray(array?, offset?): number[]

• Returns an array [x, y, z, w], or copies x, y, z and w into the provided array.

  Parameters

  • Optional array: number[]

    (optional) array to store the vector to. If this is not provided, a new array will be created.
  • Optional offset: number

    (optional) optional offset into the array.

  Returns number[]

  The created or provided array.
• toArray(array?, offset?): Vector4Tuple

• Parameters

  • Optional array: Vector4Tuple
  • Optional offset: 0

  Returns Vector4Tuple

• toArray(array, offset?): ArrayLike<number>

• Copies x, y, z and w into the provided array-like.

  Parameters

  • array: ArrayLike<number>

    array-like to store the vector to.
  • Optional offset: number

    (optional) optional offset into the array-like.

  Returns ArrayLike<number>

  The provided array-like.