Class Vector3

3D vector. ( class Vector3 implements 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 );

Implements

external.three.Vector

Index

Constructors

constructor

new Vector3(x?, y?, z?): Vector3
Parameters
- Optional x: number
- Optional y: number
- Optional z: number
Returns Vector3
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:27

Properties

`Readonly` isVector3

isVector3: true

x

x: number

Default

y

y: number

Default

z

z: number

Default

Methods

[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>
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:308

add

add(v): this
Adds v to this vector.
Parameters
- v: Vector3
Returns this
Implementation of Vector.add
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:93

addScalar

addScalar(s): this
Adds the scalar value s to this vector's values.
Parameters
- s: number
Returns this
Implementation of Vector.addScalar
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:95

addScaledVector

addScaledVector(v, s): this
Parameters
- v: Vector3
- s: number
Returns this
Implementation of Vector.addScaledVector
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:97

addVectors

addVectors(a, b): this
Sets this vector to a + b.
Parameters
- a: Vector3
- b: Vector3
Returns this
Implementation of Vector.addVectors
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:102

angleTo

angleTo(v): number
Parameters
- v: Vector3
Returns number
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:236

applyAxisAngle

applyAxisAngle(axis, angle): this
Parameters
- axis: Vector3
- angle: number
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:127

applyEuler

applyEuler(euler): this
Parameters
- euler: Euler
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:125

applyMatrix3

applyMatrix3(m): this
Parameters
- m: Matrix3
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:129

applyMatrix4

applyMatrix4(m): this
Parameters
- m: Matrix4
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:133

applyNormalMatrix

applyNormalMatrix(m): this
Parameters
- m: Matrix3
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:131

applyQuaternion

applyQuaternion(q): this
Parameters
- q: Quaternion
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:135

ceil

ceil(): this
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:163

clamp

clamp(min, max): this
Parameters
- min: Vector3
- max: Vector3
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:155

clampLength

clampLength(min, max): this
Parameters
- min: number
- max: number
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:159

clampScalar

clampScalar(min, max): this
Parameters
- min: number
- max: number
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:157

clone

clone(): this
Clones this vector.

Returns this
Implementation of Vector.clone
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:83

copy

copy(v): this
Copies value of v to this vector.
Parameters
- v: Vector3
Returns this
Implementation of Vector.copy
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:88

cross

cross(a): this
Sets this vector to cross product of itself and v.
Parameters
- a: Vector3
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:227

crossVectors

crossVectors(a, b): this
Sets this vector to cross product of a and b.
Parameters
- a: Vector3
- b: Vector3
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:232

distanceTo

distanceTo(v): number
Computes distance of this vector to v.
Parameters
- v: Vector3
Returns number
Implementation of Vector.distanceTo
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:241

distanceToManhattan

distanceToManhattan(v): number
Parameters
- v: Vector3
Returns number
Deprecated
Use .manhattanDistanceTo() instead.
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:251

distanceToSquared

distanceToSquared(v): number
Computes squared distance of this vector to v.
Parameters
- v: Vector3
Returns number
Implementation of Vector.distanceToSquared
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:246

divide

divide(v): this
Parameters
- v: Vector3
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:143

divideScalar

divideScalar(s): this
Divides this vector by scalar s. Set vector to ( 0, 0, 0 ) if s == 0.
Parameters
- s: number
Returns this
Implementation of Vector.divideScalar
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:149

dot

dot(v): number
Computes dot product of this vector and v.
Parameters
- v: Vector3
Returns number
Implementation of Vector.dot
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:177

equals

equals(v): boolean
Checks for strict equality of this vector and v.
Parameters
- v: Vector3
Returns boolean
Implementation of Vector.equals
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:270

floor

floor(): this
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:161

fromArray

fromArray(array, offset?): this
Sets this vector's x, y and z value from the provided array or array-like.
Parameters
- array: ArrayLike<number> | number[]
  the source array or array-like.
- Optional offset: number
  (optional) offset into the array. Default is 0.
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:277

fromBufferAttribute

fromBufferAttribute(attribute, index): this
Parameters
- attribute: BufferAttribute | InterleavedBufferAttribute
- index: number
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:296

getComponent

getComponent(index): number
Parameters
- index: number
Returns number
Implementation of Vector.getComponent
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:78

length

length(): number
Computes length of this vector.

Returns number
Implementation of Vector.length
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:187

lengthManhattan

lengthManhattan(): number
Computes Manhattan length of this vector. http://en.wikipedia.org/wiki/Taxicab_geometry

Returns number
Deprecated
Use .manhattanLength() instead.
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:195

lengthSq

lengthSq(): number
Computes squared length of this vector.

Returns number
Implementation of Vector.lengthSq
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:182

lerp

lerp(v, alpha): this
lerp(v:T, alpha:number):T;
Parameters
- v: Vector3
- alpha: number
Returns this
Implementation of Vector.lerp
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:220

lerpVectors

lerpVectors(v1, v2, alpha): this
Parameters
- v1: Vector3
- v2: Vector3
- alpha: number
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:222

manhattanDistanceTo

manhattanDistanceTo(v): number
Computes the Manhattan length (distance) from this vector to the given vector v

see Taxicab Geometry
Parameters
- v: Vector3
Returns number
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:209

manhattanLength

manhattanLength(): number
Computes the Manhattan length of this vector.

see Taxicab Geometry

Returns number
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:202

max

max(v): this
Parameters
- v: Vector3
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:153

min

min(v): this
Parameters
- v: Vector3
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:151

multiply

multiply(v): this
Parameters
- v: Vector3
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:116

multiplyScalar

multiplyScalar(s): this
Multiplies this vector by scalar s.
Parameters
- s: number
Returns this
Implementation of Vector.multiplyScalar
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:121

multiplyVectors

multiplyVectors(a, b): this
Parameters
- a: Vector3
- b: Vector3
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:123

negate

negate(): this
Inverts this vector.

Returns this
Implementation of Vector.negate
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:172

normalize

normalize(): this
Normalizes this vector.

Returns this
Implementation of Vector.normalize
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:214

project

project(camera): this
Parameters
- camera: Camera
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:137

projectOnPlane

projectOnPlane(planeNormal): this
Parameters
- planeNormal: Vector3
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:234

projectOnVector

projectOnVector(v): this
Parameters
- v: Vector3
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:233

random

random(): this
Sets this vector's x, y and z from Math.random

Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:301

randomDirection

randomDirection(): this
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:303

reflect

reflect(vector): this
Parameters
- vector: Vector3
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:235

round

round(): this
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:165

roundToZero

roundToZero(): this
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:167

set

set(x, y, z): this
Sets value of this vector.
Parameters
- x: number
- y: number
- z: number
Returns this
Implementation of Vector.set
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:48

setComponent

setComponent(index, value): this
Parameters
- index: number
- value: number
Returns this
Implementation of Vector.setComponent
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:70

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
- color: Color
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:76

setFromCylindrical

setFromCylindrical(s): this
Parameters
- s: Cylindrical
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:255

setFromCylindricalCoords

setFromCylindricalCoords(radius, theta, y): this
Parameters
- radius: number
- theta: number
- y: number
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:256

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
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:265

setFromMatrix3Column

setFromMatrix3Column(matrix, index): this
Parameters
- matrix: Matrix3
- index: number
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:260

setFromMatrixColumn

setFromMatrixColumn(matrix, index): this
Parameters
- matrix: Matrix4
- index: number
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:259

setFromMatrixPosition

setFromMatrixPosition(m): this
Parameters
- m: Matrix4
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:257

setFromMatrixScale

setFromMatrixScale(m): this
Parameters
- m: Matrix4
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:258

setFromSpherical

setFromSpherical(s): this
Parameters
- s: Spherical
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:253

setFromSphericalCoords

setFromSphericalCoords(r, phi, theta): this
Parameters
- r: number
- phi: number
- theta: number
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:254

setLength

setLength(l): this
Normalizes this vector and multiplies it by l.
Parameters
- l: number
Returns this
Implementation of Vector.setLength
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:219

setScalar

setScalar(scalar): this
Sets all values of this vector.
Parameters
- scalar: number
Returns this
Implementation of Vector.setScalar
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:53

setX

setX(x): Vector3
Sets x value of this vector.
Parameters
- x: number
Returns Vector3
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:58

setY

setY(y): Vector3
Sets y value of this vector.
Parameters
- y: number
Returns Vector3
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:63

setZ

setZ(z): Vector3
Sets z value of this vector.
Parameters
- z: number
Returns Vector3
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:68

sub

sub(a): this
Subtracts v from this vector.
Parameters
- a: Vector3
Returns this
Implementation of Vector.sub
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:107

subScalar

subScalar(s): this
Parameters
- s: number
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:109

subVectors

subVectors(a, b): this
Sets this vector to a - b.
Parameters
- a: Vector3
- b: Vector3
Returns this
Implementation of Vector.subVectors
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:114

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.
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:285
toArray(array?, offset?): Vector3Tuple
Parameters
- Optional array: Vector3Tuple
- Optional offset: 0
Returns Vector3Tuple
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:286
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.
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:294

transformDirection

transformDirection(m): this
Parameters
- m: Matrix4
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:141

unproject

unproject(camera): this
Parameters
- camera: Camera
Returns this
- Defined in ../node_modules/@types/three/src/math/Vector3.d.ts:139

Class Vector3

Example

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Vector3

Properties

Readonly isVector3

x

Default

y

Default

z

Default

Methods

[iterator]

Returns Iterator<number, any, undefined>

add

Parameters

Returns this

addScalar

Parameters

Returns this

addScaledVector

Parameters

Returns this

addVectors

Parameters

Returns this

angleTo

Parameters

Returns number

applyAxisAngle

Parameters

Returns this

applyEuler

Parameters

Returns this

applyMatrix3

Parameters

Returns this

applyMatrix4

Parameters

Returns this

applyNormalMatrix

Parameters

Returns this

applyQuaternion

Parameters

Returns this

ceil

Returns this

clamp

Parameters

Returns this

clampLength

Parameters

Returns this

clampScalar

Parameters

Returns this

clone

Returns this

copy

Parameters

Returns this

cross

Parameters

Returns this

crossVectors

Parameters

Returns this

distanceTo

Parameters

Returns number

`Readonly` isVector3