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 );

Hierarchy

Vector3

Implements

Vector

Index

Constructors

constructor

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

Properties

`Readonly` isVector3

isVector3: true

x

x: number

Default

y

y: number

Default

z

z: number

Default

Methods

add

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

addScalar

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

addScaledVector

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

addVectors

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

angleTo

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

applyAxisAngle

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

applyEuler

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

applyMatrix3

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

applyMatrix4

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

applyNormalMatrix

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

applyQuaternion

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

ceil

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

clamp

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

clampLength

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

clampScalar

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

clone

clone(): THREE.Vector3
Clones this vector.

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

copy

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

cross

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

crossVectors

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

distanceTo

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

distanceToManhattan

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

distanceToSquared

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

divide

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

divideScalar

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

dot

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

equals

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

floor

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

fromArray

fromArray(array: number[] | ArrayLike<number>, offset?: number): THREE.Vector3
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 THREE.Vector3
- Defined in node_modules/@types/three/src/math/Vector3.d.ts:270

fromBufferAttribute

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

getComponent

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

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

lengthManhattan

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

Deprecated
Use .manhattanLength() instead.

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

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

lerp

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

lerpVectors

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

manhattanDistanceTo

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

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

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

max

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

min

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

multiply

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

multiplyScalar

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

multiplyVectors

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

negate

negate(): THREE.Vector3
Inverts this vector.

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

normalize

normalize(): THREE.Vector3
Normalizes this vector.

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

project

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

projectOnPlane

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

projectOnVector

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

random

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

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

randomDirection

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

reflect

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

round

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

roundToZero

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

set

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

setComponent

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

setFromCylindrical

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

setFromCylindricalCoords

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

setFromEuler

setFromEuler(e: Euler): THREE.Vector3
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 THREE.Vector3
- Defined in node_modules/@types/three/src/math/Vector3.d.ts:258

setFromMatrix3Column

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

setFromMatrixColumn

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

setFromMatrixPosition

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

setFromMatrixScale

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

setFromSpherical

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

setFromSphericalCoords

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

setLength

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

setScalar

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

setX

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

setY

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

setZ

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

sub

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

subScalar

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

subVectors

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

toArray

toArray(array?: number[], offset?: number): number[]
Returns an array [x, y, z], or copies x, y and z into the provided array.

Returns
The created or 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[]
- Defined in node_modules/@types/three/src/math/Vector3.d.ts:278
toArray(array?: Vector3Tuple, offset?: 0): Vector3Tuple
Parameters
- Optional array: Vector3Tuple
- Optional offset: 0
Returns Vector3Tuple
- Defined in node_modules/@types/three/src/math/Vector3.d.ts:279
toArray(array: ArrayLike<number>, offset?: number): ArrayLike<number>
Copies x, y and z into the provided array-like.

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

transformDirection

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

unproject

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

Class Vector3

Example

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional x: number

Optional y: number

Optional z: number

Returns THREE.Vector3

Properties

Readonly isVector3

x

Default

y

Default

z

Default

Methods

add

Parameters

v: THREE.Vector3

Returns THREE.Vector3

addScalar

Parameters

s: number

Returns THREE.Vector3

addScaledVector

Parameters

v: THREE.Vector3

s: number

Returns THREE.Vector3

addVectors

Parameters

a: THREE.Vector3

b: THREE.Vector3

Returns THREE.Vector3

angleTo

Parameters

v: THREE.Vector3

Returns number

applyAxisAngle

Parameters

axis: THREE.Vector3

angle: number

Returns THREE.Vector3

applyEuler

Parameters

euler: Euler

Returns THREE.Vector3

applyMatrix3

Parameters

m: Matrix3

Returns THREE.Vector3

applyMatrix4

Parameters

m: Matrix4

Returns THREE.Vector3

applyNormalMatrix

Parameters

m: Matrix3

Returns THREE.Vector3

applyQuaternion

Parameters

q: Quaternion

Returns THREE.Vector3

ceil

Returns THREE.Vector3

clamp

Parameters

min: THREE.Vector3

max: THREE.Vector3

Returns THREE.Vector3

clampLength

Parameters

`Optional` x: number

`Optional` y: number

`Optional` z: number

`Readonly` isVector3

`Optional` offset: number