13 KiB
Class: Vec2
2D vector
Constructors
new Vec2()
new Vec2(
x,y):Vec2
Parameters
• x: number
• y: number
Returns
new Vec2()
new Vec2(
obj):Vec2
Parameters
• obj: Vec2Value
Returns
new Vec2()
new Vec2():
Vec2
Returns
Properties
x
x:
number
y
y:
number
Methods
add()
add(
w):Vec2
Add a vector to this vector.
Parameters
• w: Vec2Value
Returns
this
addCombine()
addCombine(
a,v,b,w):Vec2
Add linear combination of v and w: a * v + b * w
Parameters
• a: number
• v: Vec2Value
• b: number
• w: Vec2Value
Returns
addMul()
addMul(
a,v):Vec2
Parameters
• a: number
• v: Vec2Value
Returns
clamp()
clamp(
max):Vec2
Parameters
• max: number
Returns
clone()
clone():
Vec2
Returns
length()
length():
number
Get the length of this vector (the norm).
For performance, use this instead of lengthSquared (if possible).
Returns
number
lengthSquared()
lengthSquared():
number
Get the length squared.
Returns
number
mul()
mul(
m):Vec2
Multiply this vector by a scalar.
Parameters
• m: number
Returns
this
neg()
neg():
Vec2
Returns
normalize()
normalize():
number
Convert this vector into a unit vector.
Returns
number
old length
set()
Set this vector to some specified coordinates.
set(x, y)
set(
x,y):Vec2
Set this vector to some specified coordinates.
Parameters
• x: number
• y: number
Returns
set(value)
set(
value):Vec2
Set this vector to some specified coordinates.
Parameters
• value: Vec2Value
Returns
setCombine()
setCombine(
a,v,b,w):Vec2
Set linear combination of v and w: a * v + b * w
Parameters
• a: number
• v: Vec2Value
• b: number
• w: Vec2Value
Returns
setMul()
setMul(
a,v):Vec2
Parameters
• a: number
• v: Vec2Value
Returns
setNum()
setNum(
x,y):Vec2
Set this vector to some specified coordinates.
Parameters
• x: number
• y: number
Returns
this
setVec2()
setVec2(
value):Vec2
Set this vector to some specified coordinates.
Parameters
• value: Vec2Value
Returns
this
setZero()
setZero():
Vec2
Set this vector to all zeros.
Returns
this
sub()
sub(
w):Vec2
Subtract a vector from this vector
Parameters
• w: Vec2Value
Returns
this
subCombine()
subCombine(
a,v,b,w):Vec2
Subtract linear combination of v and w: a * v + b * w
Parameters
• a: number
• v: Vec2Value
• b: number
• w: Vec2Value
Returns
subMul()
subMul(
a,v):Vec2
Parameters
• a: number
• v: Vec2Value
Returns
wSub()
wSub(
a,v,b?,w?):Vec2
Parameters
• a: number
• v: Vec2Value
• b?: number
• w?: Vec2Value
Returns
Deprecated
Use subCombine or subMul
abs()
staticabs(v):Vec2
Parameters
• v: Vec2Value
Returns
add()
staticadd(v,w):Vec2
Parameters
• v: Vec2Value
• w: Vec2Value
Returns
addCross()
addCross(a, v, w)
staticaddCross(a,v,w):Vec2
Returns a + (v x w)
Parameters
• a: Vec2Value
• v: Vec2Value
• w: number
Returns
addCross(a, v, w)
staticaddCross(a,v,w):Vec2
Returns a + (v x w)
Parameters
• a: Vec2Value
• v: number
• w: Vec2Value
Returns
addCrossNumVec2()
staticaddCrossNumVec2(a,v,w):Vec2
Returns a + (v x w)
Parameters
• a: Vec2Value
• v: number
• w: Vec2Value
Returns
addCrossVec2Num()
staticaddCrossVec2Num(a,v,w):Vec2
Returns a + (v x w)
Parameters
• a: Vec2Value
• v: Vec2Value
• w: number
Returns
areEqual()
staticareEqual(v,w):boolean
Parameters
• v: Vec2Value
• w: Vec2Value
Returns
boolean
assert()
staticassert(o):void
Parameters
• o: any
Returns
void
clamp()
staticclamp(v,max):Vec2
Parameters
• v: Vec2Value
• max: number
Returns
clone()
staticclone(v):Vec2
Parameters
• v: Vec2Value
Returns
combine()
staticcombine(a,v,b,w):Vec2
Parameters
• a: number
• v: Vec2Value
• b: number
• w: Vec2Value
Returns
cross()
cross(v, w)
staticcross(v,w):number
Cross product between two vectors
Parameters
• v: Vec2Value
• w: Vec2Value
Returns
number
cross(v, w)
staticcross(v,w):Vec2
Cross product between a vector and a scalar
Parameters
• v: Vec2Value
• w: number
Returns
cross(v, w)
staticcross(v,w):Vec2
Cross product between a scalar and a vector
Parameters
• v: number
• w: Vec2Value
Returns
crossNumVec2()
staticcrossNumVec2(v,w):Vec2
Cross product on a vector and a scalar
Parameters
• v: number
• w: Vec2Value
Returns
crossVec2Num()
staticcrossVec2Num(v,w):Vec2
Cross product on a vector and a scalar
Parameters
• v: Vec2Value
• w: number
Returns
crossVec2Vec2()
staticcrossVec2Vec2(v,w):number
Cross product on two vectors
Parameters
• v: Vec2Value
• w: Vec2Value
Returns
number
distance()
staticdistance(v,w):number
Parameters
• v: Vec2Value
• w: Vec2Value
Returns
number
distanceSquared()
staticdistanceSquared(v,w):number
Parameters
• v: Vec2Value
• w: Vec2Value
Returns
number
dot()
staticdot(v,w):number
Dot product on two vectors
Parameters
• v: Vec2Value
• w: Vec2Value
Returns
number
isValid()
staticisValid(obj):boolean
Does this vector contain finite coordinates?
Parameters
• obj: any
Returns
boolean
lengthOf()
staticlengthOf(v):number
Get the length of this vector (the norm).
For performance, use this instead of lengthSquared (if possible).
Parameters
• v: Vec2Value
Returns
number
lengthSquared()
staticlengthSquared(v):number
Get the length squared.
Parameters
• v: Vec2Value
Returns
number
lower()
staticlower(v,w):Vec2
Parameters
• v: Vec2Value
• w: Vec2Value
Returns
mid()
staticmid(v,w):Vec2
Parameters
• v: Vec2Value
• w: Vec2Value
Returns
mul()
mul(a, b)
staticmul(a,b):Vec2
Parameters
• a: Vec2Value
• b: number
Returns
mul(a, b)
staticmul(a,b):Vec2
Parameters
• a: number
• b: Vec2Value
Returns
mulNumVec2()
staticmulNumVec2(a,b):Vec2
Parameters
• a: number
• b: Vec2Value
Returns
mulVec2Num()
staticmulVec2Num(a,b):Vec2
Parameters
• a: Vec2Value
• b: number
Returns
neg()
staticneg(v):Vec2
Parameters
• v: Vec2Value
Returns
normalize()
staticnormalize(v):Vec2
Returns a new unit vector from the provided vector.
Parameters
• v: Vec2Value
Returns
new unit vector
skew()
staticskew(v):Vec2
Get the skew vector such that dot(skew_vec, other) == cross(vec, other)
Parameters
• v: Vec2Value
Returns
sub()
staticsub(v,w):Vec2
Parameters
• v: Vec2Value
• w: Vec2Value
Returns
upper()
staticupper(v,w):Vec2
Parameters
• v: Vec2Value
• w: Vec2Value
Returns
zero()
staticzero():Vec2