Util vector2d
Vector functions.
Functions
| distance (x1, y1, x2, y2) | Get distance from one vector(x1, y1) to other vector(x2, y2). |
| distance2 (x1, y1, x2, y2) | Get distance^2 from one vector(x1, y1) to other vector(x2, y2). |
| length (x, y) | Get the length of this vector. |
| length2 (x, y) | Get the length^2 of this vector. |
| angle (x, y) | Get the angle (in radians) of the vector. |
| snap (x, y, gx, gy) | Snap this vector to the given grid. |
| approach (x1, y1, x2, y2, step) | Step from one vector towards another vector with the given step. |
| perpendicular (x, y) | Returns a vector perpendicular to this one. |
| dot (x1, y1, x2, y2) | Returns dot product of the two vectors. |
| cross (x1, y1, x2, y2) | Returns cross product of the two vectors. |
| projectOn (x1, y1, x2, y2) | Project first vector onto the other. |
| mirrorOn (x1, y1, x2, y2) | Mirror first vector respective to the other. |
| normal (x, y) | Get normalized vector. |
| trim (x, y, maxLength) | Trim vector length. |
| rotate (x, y, r) | Rotate vector by the given angle. |
Functions
- distance (x1, y1, x2, y2)
-
Get distance from one vector(x1, y1) to other vector(x2, y2).
Parameters:
- x1 number
- y1 number
- x2 number
- y2 number
Returns:
-
number
distance
- distance2 (x1, y1, x2, y2)
-
Get distance^2 from one vector(x1, y1) to other vector(x2, y2).
Parameters:
- x1 number
- y1 number
- x2 number
- y2 number
Returns:
-
number
distance squared
- length (x, y)
-
Get the length of this vector.
Parameters:
- x number
- y number
Returns:
-
number
length
- length2 (x, y)
-
Get the length^2 of this vector.
Parameters:
- x number
- y number
Returns:
-
number
length squared
- angle (x, y)
-
Get the angle (in radians) of the vector.
Parameters:
- x number
- y number
Returns:
-
number
angle
- snap (x, y, gx, gy)
-
Snap this vector to the given grid.
Parameters:
- x number
- y number
- gx number grid size x
- gy number grid size y
Returns:
- number x snapped x coordinate
- number y snapped y coordinate
- approach (x1, y1, x2, y2, step)
-
Step from one vector towards another vector with the given step.
Parameters:
- x1 number
- y1 number
- x2 number
- y2 number
- step number size (distance to cover towards other vector)
Returns:
- number x new x coordinate
- number y new y coordinate
- perpendicular (x, y)
-
Returns a vector perpendicular to this one.
Parameters:
- x number
- y number
Returns:
- number x perpendicular x coordinate
- number y perpendicular y coordinate
- dot (x1, y1, x2, y2)
-
Returns dot product of the two vectors.
Parameters:
- x1 number
- y1 number
- x2 number
- y2 number
Returns:
-
number
dot dot product
- cross (x1, y1, x2, y2)
-
Returns cross product of the two vectors.
Parameters:
- x1 number
- y1 number
- x2 number
- y2 number
Returns:
-
number
cross cross product
- projectOn (x1, y1, x2, y2)
-
Project first vector onto the other.
Parameters:
- x1 number
- y1 number
- x2 number
- y2 number
Returns:
- number x projected vector x coordinate
- number y projected vector y coordinate
- mirrorOn (x1, y1, x2, y2)
-
Mirror first vector respective to the other.
Parameters:
- x1 number
- y1 number
- x2 number
- y2 number
Returns:
- number x mirrored vector x coordinate
- number y mirrored vector y coordinate
- normal (x, y)
-
Get normalized vector.
Parameters:
- x number
- y number
Returns:
- number x normalized vector x coordinate
- number y normalized vector y coordinate
- trim (x, y, maxLength)
-
Trim vector length.
Parameters:
- x number
- y number
- maxLength number trim length
Returns:
- number x trimmed vector x coordinate
- number y trimmed vector y coordinate
- rotate (x, y, r)
-
Rotate vector by the given angle.
Parameters:
- x number
- y number
- r number angle (radians) to rotate by
Returns:
- number x rotated vector x coordinate
- number y rotated vector y coordinate