Class Vector3

constructor

• new Vector3(x?, y?, z?): Vector3

• Parameters

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

  Returns Vector3

Readonly isVector3

[iterator]

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

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

  Returns Iterator<number, any, undefined>

add

• add(v): this

• Adds v to this vector.

  Parameters

  • v: Vector3Like

  Returns this

addScalar

• addScalar(s): this

• Parameters

  • s: number

  Returns this

addScaledVector

• addScaledVector(v, s): this

• Parameters

  • v: Vector3
  • s: number

  Returns this

addVectors

• addVectors(a, b): this

• Sets this vector to a + b.

  Parameters

  • a: Vector3Like
  • b: Vector3Like

  Returns this

angleTo

• angleTo(v): number

• Parameters

  • v: Vector3

  Returns number

applyAxisAngle

• applyAxisAngle(axis, angle): this

• Parameters

  • axis: Vector3
  • angle: number

  Returns this

applyEuler

• applyEuler(euler): this

• Parameters

  • euler: Euler

  Returns this

applyMatrix3

• applyMatrix3(m): this

• Parameters

  • m: Matrix3

  Returns this

applyMatrix4

• applyMatrix4(m): this

• Parameters

  • m: Matrix4

  Returns this

applyNormalMatrix

• applyNormalMatrix(m): this

• Parameters

  • m: Matrix3

  Returns this

applyQuaternion

• applyQuaternion(q): this

• Parameters

  • q: QuaternionLike

  Returns this

ceil

• ceil(): this

• Returns this

clamp

• clamp(min, max): this

• Parameters

  • min: Vector3Like
  • max: Vector3Like

  Returns this

clampLength

• clampLength(min, max): this

• Parameters

  • min: number
  • max: number

  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: Vector3Like

  Returns this

cross

• cross(a): this

• Sets this vector to cross product of itself and v.

  Parameters

  • a: Vector3Like

  Returns this

crossVectors

• crossVectors(a, b): this

• Sets this vector to cross product of a and b.

  Parameters

  • a: Vector3Like
  • b: Vector3Like

  Returns this

distanceTo

• distanceTo(v): number

• Computes distance of this vector to v.

  Parameters

  • v: Vector3Like

  Returns number

distanceToSquared

• distanceToSquared(v): number

• Computes squared distance of this vector to v.

  Parameters

  • v: Vector3Like

  Returns number

divide

• divide(v): this

• Parameters

  • v: Vector3Like

  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: Vector3Like

  Returns number

equals

• equals(v): boolean

• Checks for strict equality of this vector and v.

  Parameters

  • v: Vector3Like

  Returns boolean

floor

• floor(): this

• Returns this

fromArray

• fromArray(array, offset?): this

• Sets this vector's x, y and z 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 | InterleavedBufferAttribute
  • 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

• Parameters

  • v: Vector3Like
  • alpha: number

  Returns this

lerpVectors

• lerpVectors(v1, v2, alpha): this

• Parameters

  • v1: Vector3Like
  • v2: Vector3Like
  • alpha: number

  Returns this

manhattanDistanceTo

• manhattanDistanceTo(v): number

• Computes the Manhattan length (distance) from this vector to the given vector v

  see Taxicab Geometry

  Parameters

  • v: Vector3Like

  Returns number

manhattanLength

• manhattanLength(): number

• Computes the Manhattan length of this vector.

  see Taxicab Geometry

  Returns number

max

• max(v): this

• Parameters

  • v: Vector3Like

  Returns this

min

• min(v): this

• Parameters

  • v: Vector3Like

  Returns this

multiply

• multiply(v): this

• Parameters

  • v: Vector3Like

  Returns this

multiplyScalar

• multiplyScalar(s): this

• Multiplies this vector by scalar s.

  Parameters

  • s: number

  Returns this

multiplyVectors

• multiplyVectors(a, b): this

• Parameters

  • a: Vector3Like
  • b: Vector3Like

  Returns this

negate

• negate(): this

• Inverts this vector.

  Returns this

normalize

• normalize(): this

• Normalizes this vector.

  Returns this

project

• project(camera): this

• Parameters

  • camera: Camera

  Returns this

projectOnPlane

• projectOnPlane(planeNormal): this

• Parameters

  • planeNormal: Vector3

  Returns this

projectOnVector

• projectOnVector(v): this

• Parameters

  • v: Vector3

  Returns this

random

• random(): this

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

  Returns this

randomDirection

• randomDirection(): this

• Returns this

reflect

• reflect(vector): this

• Parameters

  • vector: Vector3Like

  Returns this

round

• round(): this

• Returns this

roundToZero

• roundToZero(): this

• Returns this

set

• set(x, y, z): this

• Sets value of this vector.

  Parameters

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

  Returns this

setComponent

• setComponent(index, value): this

• Parameters

  • index: number
  • value: number

  Returns this

setFromColor

• setFromColor(color): this

• Sets this vector's x, y and z components from the r, g, and b components of the specified Color | color.

  Parameters

  • color: RGB

  Returns this

setFromCylindrical

• setFromCylindrical(s): this

• Parameters

  • s: Cylindrical

  Returns this

setFromCylindricalCoords

• setFromCylindricalCoords(radius, theta, y): this

• Parameters

  • radius: number
  • theta: number
  • y: number

  Returns this

setFromEuler

• setFromEuler(e): this

• Sets this vector's x, y and z components from the x, y, and z components of the specified Euler Angle.

  Parameters

  • e: Euler

  Returns this

setFromMatrix3Column

• setFromMatrix3Column(matrix, index): this

• Parameters

  • matrix: Matrix3
  • index: number

  Returns this

setFromMatrixColumn

• setFromMatrixColumn(matrix, index): this

• Parameters

  • matrix: Matrix4
  • index: number

  Returns this

setFromMatrixPosition

• setFromMatrixPosition(m): this

• Parameters

  • m: Matrix4

  Returns this

setFromMatrixScale

• setFromMatrixScale(m): this

• Parameters

  • m: Matrix4

  Returns this

setFromSpherical

• setFromSpherical(s): this

• Parameters

  • s: Spherical

  Returns this

setFromSphericalCoords

• setFromSphericalCoords(r, phi, theta): this

• Parameters

  • r: number
  • phi: number
  • theta: number

  Returns this

setLength

• setLength(l): this

• Normalizes this vector and multiplies it by l.

  Parameters

  • l: number

  Returns this

setScalar

• setScalar(scalar): this

• Sets all values of this vector.

  Parameters

  • scalar: number

  Returns this

setX

• setX(x): this

• Sets x value of this vector.

  Parameters

  • x: number

  Returns this

setY

• setY(y): this

• Sets y value of this vector.

  Parameters

  • y: number

  Returns this

setZ

• setZ(z): this

• Sets z value of this vector.

  Parameters

  • z: number

  Returns this

sub

• sub(a): this

• Subtracts v from this vector.

  Parameters

  • a: Vector3Like

  Returns this

subScalar

• subScalar(s): this

• Parameters

  • s: number

  Returns this

subVectors

• subVectors(a, b): this

• Sets this vector to a - b.

  Parameters

  • a: Vector3Like
  • b: Vector3Like

  Returns this

toArray

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

• Returns an array [x, y, z], or copies x, y and z 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?): Vector3Tuple

• Parameters

  • Optional array: Vector3Tuple
  • Optional offset: 0

  Returns Vector3Tuple

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

• Copies x, y and z 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.

transformDirection

• transformDirection(m): this

• Parameters

  • m: Matrix4

  Returns this

unproject

• unproject(camera): this

• Parameters

  • camera: Camera

  Returns this