Vec2
Defined in: Vec2.ts:11
Immutable 2D vector. All operations return new instances.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Vec2(
x,y):Vec2
Defined in: Vec2.ts:25
Parameters
Section titled “Parameters”number
The x component.
number
The y component.
Returns
Section titled “Returns”Vec2
Properties
Section titled “Properties”
readonlyx:number
Defined in: Vec2.ts:27
The x component.
Implementation of
Section titled “Implementation of”
readonlyy:number
Defined in: Vec2.ts:29
The y component.
Implementation of
Section titled “Implementation of”
readonlystaticDOWN:Vec2
Defined in: Vec2.ts:19
Down direction (0, 1) — screen coordinates.
readonlystaticLEFT:Vec2
Defined in: Vec2.ts:21
Left direction (-1, 0).
readonlystaticONE:Vec2
Defined in: Vec2.ts:15
The one vector (1, 1).
readonlystaticRIGHT:Vec2
Defined in: Vec2.ts:23
Right direction (1, 0).
readonlystaticUP:Vec2
Defined in: Vec2.ts:17
Up direction (0, -1) — screen coordinates.
readonlystaticZERO:Vec2
Defined in: Vec2.ts:13
The zero vector (0, 0).
Methods
Section titled “Methods”add(
other):Vec2
Defined in: Vec2.ts:33
Add another vector.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Vec2
angle()
Section titled “angle()”angle():
number
Defined in: Vec2.ts:102
Angle of this vector in radians (atan2).
Returns
Section titled “Returns”number
cross()
Section titled “cross()”cross(
other):number
Defined in: Vec2.ts:58
Cross product (z-component of the 3D cross product).
Parameters
Section titled “Parameters”Returns
Section titled “Returns”number
distance()
Section titled “distance()”distance(
other):number
Defined in: Vec2.ts:80
Euclidean distance to another vector.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”number
distanceSq()
Section titled “distanceSq()”distanceSq(
other):number
Defined in: Vec2.ts:87
Squared distance to another vector (avoids sqrt).
Parameters
Section titled “Parameters”Returns
Section titled “Returns”number
dot(
other):number
Defined in: Vec2.ts:53
Dot product with another vector.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”number
equals()
Section titled “equals()”equals(
other,epsilon?):boolean
Defined in: Vec2.ts:114
Check equality with optional epsilon tolerance.
Parameters
Section titled “Parameters”epsilon?
Section titled “epsilon?”number = EPSILON
Returns
Section titled “Returns”boolean
length()
Section titled “length()”length():
number
Defined in: Vec2.ts:63
Magnitude of this vector.
Returns
Section titled “Returns”number
lengthSq()
Section titled “lengthSq()”lengthSq():
number
Defined in: Vec2.ts:68
Squared magnitude (avoids sqrt).
Returns
Section titled “Returns”number
lerp()
Section titled “lerp()”lerp(
other,t):Vec2
Defined in: Vec2.ts:94
Linear interpolation toward another vector.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Vec2
multiply()
Section titled “multiply()”multiply(
other):Vec2
Defined in: Vec2.ts:48
Component-wise multiply with another vector.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Vec2
normalize()
Section titled “normalize()”normalize():
Vec2
Defined in: Vec2.ts:73
Return a unit vector in the same direction. Returns ZERO for zero-length vectors.
Returns
Section titled “Returns”Vec2
rotate()
Section titled “rotate()”rotate(
radians):Vec2
Defined in: Vec2.ts:107
Rotate this vector by radians.
Parameters
Section titled “Parameters”radians
Section titled “radians”number
Returns
Section titled “Returns”Vec2
scale()
Section titled “scale()”scale(
scalar):Vec2
Defined in: Vec2.ts:43
Scale by a scalar.
Parameters
Section titled “Parameters”scalar
Section titled “scalar”number
Returns
Section titled “Returns”Vec2
sub(
other):Vec2
Defined in: Vec2.ts:38
Subtract another vector.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Vec2
toString()
Section titled “toString()”toString():
string
Defined in: Vec2.ts:122
String representation.
Returns
Section titled “Returns”string
distance()
Section titled “distance()”
staticdistance(a,b):number
Defined in: Vec2.ts:132
Euclidean distance between two vectors.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”number
fromAngle()
Section titled “fromAngle()”
staticfromAngle(radians,length?):Vec2
Defined in: Vec2.ts:127
Create a unit vector from an angle in radians, optionally scaled.
Parameters
Section titled “Parameters”radians
Section titled “radians”number
length?
Section titled “length?”number = 1
Returns
Section titled “Returns”Vec2
lerp()
Section titled “lerp()”
staticlerp(a,b,t):Vec2
Defined in: Vec2.ts:139
Linear interpolation between two vectors.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Vec2