Difference between revisions of "Vector (API)"
From ComputerCraft Wiki
Line 5: | Line 5: | ||
To transform GPS quickly into vector format, simply use: | To transform GPS quickly into vector format, simply use: | ||
local a = vector.new(gps.locate()) | local a = vector.new(gps.locate()) | ||
+ | You can use vectors like a traditional table, but by using vectors you also gain the added functions provided in the Vector API. | ||
An introduction to vectors can be found on [[Wikipedia:Euclidean_vector|Wikipedia]]. | An introduction to vectors can be found on [[Wikipedia:Euclidean_vector|Wikipedia]]. |
Revision as of 15:04, 23 February 2013
The vector API provides methods to create and manipulate vectors.
Among other things, vectors can be useful to aid in creating navigation algorithms using GPS coordinates.
To transform GPS quickly into vector format, simply use:
local a = vector.new(gps.locate())
You can use vectors like a traditional table, but by using vectors you also gain the added functions provided in the Vector API.
An introduction to vectors can be found on Wikipedia.
Method Name | Description |
vector.new(float x, float y, float z) | Creates a vector. |
vectorA:add(vector vectorB) | Adds vectorB to vectorA and returns the resulting vector. Can also be used by writing vectorA + vectorB. |
vectorA:sub(vector vectorB) | Subtracts vectorB from vectorA and returns the resulting vector. Can also be used by writing vectorA - vectorB. |
vectorA:mul(float n) | Scalar multiplies vectorA with n and returns the resulting vector. Can also be used by writing vectorA * n. |
vectorA:dot(vector vectorB) | Returns the dot product of vectorA and vectorB. |
vectorA:cross(vector vectorB) | Returns the vector which resulted in the cross product of vectorA and vectorB. |
vectorA:length() | Returns the vector's length. |
vectorA:normalize() | Normalizes the vector and returns the result as a new vector. |
vectorA:round() | Rounds the vector coordinates to the nearest integers and returns the result as a new vector. |
vectorA:tostring() | Returns a string representation of the vector in the form of "x,y,z". |