Class Vector3

Hierarchy

Vector3

Index

Constructors

constructor

Properties

Accessors

length

Methods

Constructors

constructor

new Vector3(x: number, y: number, z: number): Vector3
new Vector3(arr: [number, number, number]): Vector3
new Vector3(obj: IVector3): Vector3
new Vector3(value: number): Vector3

- Defined in types-shared/index.d.ts:2011
Parameters
- x: number
- y: number
- z: number
Returns Vector3
- Defined in types-shared/index.d.ts:2013
Parameters
- arr: [number, number, number]
Returns Vector3
- Defined in types-shared/index.d.ts:2015
Parameters
- obj: IVector3
Returns Vector3
- Defined in types-shared/index.d.ts:2017
Parameters
- value: number
Returns Vector3

Properties

Readonly x

x: number

Readonly y

y: number

Readonly z

z: number

Static Readonly back

(0, -1, 0) vector

Static Readonly down

(0, 0, -1) vector

Static Readonly forward

forward: Vector3

(0, 1, 0) vector

Static Readonly left

(-1, 0, 0) vector

Static Readonly negativeInfinity

negativeInfinity: Vector3

(-Infinity, -Infinity, -Infinity) vector

Static Readonly one

(1, 1, 1) vector

Static Readonly positiveInfinity

positiveInfinity: Vector3

(Infinity, Infinity, Infinity) vector

Static Readonly right

right: Vector3

(1, 0, 0) vector

Static Readonly up

(0, 0, 1) vector

Static Readonly zero

(0, 0, 0) vector

Accessors

length

get length(): number

- Defined in types-shared/index.d.ts:2021
Returns number

Methods

add

add(x: number, y: number, z: number): Vector3
add(value: number): Vector3
add(array: [number, number, number]): Vector3
add(vector: IVector3): Vector3

- Defined in types-shared/index.d.ts:2035
Adds two vectors.

Parameters
- x: number
- y: number
- z: number
Returns Vector3
- Defined in types-shared/index.d.ts:2040
Adds a number to all vector axis.

Parameters
- value: number
Returns Vector3
- Defined in types-shared/index.d.ts:2045
Adds two vectors.

Parameters
- array: [number, number, number]
Returns Vector3
- Defined in types-shared/index.d.ts:2050
Adds two vectors.

Parameters
- vector: IVector3
Returns Vector3

angleTo

angleTo(vector: IVector3): number

- Defined in types-shared/index.d.ts:2177
Calculates angle between to vectors (in radians).

Parameters
- vector: IVector3
Returns number

angleToDegrees

angleToDegrees(vector: IVector3): number

- Defined in types-shared/index.d.ts:2182
Calculates angle between to vectors (in degrees).

Parameters
- vector: IVector3
Returns number

cross

cross(x: number, y: number, z: number): Vector3
cross(value: number): Vector3
cross(array: [number, number, number]): Vector3
cross(vector: IVector3): Vector3

- Defined in types-shared/index.d.ts:2115
Calculates cross product between two vectors.

Parameters
- x: number
- y: number
- z: number
Returns Vector3
- Defined in types-shared/index.d.ts:2120
Calculates cross product between vector and a number.

Parameters
- value: number
Returns Vector3
- Defined in types-shared/index.d.ts:2125
Calculates cross product between two vectors.

Parameters
- array: [number, number, number]
Returns Vector3
- Defined in types-shared/index.d.ts:2130
Calculates cross product between two vectors.

Parameters
- vector: IVector3
Returns Vector3

distanceTo

distanceTo(vector: IVector3): number

- Defined in types-shared/index.d.ts:2167
Calculates distance between vectors.

Parameters
- vector: IVector3
Returns number

distanceToSquared

distanceToSquared(vector: IVector3): number

- Defined in types-shared/index.d.ts:2172
Calculates squared distance between vectors.

Parameters
- vector: IVector3
Returns number

div

div(x: number, y: number, z: number): Vector3
div(value: number): Vector3
div(array: [number, number, number]): Vector3
div(vector: IVector3): Vector3

- Defined in types-shared/index.d.ts:2075
Divides two vectors.

Parameters
- x: number
- y: number
- z: number
Returns Vector3
- Defined in types-shared/index.d.ts:2080
Divides all vector axis by value.

Parameters
- value: number
Returns Vector3
- Defined in types-shared/index.d.ts:2085
Divides two vectors.

Parameters
- array: [number, number, number]
Returns Vector3
- Defined in types-shared/index.d.ts:2090
Divides two vectors.

Parameters
- vector: IVector3
Returns Vector3

dot

dot(x: number, y: number, z: number): number
dot(value: number): number
dot(array: [number, number, number]): number
dot(vector: IVector3): number

- Defined in types-shared/index.d.ts:2095
Calculates dot product between two vectors.

Parameters
- x: number
- y: number
- z: number
Returns number
- Defined in types-shared/index.d.ts:2100
Calculates dot product between vector and a number.

Parameters
- value: number
Returns number
- Defined in types-shared/index.d.ts:2105
Calculates dot product between two vectors.

Parameters
- array: [number, number, number]
Returns number
- Defined in types-shared/index.d.ts:2110
Calculates dot product between two vectors.

Parameters
- vector: IVector3
Returns number

inverse

inverse(): Vector3

- Defined in types-shared/index.d.ts:2157
Returns Vector3

isInRange

isInRange(vector: IVector3, range: number): boolean

- Defined in types-shared/index.d.ts:2197
Checks if distance between vectors is smaller or equal to range.

Parameters
- vector: IVector3
- range: number
Returns boolean

lerp

lerp(vector: IVector3, ratio: number): Vector3

- Defined in types-shared/index.d.ts:2202
Interpolates vectors linearly.

Parameters
- vector: IVector3
- ratio: number
Returns Vector3

mul

mul(x: number, y: number, z: number): Vector3
mul(value: number): Vector3
mul(array: [number, number, number]): Vector3
mul(vector: IVector3): Vector3

- Defined in types-shared/index.d.ts:2135
Multiplies two vectors.

Parameters
- x: number
- y: number
- z: number
Returns Vector3
- Defined in types-shared/index.d.ts:2140
Multiplies all vector axis by a number.

Parameters
- value: number
Returns Vector3
- Defined in types-shared/index.d.ts:2145
Multiplies two vectors.

Parameters
- array: [number, number, number]
Returns Vector3
- Defined in types-shared/index.d.ts:2150
Multiplies two vectors.

Parameters
- vector: IVector3
Returns Vector3

negative

negative(): Vector3

- Defined in types-shared/index.d.ts:2155
Negates vector.

Returns Vector3

normalize

normalize(): Vector3

- Defined in types-shared/index.d.ts:2162
Normalizes vector.

Returns Vector3

sub

sub(x: number, y: number, z: number): Vector3
sub(value: number): Vector3
sub(array: [number, number, number]): Vector3
sub(vector: IVector3): Vector3

- Defined in types-shared/index.d.ts:2055
Subtracts two vectors.

Parameters
- x: number
- y: number
- z: number
Returns Vector3
- Defined in types-shared/index.d.ts:2060
Subtracts a number from all vector axis.

Parameters
- value: number
Returns Vector3
- Defined in types-shared/index.d.ts:2065
Subtracts two vectors.

Parameters
- array: [number, number, number]
Returns Vector3
- Defined in types-shared/index.d.ts:2070
Subtracts two vectors.

Parameters
- vector: IVector3
Returns Vector3

toArray

toArray(): [number, number, number]

- Defined in types-shared/index.d.ts:2026
Returns [x, y, z] array.

Returns [number, number, number]

toDegrees

toDegrees(): Vector3

- Defined in types-shared/index.d.ts:2192
Converts radians to degrees.

Returns Vector3

toFixed

toFixed(precision: number): Vector3

- Defined in types-shared/index.d.ts:2028
Parameters
- precision: number
Returns Vector3

toRadians

toRadians(): Vector3

- Defined in types-shared/index.d.ts:2187
Converts degrees to radians.

Returns Vector3

toString

toString(): string

- Defined in types-shared/index.d.ts:2030
Returns string