Skip to content

REVO / API version 0.0.10

Vector2

Immutable vector. Math operations return new values.

new Vector2(): Vector2

Creates a zero vector.

Vector2

new Vector2(x, y): Vector2

Parameter Type
x number
y number

Vector2

new Vector2(value): Vector2

Parameter Type
value [number, number]

Vector2

new Vector2(value): Vector2

Parameter Type
value IVector2

Vector2

new Vector2(value): Vector2

Sets every component to value.

Parameter Type
value number

Vector2

Property Type Details
length
readonly
number —
lengthSquared
readonly
number —
x
readonly
number Implements IVector2.x
y
readonly
number Implements IVector2.y
down
static readonly
Vector2 —
left
static readonly
Vector2 —
negativeInfinity
static readonly
Vector2 —
one
static readonly
Vector2 —
positiveInfinity
static readonly
Vector2 —
right
static readonly
Vector2 —
up
static readonly
Vector2 —
zero
static readonly
Vector2 —

add(x, y): Vector2

Parameter Type
x number
y number

Vector2

add(value): Vector2

Parameter Type
value number

Vector2

add(value): Vector2

Parameter Type
value [number, number]

Vector2

add(value): Vector2

Parameter Type
value IVector2

Vector2


angleTo(value): number

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

Parameter Type
value IVector2

number


angleToDegrees(value): number

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

Parameter Type
value IVector2

number


distanceTo(value): number

Parameter Type
value IVector2

number


distanceToSquared(value): number

Parameter Type
value IVector2

number


div(x, y): Vector2

Parameter Type
x number
y number

Vector2

div(value): Vector2

Parameter Type
value number

Vector2

div(value): Vector2

Parameter Type
value [number, number]

Vector2

div(value): Vector2

Parameter Type
value IVector2

Vector2


dot(x, y): number

Parameter Type
x number
y number

number

dot(value): number

Parameter Type
value number

number

dot(value): number

Parameter Type
value [number, number]

number

dot(value): number

Parameter Type
value IVector2

number


equals(value, epsilon?): boolean

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

boolean


inverse(): Vector2

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

Vector2


isInRange(value, range): boolean

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

boolean


lerp(value, ratio): Vector2

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

Vector2


mul(x, y): Vector2

Parameter Type
x number
y number

Vector2

mul(value): Vector2

Parameter Type
value number

Vector2

mul(value): Vector2

Parameter Type
value [number, number]

Vector2

mul(value): Vector2

Parameter Type
value IVector2

Vector2


negative(): Vector2

Vector2


normalize(): Vector2

Throws RangeError for a zero or infinite vector.

Vector2


sub(x, y): Vector2

Parameter Type
x number
y number

Vector2

sub(value): Vector2

Parameter Type
value number

Vector2

sub(value): Vector2

Parameter Type
value [number, number]

Vector2

sub(value): Vector2

Parameter Type
value IVector2

Vector2


toArray(): [number, number]

[number, number]


toDegrees(): Vector2

Vector2


toFixed(precision?): Vector2

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

Vector2


toRadians(): Vector2

Vector2


toString(): string

Returns a string representation of an object.

string