User Tools

Site Tools


hpl3:community:scripting:classes:cvector2f

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
hpl3:community:scripting:classes:cvector2f [2015/11/06 03:21]
abion47 [Fields]
hpl3:community:scripting:classes:cvector2f [2015/11/06 03:38] (current)
abion47 [Remarks]
Line 10: Line 10:
  
 ^ Return Type ^ Function Name ^ Parameters ^ Description ^ ^ Return Type ^ Function Name ^ Parameters ^ Description ^
-| float | GetElement | uint64 alIdx, \\ const |   ​+| float | GetElement | uint64 alIdx, \\ const | Gets the value at the given index. (Indices 0 and 1 are equal to x and y, respectively.) ​
-| void | SetElement | uint64 alIdx, \\ float, \\ const |   ​+| void | SetElement | uint64 alIdx, \\ float afVal, \\ const | Sets the value at the given index to the given value. (Indices 0 and 1 are equal to x and y, respectively.) ​
-| float | SqrLength | const |   ​+| float | SqrLength | const | Returns the length-squared of this vector. ​
-| float | Length | const |   ​+| float | Length | const | Returns the length of this vector. ​
-| float | Normalize |     ​| ​  ​|+| float | Normalize |     ​| ​Returns the normalization factor for this vector. (See Remarks.) ​|
  
 ====Remarks==== ====Remarks====
  
-Have some helpful descriptions to add to this class? Edit this page and add your insight ​to the Wiki!+A normalized vector is a vector whose length is equal to one, otherwise known as a unit vector. To convert a vector into a unit vector, get the normalization factor by calling the ''​Normalize''​ function, then divide each of the vector'​s x and y coordinates by that factor.
  
 +<​code=c++>​cVector2f vBaseVector(2.0,​ 5.0);
 +float fNormFactor = vBaseVector.Normalize();​
 +cVector2f vNormalizedVector(vBaseVector.x / fNormFactor, ​
 +                            vBaseVector.y / fNormFactor);</​code>​
hpl3/community/scripting/classes/cvector2f.1446780116.txt.gz · Last modified: 2015/11/06 03:21 by abion47