Difference between revisions of "Vector (API)"

From ComputerCraft Wiki
Jump to: navigation, search
(Page creation)
 
(Changing float to number)
 
(32 intermediate revisions by 12 users not shown)
Line 1: Line 1:
−
The vector API provides methods to create and manipulates vectors.
+
The vector API provides methods to create and manipulate vectors.
  
 +
An introduction to vectors can be found on [[Wikipedia:Euclidean_vector|Wikipedia]].
  
−
{| border="1" cellpadding="2" cellspacing="0"
+
<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
−
!colspan="2" style="text-align: center; background: #DDDDDD"|Static methods
+
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
−
|-
+
[[File:Grid_disk.png|24px]]&nbsp;&nbsp;
−
|style="text-align: center; background: #EFEFEF" width="200px"|Method name
+
Vector (API)
−
|style="text-align: center; background: #EFEFEF" width="*"|Description
+
</td></tr>
−
|-
+
−
|vector.new(x, y, z)
+
−
|Creates a vector.<br />
+
−
''@param'' '''x, y, z''' the vector coordinates<br />
+
−
''@return'' the created vector
+
−
|}
+
  
 +
<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>
  
−
{| border="1" cellpadding="2" cellspacing="0"
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[vector.new]]({{type|number}} x, {{type|number}} y, {{type|number}} z)</td>
−
!colspan="2" style="text-align: center; background: #DDDDDD"|Object methods
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Creates a vector.</td></tr>
−
|-
+
 
−
|style="text-align: center; background: #EFEFEF" width="200px"|Method name
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[vectorA:add]]([[Vector (API)|vector]] vectorB)</td>
−
|style="text-align: center; background: #EFEFEF" width="*"|Description
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Adds ''vectorB'' to ''vectorA'' and returns the resulting vector. Can also be used by writing vectorA + vectorB.</td></tr>
−
|-
+
 
−
|vectorA.add(vectorB)
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[vectorA:sub]]([[Vector (API)|vector]] vectorB)</td>
−
|Adds vectorB to vectorA and returns the resulted vector.
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Subtracts ''vectorB'' from ''vectorA'' and returns the resulting vector. Can also be used by writing vectorA - vectorB.</td></tr>
−
|-
+
 
−
|vectorA.sub(vectorB)
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[vectorA:mul]]({{type|number}} n)</td>
−
|Subtracts vectorB to vectorA and returns the resulted vector.
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Scalar multiplies ''vectorA'' with ''n'' and returns the resulting vector. Can also be used by writing vectorA * n.</td></tr>
−
|-
+
 
−
|vectorA.mul(vectorB)
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[vectorA:dot]]([[Vector (API)|vector]] vectorB)</td>
−
|Multiplies vectorB with vectorA and returns the resulted vector.
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the dot product of ''vectorA'' and ''vectorB''.</td></tr>
−
|-
+
 
−
|vectorA.dot(vectorB)
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[vectorA:cross]]([[Vector (API)|vector]] vectorB)</td>
−
|Returns the dot product of vectorA and vectorB.
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the vector which resulted in the cross product of ''vectorA'' and ''vectorB''.</td></tr>
−
|-
+
 
−
|vectorA.cross(vectorB)
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[vectorA:length]]()</td>
−
|Returns the vector which resulted in the cross product of vectorA and vectorB.
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the vector's length.</td></tr>
−
|-
+
 
−
|vectorA.length()
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[vectorA:normalize]]()</td>
−
|Returns the vector's length.
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Normalizes the vector and returns the result as a new vector.</td></tr>
−
|-
+
 
−
|vectorA.normalize()
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[vectorA:round]]()</td>
−
|Normalizes the vector and returns the result as a new vector.
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Rounds the vector coordinates to the nearest integers and returns the result as a new vector.</td></tr>
−
|-
+
 
−
|vectorA.round()
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[vectorA:tostring]]()</td>
−
|Rounds the vector coordinates to the nearest integers and returns the result as a new vector.
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a string representation of the vector in the form of "x,y,z".</td></tr>
−
|-
+
</table>
−
|vectorA.tostring()
+
−
|Returns a string representation of the vector in the form of "x,y,z".
+
−
|}
+
  
 
[[Category:APIs]]
 
[[Category:APIs]]
 +
 +
 +
Vectors act much like tables, storing the coordinate data with labels "x", "y" and "z".  However, it can be worthwhile to use vectors instead of tables in certain situations.
 +
 +
 +
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())
 +
 +
Then, getting the displacements between a turtle position and a desired location becomes:
 +
local b = vector.new(20, 85, 40)
 +
local c = a - b
 +
--displacement in the x direction:  c.x
 +
--displacement in the y direction:  c.y
 +
--displacement in the z direction:  c.z
 +
 +
By making use of vectors, code can be cleaner and easier to follow.

Latest revision as of 13:26, 18 July 2013

The vector API provides methods to create and manipulate vectors.

An introduction to vectors can be found on Wikipedia.

Grid disk.png   Vector (API)

Method NameDescription
vector.new(number x, number y, number 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(number 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".


Vectors act much like tables, storing the coordinate data with labels "x", "y" and "z". However, it can be worthwhile to use vectors instead of tables in certain situations.


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())

Then, getting the displacements between a turtle position and a desired location becomes: 

local b = vector.new(20, 85, 40)
local c = a - b
--displacement in the x direction:  c.x
--displacement in the y direction:  c.y
--displacement in the z direction:  c.z

By making use of vectors, code can be cleaner and easier to follow.

Retrieved from "https://www.computercraft.info/wiki/index.php?title=Vector_(API)&oldid=5865"