Class Vector3

3D vector.

example

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

see

src/math/Vector3.js

( class Vector3 implements Vector )

Hierarchy

Vector3

Implements

Vector

Index

Constructors

constructor

Properties

x
y
z

Constructors

constructor

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

- Defined in RuntimeFull.ts:1024
Parameters
- Optional x: number
- Optional y: number
- Optional z: number
Returns Vector3

Properties

x

x: number

y

y: number

z

z: number

Methods

add

add(a: Vector3): Vector3

- Defined in RuntimeFull.ts:1070
Adds v to this vector.

Parameters
- a: Vector3
Returns Vector3

addScalar

addScalar(s: number): Vector3

- Defined in RuntimeFull.ts:1071
Parameters
- s: number
Returns Vector3

addScaledVector

addScaledVector(v: Vector3, s: number): Vector3

- Defined in RuntimeFull.ts:1072
Parameters
- v: Vector3
- s: number
Returns Vector3

addVectors

addVectors(a: Vector3, b: Vector3): Vector3

- Defined in RuntimeFull.ts:1077
Sets this vector to a + b.

Parameters
- a: Vector3
- b: Vector3
Returns Vector3

angleTo

angleTo(v: Vector3): number

- Defined in RuntimeFull.ts:1193
Parameters
- v: Vector3
Returns number

applyAxisAngle

applyAxisAngle(axis: Vector3, angle: number): Vector3

- Defined in RuntimeFull.ts:1098
Parameters
- axis: Vector3
- angle: number
Returns Vector3

applyEuler

applyEuler(euler: Euler): Vector3

- Defined in RuntimeFull.ts:1097
Parameters
- euler: Euler
Returns Vector3

applyMatrix3

applyMatrix3(m: Matrix3): Vector3

- Defined in RuntimeFull.ts:1099
Parameters
- m: Matrix3
Returns Vector3

applyMatrix4

applyMatrix4(m: Matrix4): Vector3

- Defined in RuntimeFull.ts:1100
Parameters
- m: Matrix4
Returns Vector3

applyQuaternion

applyQuaternion(q: Quaternion): Vector3

- Defined in RuntimeFull.ts:1101
Parameters
- q: Quaternion
Returns Vector3

ceil

ceil(): Vector3

- Defined in RuntimeFull.ts:1116
Returns Vector3

clamp

clamp(min: Vector3, max: Vector3): Vector3

- Defined in RuntimeFull.ts:1112
Parameters
- min: Vector3
- max: Vector3
Returns Vector3

clampLength

clampLength(min: number, max: number): Vector3

- Defined in RuntimeFull.ts:1114
Parameters
- min: number
- max: number
Returns Vector3

clampScalar

clampScalar(min: number, max: number): Vector3

- Defined in RuntimeFull.ts:1113
Parameters
- min: number
- max: number
Returns Vector3

clone

clone(): this

Implementation of Vector.clone
- Defined in RuntimeFull.ts:1061
Clones this vector.

Returns this

copy

copy(v: this): this

Implementation of Vector.copy
- Defined in RuntimeFull.ts:1065
Copies value of v to this vector.

Parameters
- v: this
Returns this

cross

cross(a: Vector3): Vector3

- Defined in RuntimeFull.ts:1184
Sets this vector to cross product of itself and v.

Parameters
- a: Vector3
Returns Vector3

crossVectors

crossVectors(a: Vector3, b: Vector3): Vector3

- Defined in RuntimeFull.ts:1189
Sets this vector to cross product of a and b.

Parameters
- a: Vector3
- b: Vector3
Returns Vector3

distanceTo

distanceTo(v: Vector3): number

- Defined in RuntimeFull.ts:1198
Computes distance of this vector to v.

Parameters
- v: Vector3
Returns number

distanceToManhattan

distanceToManhattan(v: Vector3): number

- Defined in RuntimeFull.ts:1208
deprecated

Use {@link Vector3#manhattanDistanceTo .manhattanDistanceTo()} instead.

Parameters
- v: Vector3
Returns number

distanceToSquared

distanceToSquared(v: Vector3): number

- Defined in RuntimeFull.ts:1203
Computes squared distance of this vector to v.

Parameters
- v: Vector3
Returns number

divide

divide(v: Vector3): Vector3

- Defined in RuntimeFull.ts:1103
Parameters
- v: Vector3
Returns Vector3

divideScalar

divideScalar(s: number): Vector3

Implementation of Vector.divideScalar
- Defined in RuntimeFull.ts:1109
Divides this vector by scalar s. Set vector to ( 0, 0, 0 ) if s == 0.

Parameters
- s: number
Returns Vector3

dot

dot(v: Vector3): number

- Defined in RuntimeFull.ts:1128
Computes dot product of this vector and v.

Parameters
- v: Vector3
Returns number

equals

equals(v: Vector3): boolean

- Defined in RuntimeFull.ts:1217
Checks for strict equality of this vector and v.

Parameters
- v: Vector3
Returns boolean

floor

floor(): Vector3

- Defined in RuntimeFull.ts:1115
Returns Vector3

fromArray

fromArray(xyz: number[], offset?: number): Vector3

- Defined in RuntimeFull.ts:1219
Parameters
- xyz: number[]
- Optional offset: number
Returns Vector3

getColumnFromMatrix

getColumnFromMatrix(index: number, matrix: Matrix4): Vector3

- Defined in RuntimeFull.ts:1235
deprecated

Use {@link Vector3#setFromMatrixColumn .setFromMatrixColumn()} instead.

Parameters
- index: number
- matrix: Matrix4
Returns Vector3

getComponent

getComponent(index: number): number

Implementation of Vector.getComponent
- Defined in RuntimeFull.ts:1057
Parameters
- index: number
Returns number

getPositionFromMatrix

getPositionFromMatrix(m: Matrix4): Vector3

- Defined in RuntimeFull.ts:1225
deprecated

Use {@link Vector3#setFromMatrixPosition .setFromMatrixPosition()} instead.

Parameters
- m: Matrix4
Returns Vector3

getScaleFromMatrix

getScaleFromMatrix(m: Matrix4): Vector3

- Defined in RuntimeFull.ts:1230
deprecated

Use {@link Vector3#setFromMatrixScale .setFromMatrixScale()} instead.

Parameters
- m: Matrix4
Returns Vector3

length

length(): number

Implementation of Vector.length
- Defined in RuntimeFull.ts:1138
Computes length of this vector.

Returns number

lengthManhattan

lengthManhattan(): number

- Defined in RuntimeFull.ts:1146
Computes Manhattan length of this vector. http://en.wikipedia.org/wiki/Taxicab_geometry

deprecated

Use {@link Vector3#manhattanLength .manhattanLength()} instead.

Returns number

lengthSq

lengthSq(): number

Implementation of Vector.lengthSq
- Defined in RuntimeFull.ts:1133
Computes squared length of this vector.

Returns number

lerp

lerp(v: Vector3, alpha: number): Vector3

- Defined in RuntimeFull.ts:1177
Parameters
- v: Vector3
- alpha: number
Returns Vector3

lerpVectors

lerpVectors(v1: Vector3, v2: Vector3, alpha: number): Vector3

- Defined in RuntimeFull.ts:1179
Parameters
- v1: Vector3
- v2: Vector3
- alpha: number
Returns Vector3

manhattanDistanceTo

manhattanDistanceTo(v: Vector3): number

- Defined in RuntimeFull.ts:1166
Computes the Manhattan length (distance) from this vector to the given vector v

see

Wikipedia: Taxicab Geometry

Parameters
- v: Vector3
Returns number

manhattanLength

manhattanLength(): number

- Defined in RuntimeFull.ts:1155
Computes the Manhattan length of this vector.

see

Wikipedia: Taxicab Geometry

Returns number

max

max(v: Vector3): Vector3

- Defined in RuntimeFull.ts:1111
Parameters
- v: Vector3
Returns Vector3

min

min(v: Vector3): Vector3

- Defined in RuntimeFull.ts:1110
Parameters
- v: Vector3
Returns Vector3

multiply

multiply(v: Vector3): Vector3

- Defined in RuntimeFull.ts:1091
Parameters
- v: Vector3
Returns Vector3

multiplyScalar

multiplyScalar(s: number): Vector3

Implementation of Vector.multiplyScalar
- Defined in RuntimeFull.ts:1095
Multiplies this vector by scalar s.

Parameters
- s: number
Returns Vector3

multiplyVectors

multiplyVectors(a: Vector3, b: Vector3): Vector3

- Defined in RuntimeFull.ts:1096
Parameters
- a: Vector3
- b: Vector3
Returns Vector3

negate

negate(): Vector3

Implementation of Vector.negate
- Defined in RuntimeFull.ts:1123
Inverts this vector.

Returns Vector3

normalize

normalize(): Vector3

Implementation of Vector.normalize
- Defined in RuntimeFull.ts:1171
Normalizes this vector.

Returns Vector3

projectOnPlane

projectOnPlane(planeNormal: Vector3): Vector3

- Defined in RuntimeFull.ts:1191
Parameters
- planeNormal: Vector3
Returns Vector3

projectOnVector

projectOnVector(v: Vector3): Vector3

- Defined in RuntimeFull.ts:1190
Parameters
- v: Vector3
Returns Vector3

reflect

reflect(vector: Vector3): Vector3

- Defined in RuntimeFull.ts:1192
Parameters
- vector: Vector3
Returns Vector3

round

round(): Vector3

- Defined in RuntimeFull.ts:1117
Returns Vector3

roundToZero

roundToZero(): Vector3

- Defined in RuntimeFull.ts:1118
Returns Vector3

set

set(x: number, y: number, z: number): Vector3

- Defined in RuntimeFull.ts:1034
Sets value of this vector.

Parameters
- x: number
- y: number
- z: number
Returns Vector3

setComponent

setComponent(index: number, value: number): void

Implementation of Vector.setComponent
- Defined in RuntimeFull.ts:1056
Parameters
- index: number
- value: number
Returns void

setFromMatrixColumn

setFromMatrixColumn(matrix: Matrix4, index: number): Vector3

- Defined in RuntimeFull.ts:1212
Parameters
- matrix: Matrix4
- index: number
Returns Vector3

setFromMatrixPosition

setFromMatrixPosition(m: Matrix4): Vector3

- Defined in RuntimeFull.ts:1210
Parameters
- m: Matrix4
Returns Vector3

setFromMatrixScale

setFromMatrixScale(m: Matrix4): Vector3

- Defined in RuntimeFull.ts:1211
Parameters
- m: Matrix4
Returns Vector3

setLength

setLength(l: number): Vector3

Implementation of Vector.setLength
- Defined in RuntimeFull.ts:1176
Normalizes this vector and multiplies it by l.

Parameters
- l: number
Returns Vector3

setScalar

setScalar(scalar: number): Vector3

- Defined in RuntimeFull.ts:1039
Sets all values of this vector.

Parameters
- scalar: number
Returns Vector3

setX

setX(x: number): Vector3

- Defined in RuntimeFull.ts:1044
Sets x value of this vector.

Parameters
- x: number
Returns Vector3

setY

setY(y: number): Vector3

- Defined in RuntimeFull.ts:1049
Sets y value of this vector.

Parameters
- y: number
Returns Vector3

setZ

setZ(z: number): Vector3

- Defined in RuntimeFull.ts:1054
Sets z value of this vector.

Parameters
- z: number
Returns Vector3

sub

sub(a: Vector3): Vector3

- Defined in RuntimeFull.ts:1082
Subtracts v from this vector.

Parameters
- a: Vector3
Returns Vector3

subScalar

subScalar(s: number): Vector3

- Defined in RuntimeFull.ts:1084
Parameters
- s: number
Returns Vector3

subVectors

subVectors(a: Vector3, b: Vector3): Vector3

- Defined in RuntimeFull.ts:1089
Sets this vector to a - b.

Parameters
- a: Vector3
- b: Vector3
Returns Vector3

toArray

toArray(xyz?: number[], offset?: number): number[]

- Defined in RuntimeFull.ts:1220
Parameters
- Optional xyz: number[]
- Optional offset: number
Returns number[]

transformDirection

transformDirection(m: Matrix4): Vector3

- Defined in RuntimeFull.ts:1102
Parameters
- m: Matrix4
Returns Vector3

Generated using TypeDoc