REVO / API version 0.0.10
Vector2
Immutable vector. Math operations return new values.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Vector2():
Vector2
Creates a zero vector.
Returns
Section titled “Returns”Vector2
Constructor
Section titled “Constructor”new Vector2(
x,y):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
x |
number |
y |
number |
Returns
Section titled “Returns”Vector2
Constructor
Section titled “Constructor”new Vector2(
value):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
[number, number] |
Returns
Section titled “Returns”Vector2
Constructor
Section titled “Constructor”new Vector2(
value):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
IVector2 |
Returns
Section titled “Returns”Vector2
Constructor
Section titled “Constructor”new Vector2(
value):Vector2
Sets every component to value.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
number |
Returns
Section titled “Returns”Vector2
Properties
Section titled “Properties”Methods
Section titled “Methods”Call Signature
Section titled “Call Signature”add(
x,y):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
x |
number |
y |
number |
Returns
Section titled “Returns”Vector2
Call Signature
Section titled “Call Signature”add(
value):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
number |
Returns
Section titled “Returns”Vector2
Call Signature
Section titled “Call Signature”add(
value):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
[number, number] |
Returns
Section titled “Returns”Vector2
Call Signature
Section titled “Call Signature”add(
value):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
IVector2 |
Returns
Section titled “Returns”Vector2
angleTo()
Section titled “angleTo()”angleTo(
value):number
Returns the angle in radians. Both vectors must be finite and non-zero.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
IVector2 |
Returns
Section titled “Returns”number
angleToDegrees()
Section titled “angleToDegrees()”angleToDegrees(
value):number
Returns the angle in degrees. Both vectors must be finite and non-zero.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
IVector2 |
Returns
Section titled “Returns”number
distanceTo()
Section titled “distanceTo()”distanceTo(
value):number
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
IVector2 |
Returns
Section titled “Returns”number
distanceToSquared()
Section titled “distanceToSquared()”distanceToSquared(
value):number
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
IVector2 |
Returns
Section titled “Returns”number
Call Signature
Section titled “Call Signature”div(
x,y):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
x |
number |
y |
number |
Returns
Section titled “Returns”Vector2
Call Signature
Section titled “Call Signature”div(
value):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
number |
Returns
Section titled “Returns”Vector2
Call Signature
Section titled “Call Signature”div(
value):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
[number, number] |
Returns
Section titled “Returns”Vector2
Call Signature
Section titled “Call Signature”div(
value):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
IVector2 |
Returns
Section titled “Returns”Vector2
Call Signature
Section titled “Call Signature”dot(
x,y):number
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
x |
number |
y |
number |
Returns
Section titled “Returns”number
Call Signature
Section titled “Call Signature”dot(
value):number
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
number |
Returns
Section titled “Returns”number
Call Signature
Section titled “Call Signature”dot(
value):number
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
[number, number] |
Returns
Section titled “Returns”number
Call Signature
Section titled “Call Signature”dot(
value):number
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
IVector2 |
Returns
Section titled “Returns”number
equals()
Section titled “equals()”equals(
value,epsilon?):boolean
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
value |
IVector2 |
- |
epsilon? |
number |
Finite, non-negative tolerance per component. Defaults to 0. |
Returns
Section titled “Returns”boolean
inverse()
Section titled “inverse()”inverse():
Vector2
Returns the reciprocal of each component. Throws RangeError if a component is zero.
Returns
Section titled “Returns”Vector2
isInRange()
Section titled “isInRange()”isInRange(
value,range):boolean
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
value |
IVector2 |
- |
range |
number |
Maximum distance, inclusive. Must be non-negative. |
Returns
Section titled “Returns”boolean
lerp()
Section titled “lerp()”lerp(
value,ratio):Vector2
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
value |
IVector2 |
- |
ratio |
number |
Interpolation factor. Values outside [0, 1] extrapolate. |
Returns
Section titled “Returns”Vector2
Call Signature
Section titled “Call Signature”mul(
x,y):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
x |
number |
y |
number |
Returns
Section titled “Returns”Vector2
Call Signature
Section titled “Call Signature”mul(
value):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
number |
Returns
Section titled “Returns”Vector2
Call Signature
Section titled “Call Signature”mul(
value):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
[number, number] |
Returns
Section titled “Returns”Vector2
Call Signature
Section titled “Call Signature”mul(
value):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
IVector2 |
Returns
Section titled “Returns”Vector2
negative()
Section titled “negative()”negative():
Vector2
Returns
Section titled “Returns”Vector2
normalize()
Section titled “normalize()”normalize():
Vector2
Throws RangeError for a zero or infinite vector.
Returns
Section titled “Returns”Vector2
Call Signature
Section titled “Call Signature”sub(
x,y):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
x |
number |
y |
number |
Returns
Section titled “Returns”Vector2
Call Signature
Section titled “Call Signature”sub(
value):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
number |
Returns
Section titled “Returns”Vector2
Call Signature
Section titled “Call Signature”sub(
value):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
[number, number] |
Returns
Section titled “Returns”Vector2
Call Signature
Section titled “Call Signature”sub(
value):Vector2
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
IVector2 |
Returns
Section titled “Returns”Vector2
toArray()
Section titled “toArray()”toArray(): [
number,number]
Returns
Section titled “Returns”[number, number]
toDegrees()
Section titled “toDegrees()”toDegrees():
Vector2
Returns
Section titled “Returns”Vector2
toFixed()
Section titled “toFixed()”toFixed(
precision?):Vector2
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
precision? |
number |
Number of decimal places. Must be an integer from 0 to 100. Defaults to 4. |
Returns
Section titled “Returns”Vector2
toRadians()
Section titled “toRadians()”toRadians():
Vector2
Returns
Section titled “Returns”Vector2
toString()
Section titled “toString()”toString():
string
Returns a string representation of an object.
Returns
Section titled “Returns”string