Class Vector3

3D vector.

see https://github.com/mrdoob/three.js/blob/master/src/math/Vector3.js

Example

const a = new THREE.Vector3( 1, 0, 0 );
const b = new THREE.Vector3( 0, 1, 0 );
const c = new THREE.Vector3();
c.crossVectors( a, b );

Constructors

constructor

Properties

x y z isVector3

Methods

set setScalar setX setY setZ setComponent getComponent clone copy add addScalar addVectors addScaledVector sub subScalar subVectors multiply multiplyScalar multiplyVectors applyEuler applyAxisAngle applyMatrix3 applyNormalMatrix applyMatrix4 applyQuaternion project unproject transformDirection divide divideScalar min max clamp clampScalar clampLength floor ceil round roundToZero negate dot lengthSq length manhattanLength normalize setLength lerp lerpVectors cross crossVectors projectOnVector projectOnPlane reflect angleTo distanceTo distanceToSquared manhattanDistanceTo setFromSpherical setFromSphericalCoords setFromCylindrical setFromCylindricalCoords setFromMatrixPosition setFromMatrixScale setFromMatrixColumn setFromMatrix3Column setFromEuler setFromColor equals fromArray toArray fromBufferAttribute random randomDirection [iterator]

Constructors

constructor

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

  • Parameters

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

    Returns Vector3

Properties

x

x: number

Default

0

y

y: number

Default

0

z

z: number

Default

0

ReadonlyisVector3

isVector3: true

Methods

set

  • set(x, y, z): this

  • Sets value of this vector.

    Parameters

    • x: number
    • y: number
    • z: 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

setComponent

  • setComponent(index, value): this

  • Parameters

    • index: number
    • value: number

    Returns this

getComponent

  • getComponent(index): number

  • Parameters

    • index: number

    Returns number

clone

  • clone(): this

  • Clones this vector.

    Returns this

copy

  • copy(v): this

  • Copies value of v to this vector.

    Parameters

    Returns this

add

  • add(v): this

  • Adds v to this vector.

    Parameters

    Returns this

addScalar

  • addScalar(s): this

  • Parameters

    • s: number

    Returns this

addVectors

  • addVectors(a, b): this

  • Sets this vector to a + b.

    Parameters

    Returns this

addScaledVector

  • addScaledVector(v, s): this

  • Parameters

    Returns this

sub

  • sub(a): this

  • Subtracts v from this vector.

    Parameters

    Returns this

subScalar

  • subScalar(s): this

  • Parameters

    • s: number

    Returns this

subVectors

  • subVectors(a, b): this

  • Sets this vector to a - b.

    Parameters

    Returns this

multiply

  • multiply(v): this

  • Parameters

    Returns this

multiplyScalar

  • multiplyScalar(s): this

  • Multiplies this vector by scalar s.

    Parameters

    • s: number

    Returns this

multiplyVectors

  • multiplyVectors(a, b): this

  • Parameters

    Returns this

applyEuler

  • applyEuler(euler): this

  • Parameters

    Returns this

applyAxisAngle

  • applyAxisAngle(axis, angle): this

  • Parameters

    Returns this

applyMatrix3

  • applyMatrix3(m): this

  • Parameters

    Returns this

applyNormalMatrix

  • applyNormalMatrix(m): this

  • Parameters

    Returns this

applyMatrix4

  • applyMatrix4(m): this

  • Parameters

    Returns this

applyQuaternion

  • applyQuaternion(q): this

  • Parameters

    Returns this

project

  • project(camera): this

  • Parameters

    Returns this

unproject

  • unproject(camera): this

  • Parameters

    Returns this

transformDirection

  • transformDirection(m): this

  • Parameters

    Returns this

divide

  • divide(v): this

  • Parameters

    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

min

  • min(v): this

  • Parameters

    Returns this

max

  • max(v): this

  • Parameters

    Returns this

clamp

  • clamp(min, max): this

  • Parameters

    Returns this

clampScalar

  • clampScalar(min, max): this

  • Parameters

    • min: number
    • max: number

    Returns this

clampLength

  • clampLength(min, max): this

  • Parameters

    • min: number
    • max: number

    Returns this

floor

  • floor(): this

  • Returns this

ceil

  • ceil(): this

  • Returns this

round

  • round(): this

  • Returns this

roundToZero

  • roundToZero(): this

  • Returns this

negate

  • negate(): this

  • Inverts this vector.

    Returns this

dot

  • dot(v): number

  • Computes dot product of this vector and v.

    Parameters

    Returns number

lengthSq

  • lengthSq(): number

  • Computes squared length of this vector.

    Returns number

length

  • length(): number

  • Computes length of this vector.

    Returns number

manhattanLength

  • manhattanLength(): number

  • Computes the Manhattan length of this vector.

    see Taxicab Geometry

    Returns number

normalize

  • normalize(): this

  • Normalizes this vector.

    Returns this

setLength

  • setLength(l): this

  • Normalizes this vector and multiplies it by l.

    Parameters

    • l: number

    Returns this

lerp

  • lerp(v, alpha): this

  • Parameters

    Returns this

lerpVectors

  • lerpVectors(v1, v2, alpha): this

  • Parameters

    Returns this

cross

  • cross(a): this

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

    Parameters

    Returns this

crossVectors

  • crossVectors(a, b): this

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

    Parameters

    Returns this

projectOnVector

  • projectOnVector(v): this

  • Parameters

    Returns this

projectOnPlane

  • projectOnPlane(planeNormal): this

  • Parameters

    Returns this

reflect

  • reflect(vector): this

  • Parameters

    Returns this

angleTo

  • angleTo(v): number

  • Parameters

    Returns number

distanceTo

  • distanceTo(v): number

  • Computes distance of this vector to v.

    Parameters

    Returns number

distanceToSquared

  • distanceToSquared(v): number

  • Computes squared distance of this vector to v.

    Parameters

    Returns number

manhattanDistanceTo

  • manhattanDistanceTo(v): number

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

    see Taxicab Geometry

    Parameters

    Returns number

setFromSpherical

  • setFromSpherical(s): this

  • Parameters

    Returns this

setFromSphericalCoords

  • setFromSphericalCoords(r, phi, theta): this

  • Parameters

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

    Returns this

setFromCylindrical

  • setFromCylindrical(s): this

  • Parameters

    Returns this

setFromCylindricalCoords

  • setFromCylindricalCoords(radius, theta, y): this

  • Parameters

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

    Returns this

setFromMatrixPosition

  • setFromMatrixPosition(m): this

  • Parameters

    Returns this

setFromMatrixScale

  • setFromMatrixScale(m): this

  • Parameters

    Returns this

setFromMatrixColumn

  • setFromMatrixColumn(matrix, index): this

  • Parameters

    Returns this

setFromMatrix3Column

  • setFromMatrix3Column(matrix, index): this

  • Parameters

    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

    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.

    Parameters

    Returns this

equals

  • equals(v): boolean

  • Checks for strict equality of this vector and v.

    Parameters

    Returns boolean

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.

    • Optionaloffset: number

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

    Returns this

toArray

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

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

  • Parameters

    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.

    • Optionaloffset: number

      (optional) optional offset into the array-like.

    Returns ArrayLike<number>

    The provided array-like.

fromBufferAttribute

random

  • random(): this

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

    Returns this

randomDirection

  • randomDirection(): this

  • Returns this

[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>

Settings

Member Visibility

On This Page

constructorxyzisVector3setsetScalarsetXsetYsetZsetComponentgetComponentclonecopyaddaddScalaraddVectorsaddScaledVectorsubsubScalarsubVectorsmultiplymultiplyScalarmultiplyVectorsapplyEulerapplyAxisAngleapplyMatrix3applyNormalMatrixapplyMatrix4applyQuaternionprojectunprojecttransformDirectiondividedivideScalarminmaxclampclampScalarclampLengthfloorceilroundroundToZeronegatedotlengthSqlengthmanhattanLengthnormalizesetLengthlerplerpVectorscrosscrossVectorsprojectOnVectorprojectOnPlanereflectangleTodistanceTodistanceToSquaredmanhattanDistanceTosetFromSphericalsetFromSphericalCoordssetFromCylindricalsetFromCylindricalCoordssetFromMatrixPositionsetFromMatrixScalesetFromMatrixColumnsetFromMatrix3ColumnsetFromEulersetFromColorequalsfromArraytoArrayfromBufferAttributerandomrandomDirection[iterator]