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