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

Index

Constructors

constructor

new Vector3(x?: number, y?: number, z?: number): Vector3
Parameters
- Optionalx: number
- Optionaly: number
- Optionalz: number
Returns Vector3
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:32

Properties

`Readonly`isVector3

isVector3: true

x

x: number

Default

y

y: number

Default

z

z: number

Default

Methods

[iterator]

"[iterator]"(): Iterator<number>
Iterating through a Vector3 instance will yield its components (x, y, z) in the corresponding order.

Returns Iterator<number>
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:300

add

add(v: Vector3Like): this
Adds v to this vector.
Parameters
- v: Vector3Like
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:92

addScalar

addScalar(s: number): this
Parameters
- s: number
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:94

addScaledVector

addScaledVector(v: Vector3, s: number): this
Parameters
- v: Vector3
- s: number
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:101

addVectors

addVectors(a: Vector3Like, b: Vector3Like): this
Sets this vector to a + b.
Parameters
- a: Vector3Like
- b: Vector3Like
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:99

angleTo

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

applyAxisAngle

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

applyEuler

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

applyMatrix3

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

applyMatrix4

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

applyNormalMatrix

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

applyQuaternion

applyQuaternion(q: QuaternionLike): this
Parameters
- q: QuaternionLike
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:134

ceil

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

clamp

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

clampLength

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

clampScalar

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

clone

clone(): this
Clones this vector.

Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:82

copy

copy(v: Vector3Like): this
Copies value of v to this vector.
Parameters
- v: Vector3Like
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:87

cross

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

crossVectors

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

distanceTo

distanceTo(v: Vector3Like): number
Computes distance of this vector to v.
Parameters
- v: Vector3Like
Returns number
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:225

distanceToSquared

distanceToSquared(v: Vector3Like): number
Computes squared distance of this vector to v.
Parameters
- v: Vector3Like
Returns number
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:230

divide

divide(v: Vector3Like): this
Parameters
- v: Vector3Like
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:142

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

dot

dot(v: Vector3Like): number
Computes dot product of this vector and v.
Parameters
- v: Vector3Like
Returns number
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:176

equals

equals(v: Vector3Like): boolean
Checks for strict equality of this vector and v.
Parameters
- v: Vector3Like
Returns boolean
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:262

floor

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

fromArray

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

fromBufferAttribute

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

getComponent

getComponent(index: number): number
Parameters
- index: number
Returns number
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:77

length

length(): number
Computes length of this vector.

Returns number
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:186

lengthSq

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

Returns number
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:181

lerp

lerp(v: Vector3Like, alpha: number): this
Parameters
- v: Vector3Like
- alpha: number
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:204

lerpVectors

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

manhattanDistanceTo

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

see Taxicab Geometry
Parameters
- v: Vector3Like
Returns number
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:237

manhattanLength

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

see Taxicab Geometry

Returns number
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:193

max

max(v: Vector3Like): this
Parameters
- v: Vector3Like
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:152

min

min(v: Vector3Like): this
Parameters
- v: Vector3Like
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:150

multiply

multiply(v: Vector3Like): this
Parameters
- v: Vector3Like
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:115

multiplyScalar

multiplyScalar(s: number): this
Multiplies this vector by scalar s.
Parameters
- s: number
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:120

multiplyVectors

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

negate

negate(): this
Inverts this vector.

Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:171

normalize

normalize(): this
Normalizes this vector.

Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:198

project

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

projectOnPlane

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

projectOnVector

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

random

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

Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:293

randomDirection

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

reflect

reflect(vector: Vector3Like): this
Parameters
- vector: Vector3Like
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:219

round

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

roundToZero

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

set

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

setComponent

setComponent(index: number, value: number): this
Parameters
- index: number
- value: number
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:75

setFromColor

setFromColor(color: RGB): this
Sets this vector's x, y and z components from the r, g, and b components of the specified color.
Parameters
- color: RGB
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:257

setFromCylindrical

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

setFromCylindricalCoords

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

setFromEuler

setFromEuler(e: Euler): 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/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:251

setFromMatrix3Column

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

setFromMatrixColumn

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

setFromMatrixPosition

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

setFromMatrixScale

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

setFromSpherical

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

setFromSphericalCoords

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

setLength

setLength(l: number): this
Normalizes this vector and multiplies it by l.
Parameters
- l: number
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:203

setScalar

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

setX

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

setY

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

setZ

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

sub

sub(v: Vector3Like): this
Subtracts v from this vector.
Parameters
- v: Vector3Like
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:106

subScalar

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

subVectors

subVectors(a: Vector3Like, b: Vector3Like): this
Sets this vector to a - b.
Parameters
- a: Vector3Like
- b: Vector3Like
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Vector3.d.ts:113

toArray

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

transformDirection

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

unproject

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

Class Vector3

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Vector3

Properties

ReadonlyisVector3

x

Default

y

Default

z

Default

Methods

[iterator]

Returns Iterator<number>

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

distanceToSquared

`Readonly`isVector3