Class Vector4

constructor

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

  Parameters

  • Optionalx: number
  • Optionaly: number
  • Optionalz: number
  • Optionalw: number

  Returns Vector4

height

ReadonlyisVector4

w

0
Copy

width

x

0
Copy

y

0
Copy

z

0
Copy

[iterator]

• "[iterator]"(): Iterator<number>

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

  Returns Iterator<number>

add

• add(v: Vector4Like): this

  Adds v to this vector.

  Parameters

  • v: Vector4Like

  Returns this

addScalar

• addScalar(scalar: number): this

  Parameters

  • scalar: number

  Returns this

addScaledVector

• addScaledVector(v: Vector4Like, s: number): this

  Parameters

  • v: Vector4Like
  • s: number

  Returns this

addVectors

• addVectors(a: Vector4Like, b: Vector4Like): this

  Sets this vector to a + b.

  Parameters

  • a: Vector4Like
  • b: Vector4Like

  Returns this

applyMatrix4

• applyMatrix4(m: Matrix4): this

  Parameters

  • m: Matrix4

  Returns this

ceil

• ceil(): this

  Returns this

clamp

• clamp(min: Vector4Like, max: Vector4Like): this

  Parameters

  • min: Vector4Like
  • max: Vector4Like

  Returns this

clampScalar

• clampScalar(min: number, max: number): this

  Parameters

  • min: number
  • max: number

  Returns this

clone

• clone(): this

  Clones this vector.

  Returns this

copy

• copy(v: Vector4Like): this

  Copies value of v to this vector.

  Parameters

  • v: Vector4Like

  Returns this

divide

• divide(v: Vector4Like): this

  Parameters

  • v: Vector4Like

  Returns this

divideScalar

• divideScalar(s: number): this

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

  Parameters

  • s: number

  Returns this

dot

• dot(v: Vector4Like): number

  Computes dot product of this vector and v.

  Parameters

  • v: Vector4Like

  Returns number

equals

• equals(v: Vector4Like): boolean

  Checks for strict equality of this vector and v.

  Parameters

  • v: Vector4Like

  Returns boolean

floor

• floor(): this

  Returns this

fromArray

• fromArray(array: number[] | ArrayLike<number>, offset?: number): 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.

  • Optionaloffset: number

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

  Returns this

fromBufferAttribute

• fromBufferAttribute(attribute: BufferAttribute, index: number): this

  Parameters

  • attribute: BufferAttribute
  • index: number

  Returns this

getComponent

• getComponent(index: number): 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: Vector4Like, alpha: number): this

  Linearly interpolate between this vector and v with alpha factor.

  Parameters

  • v: Vector4Like
  • alpha: number

  Returns this

lerpVectors

• lerpVectors(v1: Vector4Like, v2: Vector4Like, alpha: number): 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: Vector4Like): this

  Parameters

  • v: Vector4Like

  Returns this

min

• min(v: Vector4Like): this

  Parameters

  • v: Vector4Like

  Returns this

multiply

• multiply(v: Vector4Like): this

  Parameters

  • v: Vector4Like

  Returns this

multiplyScalar

• multiplyScalar(s: number): 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: number, y: number, z: number, w: number): this

  Sets value of this vector.

  Parameters

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

  Returns this

setAxisAngleFromQuaternion

• setAxisAngleFromQuaternion(q: QuaternionLike): 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: Matrix4): 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: number, value: number): this

  Parameters

  • index: number
  • value: number

  Returns this

setFromMatrixPosition

• setFromMatrixPosition(m: Matrix4): this

  Sets this vector to the position elements of the [transformation matrix]https://en.wikipedia.org/wiki/Transformation_matrix m.

  Parameters

  • m: Matrix4

  Returns this

setLength

• setLength(length: number): this

  Normalizes this vector and multiplies it by l.

  Parameters

  • length: number

  Returns this

setScalar

• setScalar(scalar: number): this

  Sets all values of this vector.

  Parameters

  • scalar: number

  Returns this

setW

• setW(w: number): this

  Sets w component of this vector.

  Parameters

  • w: number

  Returns this

setX

• setX(x: number): this

  Sets X component of this vector.

  Parameters

  • x: number

  Returns this

setY

• setY(y: number): this

  Sets Y component of this vector.

  Parameters

  • y: number

  Returns this

setZ

• setZ(z: number): this

  Sets Z component of this vector.

  Parameters

  • z: number

  Returns this

sub

• sub(v: Vector4Like): this

  Subtracts v from this vector.

  Parameters

  • v: Vector4Like

  Returns this

subScalar

• subScalar(s: number): this

  Parameters

  • s: number

  Returns this

subVectors

• subVectors(a: Vector4Like, b: Vector4Like): this

  Sets this vector to a - b.

  Parameters

  • a: Vector4Like
  • b: Vector4Like

  Returns this

toArray

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

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

  Parameters

  • Optionalarray: number[]

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

  • Optionaloffset: number

    (optional) optional offset into the array.

  Returns number[]

  The created or provided array.

• toArray(array?: Vector4Tuple, offset?: 0): Vector4Tuple

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

  Parameters

  • Optionalarray: Vector4Tuple

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

  • Optionaloffset: 0

    (optional) optional offset into the array.

  Returns Vector4Tuple

  The created or provided array.

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

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

  Parameters

  • array: ArrayLike<number>

    array-like to store the vector to.

  • Optionaloffset: number

    (optional) optional offset into the array-like.

  Returns ArrayLike<number>

  The provided array-like.