kick.math.Vec2 Class
Vec2 - 2 dimensional vector Any javascript array containing at least 2 numeric elements can serve as a vec2
Item Index
Methods
- add static
- array static
- clone static
- copy static
- create static
- cross static
- distance static
- divide static
- dot static
- equal static
- forEach static
- fromValues static
- length static
- lerp static
- max static
- min static
- multiply static
- negate static
- normalize static
- scale static
- set static
- squaredDistance static
- squaredLength static
- str static
- subtract static
- transformMat2 static
- transformMat2d static
- transformMat3 static
- transformMat4 static
- wrapArray static
Methods
add
-
out -
a -
b
Adds two vec2's
Parameters:
-
outkick.math.Vec2the receiving vector
-
akick.math.Vec2the first operand
-
bkick.math.Vec2the second operand
Returns:
out
array
-
count -
ref
Create a continuous array in memory mapped to vec2.
Parameters:
-
countNumberNumber of vec 2 to be layed out in memory
-
refObjectOptional, if set a memory reference is set to ref.mem
Returns:
New vec2
clone
-
a
Parameters:
-
akick.math.Vec2vector to clone
Returns:
a new 2D vector
copy
-
out -
a
Copies the values of one vec2 to another
Parameters:
-
outkick.math.Vec2the receiving vector
-
akick.math.Vec2the source vector
Returns:
out
cross
-
out -
a -
b
Computes the cross product of two vec2's Note that the cross product must by definition produce a 3D vector
Parameters:
-
outkick.math.Vec3the receiving vector
-
akick.math.Vec2the first operand
-
bkick.math.Vec2the second operand
Returns:
out
distance
-
a -
b
Calculates the euclidian distance between two vec2's
Parameters:
-
akick.math.Vec2the first operand
-
bkick.math.Vec2the second operand
Returns:
distance between a and b
divide
-
out -
a -
b
Divides two vec2's
Parameters:
-
outkick.math.Vec2the receiving vector
-
akick.math.Vec2the first operand
-
bkick.math.Vec2the second operand
Returns:
out
dot
-
a -
b
Calculates the dot product of two vec2's
Parameters:
-
akick.math.Vec2the first operand
-
bkick.math.Vec2the second operand
Returns:
dot product of a and b
equal
-
vec -
vec2 -
epsilon
Test to see if vectors are equal (difference is less than epsilon)
Parameters:
-
veckick.math.Vec2first operand
-
vec2kick.math.Vec2second operand
-
epsilonNumberOptional - default value is
Returns:
true if two vectors are equals
forEach
-
a -
stride -
offset -
count -
fn -
[arg]
Perform some operation over an array of vec2s.
Parameters:
-
aArraythe array of vectors to iterate over
-
strideNumberNumber of elements between the start of each vec2. If 0 assumes tightly packed
-
offsetNumberNumber of elements to skip at the beginning of the array
-
countNumberNumber of vec2s to iterate over. If 0 iterates over entire array
-
fnFunctionFunction to call for each vector in the array
-
[arg]Object optionaladditional argument to pass to fn
Returns:
a
fromValues
-
x -
y
Creates a new vec2 initialized with the given values
Parameters:
-
xNumberX component
-
yNumberY component
Returns:
a new 2D vector
length
-
a
Calculates the length of a vec2
Parameters:
-
akick.math.Vec2vector to calculate length of
Returns:
length of a
lerp
-
out -
a -
b -
t
Performs a linear interpolation between two vec2's
Parameters:
-
outkick.math.Vec2the receiving vector
-
akick.math.Vec2the first operand
-
bkick.math.Vec2the second operand
-
tNumberinterpolation amount between the two inputs
Returns:
out
max
-
out -
a -
b
Returns the maximum of two vec2's
Parameters:
-
outkick.math.Vec2the receiving vector
-
akick.math.Vec2the first operand
-
bkick.math.Vec2the second operand
Returns:
out
min
-
out -
a -
b
Returns the minimum of two vec2's
Parameters:
-
outkick.math.Vec2the receiving vector
-
akick.math.Vec2the first operand
-
bkick.math.Vec2the second operand
Returns:
out
multiply
-
out -
a -
b
Multiplies two vec2's
Parameters:
-
outkick.math.Vec2the receiving vector
-
akick.math.Vec2the first operand
-
bkick.math.Vec2the second operand
Returns:
out
negate
-
out -
a
Negates the components of a vec2
Parameters:
-
outkick.math.Vec2the receiving vector
-
akick.math.Vec2vector to negate
Returns:
out
normalize
-
out -
a
Normalize a vec2
Parameters:
-
outkick.math.Vec2the receiving vector
-
akick.math.Vec2vector to normalize
Returns:
out
scale
-
out -
a -
b
Scales a vec2 by a scalar number
Parameters:
-
outkick.math.Vec2the receiving vector
-
akick.math.Vec2the vector to scale
-
bNumberamount to scale the vector by
Returns:
out
set
-
out -
x -
y
Set the components of a vec2 to the given values
Parameters:
-
outkick.math.Vec2the receiving vector
-
xNumberX component
-
yNumberY component
Returns:
out
squaredDistance
-
a -
b
Calculates the squared euclidian distance between two vec2's
Parameters:
-
akick.math.Vec2the first operand
-
bkick.math.Vec2the second operand
Returns:
squared distance between a and b
squaredLength
-
a
Calculates the squared length of a vec2
Parameters:
-
akick.math.Vec2vector to calculate squared length of
Returns:
squared length of a
str
-
vec
Returns a string representation of a vector
Parameters:
-
veckick.math.Vec2vec2 to represent as a string
Returns:
string representation of vec
subtract
-
out -
a -
b
Subtracts two vec2's
Parameters:
-
outkick.math.Vec2the receiving vector
-
akick.math.Vec2the first operand
-
bkick.math.Vec2the second operand
Returns:
out
transformMat2
-
out -
a -
m
Transforms the vec2 with a mat2
Parameters:
-
outkick.math.Vec2the receiving vector
-
akick.math.Vec2the vector to transform
-
mkick.math.Mat2matrix to transform with
Returns:
out
transformMat2d
-
out -
a -
m
Transforms the vec2 with a mat2d
Parameters:
-
outkick.math.Vec2the receiving vector
-
akick.math.Vec2the vector to transform
-
mkick.math.Mat2dmatrix to transform with
Returns:
out
transformMat3
-
out -
a -
m
Transforms the vec2 with a mat3 3rd vector component is implicitly '1'
Parameters:
-
outkick.math.Vec2the receiving vector
-
akick.math.Vec2the vector to transform
-
mkick.math.Mat3matrix to transform with
Returns:
out
transformMat4
-
out -
a -
m
Transforms the vec2 with a mat4 3rd vector component is implicitly '0' 4th vector component is implicitly '1'
Parameters:
-
outkick.math.Vec2the receiving vector
-
akick.math.Vec2the vector to transform
-
mkick.math.Mat4matrix to transform with
Returns:
out
wrapArray
-
array
See kick.math.Vec4.wrapArray
Parameters:
-
arrayFloat32Array
Returns:
of vec2