Interface Vector

( interface Vector )

Abstract interface of https://github.com/mrdoob/three.js/blob/master/src/math/Vector2.js|Vector2, https://github.com/mrdoob/three.js/blob/master/src/math/Vector3.js|Vector3 and https://github.com/mrdoob/three.js/blob/master/src/math/Vector4.js|Vector4.

Currently the members of Vector is NOT type safe because it accepts different typed vectors.

Those definitions will be changed when TypeScript innovates Generics to be type safe.

Example

const v:THREE.Vector = new THREE.Vector3();
v.addVectors(new THREE.Vector2(0, 1), new THREE.Vector2(2, 3)); // invalid but compiled successfully

Hierarchy

Vector

Implemented by

Methods

add

add(v: Vector): Vector
NOTE: The second argument is deprecated.

add(v:T):T;
Parameters
- v: Vector
Returns Vector
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:40

addScalar

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

addScaledVector

addScaledVector(vector: Vector, scale: number): Vector
Parameters
- vector: Vector
- scale: number
Returns Vector
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:47

addVectors

addVectors(a: Vector, b: Vector): Vector
addVectors(a:T, b:T):T;
Parameters
- a: Vector
- b: Vector
Returns Vector
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:45

clone

clone(): Vector
clone():T;

Returns Vector
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:131

copy

copy(v: Vector): Vector
copy(v:T):T;
Parameters
- v: Vector
Returns Vector
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:33

`Optional` distanceTo

distanceTo(v: Vector): number
NOTE: Vector4 doesn't have the property.

distanceTo(v:T):number;
Parameters
- v: Vector
Returns number
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:104

`Optional` distanceToSquared

distanceToSquared(v: Vector): number
NOTE: Vector4 doesn't have the property.

distanceToSquared(v:T):number;
Parameters
- v: Vector
Returns number
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:111

divideScalar

divideScalar(s: number): Vector
divideScalar(s:number):T;
Parameters
- s: number
Returns Vector
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:72

dot

dot(v: Vector): number
dot(v:T):T;
Parameters
- v: Vector
Returns number
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:82

equals

equals(v: Vector): boolean
equals(v:T):boolean;
Parameters
- v: Vector
Returns boolean
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:126

getComponent

getComponent(index: number): number
Parameters
- index: number
Returns number
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:24

length

length(): number
length():number;

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

lengthSq

lengthSq(): number
lengthSq():number;

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

lerp

lerp(v: Vector, alpha: number): Vector
lerp(v:T, alpha:number):T;
Parameters
- v: Vector
- alpha: number
Returns Vector
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:121

multiplyScalar

multiplyScalar(s: number): Vector
multiplyScalar(s:number):T;
Parameters
- s: number
Returns Vector
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:67

negate

negate(): Vector
negate():T;

Returns Vector
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:77

normalize

normalize(): Vector
normalize():T;

Returns Vector
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:97

set

set(...args: number[]): Vector
Parameters
- Rest ...args: number[]
Returns Vector
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:26

setComponent

setComponent(index: number, value: number): Vector
Parameters
- index: number
- value: number
Returns Vector
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:22

setLength

setLength(l: number): Vector
setLength(l:number):T;
Parameters
- l: number
Returns Vector
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:116

setScalar

setScalar(scalar: number): Vector
Parameters
- scalar: number
Returns Vector
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:28

sub

sub(v: Vector): Vector
sub(v:T):T;
Parameters
- v: Vector
Returns Vector
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:57

subVectors

subVectors(a: Vector, b: Vector): Vector
subVectors(a:T, b:T):T;
Parameters
- a: Vector
- b: Vector
Returns Vector
- Defined in node_modules/@types/three/src/math/Vector2.d.ts:62

Interface Vector

Example

Hierarchy

Implemented by

Index

Methods

Methods

add

Parameters

v: Vector

Returns Vector

addScalar

Parameters

scalar: number

Returns Vector

addScaledVector

Parameters

vector: Vector

scale: number

Returns Vector

addVectors

Parameters

a: Vector

b: Vector

Returns Vector

clone

Returns Vector

copy

Parameters

v: Vector

Returns Vector

Optional distanceTo

Parameters

v: Vector

Returns number

Optional distanceToSquared

Parameters

v: Vector

Returns number

divideScalar

Parameters

s: number

Returns Vector

dot

Parameters

v: Vector

Returns number

equals

Parameters

v: Vector

Returns boolean

getComponent

Parameters

index: number

Returns number

length

Returns number

lengthSq

Returns number

lerp

Parameters

v: Vector

alpha: number

Returns Vector

multiplyScalar

Parameters

s: number

Returns Vector

negate

Returns Vector

normalize

Returns Vector

set

Parameters

Rest ...args: number[]

Returns Vector

setComponent

Parameters

index: number

value: number

`Optional` distanceTo

`Optional` distanceToSquared

`Rest` ...args: number[]