Vec2:
A 2D vector.
x: number
The x coordinate
y: number
The y coordinate
fromAngle(deg: number): Vec2
Create a new Vec2 from an angle in degrees
fromArray(arr: Array): Vec2
Create a new Vec2 from an array
ZERO: Vec2
An empty vector. (0, 0)
ONE: Vec2
A vector with both components of 1. (1, 1)
LEFT: Vec2
A vector signaling to the left. (-1, 0)
RIGHT: Vec2
A vector signaling to the right. (1, 0)
UP: Vec2
A vector signaling up. (0, -1)
DOWN: Vec2
A vector signaling down. (0, 1)
toAxis(): Vec2
Closest orthogonal direction: LEFT, RIGHT, UP, or DOWN
clone(): Vec2
Clone the vector
copy(v: Vec2, out: Vec2): Vec2
add(args: Vec2Args): Vec2
Returns the sum with another vector.
add(v: Vec2, other: Vec2, out: Vec2): Vec2
Calculates the sum of the vectors
paramvThe first term
paramotherThe second term
paramoutThe vector sum
returnsThe sum of the vectors
addScaled(v: Vec2, other: Vec2, s: number, out: Vec2): Vec2
addc(v: Vec2, x: number, y: number, out: Vec2): Vec2
Calculates the sum of the vectors
paramvThe first term
paramxThe x of the second term
paramyThe y of the second term
paramoutThe vector sum
returnsThe sum of the vectors
sub(args: Vec2Args): Vec2
Returns the difference with another vector.
sub(v: Vec2, other: Vec2, out: Vec2): Vec2
Calculates the difference of the vectors
paramvThe first term
paramotherThe second term
paramoutThe vector difference
returnsThe difference of the vectors
subc(v: Vec2, x: number, y: number, out: Vec2): Vec2
Calculates the difference of the vectors
paramvThe first term
paramxThe x of the second term
paramyThe y of the second term
paramoutThe vector difference
returnsThe difference of the vectors
scale(args: Vec2Args): Vec2
Scale by another vector. or a single number
scale(v: Vec2, s: number, out: Vec2): Vec2
Calculates the scale of the vector
paramvThe vector
paramsThe x scale
paramoutThe y scale
paramunknownThe scaled vector
returnsThe scale of the vector
scalec(v: Vec2, x: number, y: number, out: Vec2): Vec2
Calculates the scale of the vector
paramvThe vector
paramxThe x scale
paramyThe y scale
paramoutThe scaled vector
returnsThe scale of the vector
scalev(v: Vec2, other: Vec2, out: Vec2): Vec2
Calculates the scale of the vector
paramvThe vector
paramotherThe scale
paramoutThe scaled vector
returnsThe scale of the vector
dist(args: Vec2Args): number
Get distance between another vector
dist(v: Vec2, other: Vec2): number
Calculates the distance between the vectors
paramvThe vector
paramotherThe other vector
returnsThe between the vectors
sdist(args: Vec2Args): number
Get squared distance between another vector
sdist(v: Vec2, other: Vec2): number
Calculates the squared distance between the vectors
paramvThe vector
paramotherThe other vector
returnsThe distance between the vectors
len(): number
Get length of the vector
sincev3000.0
len(v: Vec2): number
Calculates the length of the vector
paramvThe vector
returnsThe length of the vector
slen(): number
Get squared length of the vector
sincev3000.0
slen(v: Vec2): number
Calculates the squared length of the vector
paramvThe vector
returnsThe squared length of the vector
unit(): Vec2
Get the unit vector (length of 1).
unit(v: Vec2, out: Vec2): Vec2
normal(): Vec2
Get the perpendicular vector.
normal(v: Vec2, out: Vec2): Vec2
reflect(normal: Vec2): Vec2
Get the reflection of a vector with a normal.
sincev3000.0
project(on: Vec2): Vec2
Get the projection of a vector onto another vector.
sincev3000.0
reject(on: Vec2): Vec2
Get the rejection of a vector onto another vector.
sincev3000.0
rotate(vecOrAngle: Vec2 | number): Vec2
rotate(v: Vec2, dir: Vec2, out: Vec2): Vec2
Calculates the rotated vector
paramvThe vector
paramdirThe rotation vector
paramoutThe rotated vector
returnsThe rotated vector
rotateByAngle(v: Vec2, angle: number, out: Vec2): Vec2
Calculates the rotated vector
paramvThe vector
paramangleThe angle in radians
paramoutThe rotated vector
returnsThe rotated vector
invRotate(vecOrAngle: Vec2 | number): Vec2
inverseRotate(v: Vec2, dir: Vec2, out: Vec2): Vec2
Calculates the inverse rotated vector
paramvThe vector
paramdirThe rotation vector
paramoutThe rotated vector
returnsThe rotated vector
dot(p2: Vec2): number
Get the dot product with another vector.
dot(v: Vec2, other: Vec2): number
Get the dot product between 2 vectors.
sincev3000.0
cross(p2: Vec2): number
Get the cross product with another vector.
sincev3000.0
cross(v: Vec2, other: Vec2): number
Get the cross product between 2 vectors.
sincev3000.0
angle(args: Vec2Args): number
Get the angle of the vector in degrees.
toAngle(v: Vec2): number
Calculates the angle represented by the vector in radians
paramvThe vector
returnsAngle represented by the vector in radians
angleBetween(args: Vec2Args): number
Get the angle between this vector and another vector.
sincev3000.0
angleBetween(v: Vec2, other: Vec2): number
Calculates the angle between the vectors in radians
paramvFirst vector
paramotherSecond vector
returnsAngle between the vectors in radians
lerp(dest: Vec2, t: number): Vec2
Linear interpolate to a destination vector (for positions).
lerp(src: Vec2, dst: Vec2, t: number, out: Vec2): Vec2
Linear interpolate src and dst by t
paramsrcFirst vector
paramdstSecond vector
paramtPercentage
paramoutThe linear interpolation between src and dst by t
returnsThe linear interpolation between src and dst by t
slerp(dest: Vec2, t: number): Vec2
Spherical linear interpolate to a destination vector (for rotations).
sincev3000.0
slerp(src: Vec2, dst: Vec2, t: number, out: Vec2): Vec2
Spherical interpolate src and dst by t
paramsrcFirst vector
paramdstSecond vector
paramtPercentage
paramoutThe spherical interpolation between src and dst by t
returnsThe spherical interpolation between src and dst by t
isZero(): boolean
If the vector (x, y) is zero.
sincev3000.0
toFixed(n: number): Vec2
To n precision floating point.
transform(m: Mat4): Vec2
Multiply by a Mat4.
sincev3000.0
eq(other: Vec2): boolean
See if one vector is equal to another.
sincev3000.0
bbox(): Rect
Converts the vector to a Rect with the vector as the origin.
sincev3000.0.
toArray(): Array<number>
Converts the vector to an array.
sincev3001.0
