Skip to content

REVO / API version 0.0.10

Vector3

Immutable vector. Math operations return new values.

new Vector3(): Vector3

Creates a zero vector.

Vector3

new Vector3(x, y, z): Vector3

Parameter Type
x number
y number
z number

Vector3

new Vector3(value): Vector3

Parameter Type
value [number, number, number]

Vector3

new Vector3(value): Vector3

Parameter Type
value IVector3

Vector3

new Vector3(value): Vector3

Sets every component to value.

Parameter Type
value number

Vector3

Property Type Details
length
readonly
number —
lengthSquared
readonly
number —
x
readonly
number Implements IVector3.x
y
readonly
number Implements IVector3.y
z
readonly
number Implements IVector3.z
back
static readonly
Vector3 —
down
static readonly
Vector3 —
forward
static readonly
Vector3 —
left
static readonly
Vector3 —
negativeInfinity
static readonly
Vector3 —
one
static readonly
Vector3 —
positiveInfinity
static readonly
Vector3 —
right
static readonly
Vector3 —
up
static readonly
Vector3 —
zero
static readonly
Vector3 —

add(x, y, z): Vector3

Parameter Type
x number
y number
z number

Vector3

add(value): Vector3

Parameter Type
value number

Vector3

add(value): Vector3

Parameter Type
value [number, number, number]

Vector3

add(value): Vector3

Parameter Type
value IVector3

Vector3


angleTo(value): number

Returns the angle in radians. Both vectors must be finite and non-zero.

Parameter Type
value IVector3

number


angleToDegrees(value): number

Returns the angle in degrees. Both vectors must be finite and non-zero.

Parameter Type
value IVector3

number


cross(x, y, z): Vector3

Parameter Type
x number
y number
z number

Vector3

cross(value): Vector3

Parameter Type
value number

Vector3

cross(value): Vector3

Parameter Type
value [number, number, number]

Vector3

cross(value): Vector3

Parameter Type
value IVector3

Vector3


distanceTo(value): number

Parameter Type
value IVector3

number


distanceToSquared(value): number

Parameter Type
value IVector3

number


div(x, y, z): Vector3

Parameter Type
x number
y number
z number

Vector3

div(value): Vector3

Parameter Type
value number

Vector3

div(value): Vector3

Parameter Type
value [number, number, number]

Vector3

div(value): Vector3

Parameter Type
value IVector3

Vector3


dot(x, y, z): number

Parameter Type
x number
y number
z number

number

dot(value): number

Parameter Type
value number

number

dot(value): number

Parameter Type
value [number, number, number]

number

dot(value): number

Parameter Type
value IVector3

number


equals(value, epsilon?): boolean

Parameter Type Description
value IVector3 -
epsilon? number Finite, non-negative tolerance per component. Defaults to 0.

boolean


inverse(): Vector3

Returns the reciprocal of each component. Throws RangeError if a component is zero.

Vector3


isInRange(value, range): boolean

Parameter Type Description
value IVector3 -
range number Maximum distance, inclusive. Must be non-negative.

boolean


lerp(value, ratio): Vector3

Parameter Type Description
value IVector3 -
ratio number Interpolation factor. Values outside [0, 1] extrapolate.

Vector3


mul(x, y, z): Vector3

Parameter Type
x number
y number
z number

Vector3

mul(value): Vector3

Parameter Type
value number

Vector3

mul(value): Vector3

Parameter Type
value [number, number, number]

Vector3

mul(value): Vector3

Parameter Type
value IVector3

Vector3


negative(): Vector3

Vector3


normalize(): Vector3

Throws RangeError for a zero or infinite vector.

Vector3


sub(x, y, z): Vector3

Parameter Type
x number
y number
z number

Vector3

sub(value): Vector3

Parameter Type
value number

Vector3

sub(value): Vector3

Parameter Type
value [number, number, number]

Vector3

sub(value): Vector3

Parameter Type
value IVector3

Vector3


toArray(): [number, number, number]

[number, number, number]


toDegrees(): Vector3

Vector3


toFixed(precision?): Vector3

Parameter Type Description
precision? number Number of decimal places. Must be an integer from 0 to 100. Defaults to 4.

Vector3


toRadians(): Vector3

Vector3


toString(): string

Returns a string representation of an object.

string