<!-- HTML header for doxygen 1.8.9.1--> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.9.1"/> <title>MinGfx Toolkit: mingfx::Vector2 Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <script type="text/x-mathjax-config"> MathJax.Hub.Config({ extensions: ["tex2jax.js"], jax: ["input/TeX","output/HTML-CSS"], }); </script> <script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="customdoxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">MinGfx Toolkit  <span id="projectnumber">1.0</span> </div> <div id="projectbrief">A minimal library for writing cross-platform (Windows, OSX, linux) graphics programs.</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.9.1 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */</script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespacemingfx.html">mingfx</a></li><li class="navelem"><a class="el" href="classmingfx_1_1_vector2.html">Vector2</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="classmingfx_1_1_vector2-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">mingfx::Vector2 Class Reference</div> </div> </div><!--header--> <div class="contents"> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>A 2D Vector with floating point coordinates, used for storing 2D translations, mouse movements, and screen-space vectors. </p> <p class="definition">Definition at line <a class="el" href="vector2_8h_source.html#l00028">28</a> of file <a class="el" href="vector2_8h_source.html">vector2.h</a>.</p> </div> <p><code>#include <<a class="el" href="vector2_8h_source.html">vector2.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a962433a7e3158cf6b224604a0463852f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#a962433a7e3158cf6b224604a0463852f">Vector2</a> ()</td></tr> <tr class="memdesc:a962433a7e3158cf6b224604a0463852f"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor to create zero vector. <a href="classmingfx_1_1_vector2.html#a962433a7e3158cf6b224604a0463852f">More...</a><br /></td></tr> <tr class="separator:a962433a7e3158cf6b224604a0463852f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acc16337b6b06ebea2fde4c4bd1be7abd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#acc16337b6b06ebea2fde4c4bd1be7abd">Vector2</a> (float <a class="el" href="classmingfx_1_1_vector2.html#ae84b079eb21494bc7c9a93d32a63712a">x</a>, float <a class="el" href="classmingfx_1_1_vector2.html#ac427d5c06474777e851bed05ec5d134b">y</a>)</td></tr> <tr class="memdesc:acc16337b6b06ebea2fde4c4bd1be7abd"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a vector (x,y,0), where the 0 comes from the use of homogeneous coordinates in computer graphics. <a href="classmingfx_1_1_vector2.html#acc16337b6b06ebea2fde4c4bd1be7abd">More...</a><br /></td></tr> <tr class="separator:acc16337b6b06ebea2fde4c4bd1be7abd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6e3d063a7080bfe199acc70cd5afded2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#a6e3d063a7080bfe199acc70cd5afded2">Vector2</a> (float *v)</td></tr> <tr class="memdesc:a6e3d063a7080bfe199acc70cd5afded2"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a vector given a pointer to x,y,z data. <a href="classmingfx_1_1_vector2.html#a6e3d063a7080bfe199acc70cd5afded2">More...</a><br /></td></tr> <tr class="separator:a6e3d063a7080bfe199acc70cd5afded2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a40f53939581f5d06a1b757b0398525f8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#a40f53939581f5d06a1b757b0398525f8">Vector2</a> (const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> &v)</td></tr> <tr class="memdesc:a40f53939581f5d06a1b757b0398525f8"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor for vector. <a href="classmingfx_1_1_vector2.html#a40f53939581f5d06a1b757b0398525f8">More...</a><br /></td></tr> <tr class="separator:a40f53939581f5d06a1b757b0398525f8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac49b009c4b6052ebe71d5cf4ce241b1f"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#ac49b009c4b6052ebe71d5cf4ce241b1f">~Vector2</a> ()</td></tr> <tr class="memdesc:ac49b009c4b6052ebe71d5cf4ce241b1f"><td class="mdescLeft"> </td><td class="mdescRight">Vector destructor. <a href="classmingfx_1_1_vector2.html#ac49b009c4b6052ebe71d5cf4ce241b1f">More...</a><br /></td></tr> <tr class="separator:ac49b009c4b6052ebe71d5cf4ce241b1f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad7acc2cf4dcd2eca210899c846bb7dfe"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#ad7acc2cf4dcd2eca210899c846bb7dfe">operator==</a> (const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> &v) const</td></tr> <tr class="memdesc:ad7acc2cf4dcd2eca210899c846bb7dfe"><td class="mdescLeft"> </td><td class="mdescRight">Check for "equality", taking floating point imprecision into account. <a href="classmingfx_1_1_vector2.html#ad7acc2cf4dcd2eca210899c846bb7dfe">More...</a><br /></td></tr> <tr class="separator:ad7acc2cf4dcd2eca210899c846bb7dfe"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1cf3488f1f14a9bf7f6e1278c1c63cdb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#a1cf3488f1f14a9bf7f6e1278c1c63cdb">operator!=</a> (const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> &v) const</td></tr> <tr class="memdesc:a1cf3488f1f14a9bf7f6e1278c1c63cdb"><td class="mdescLeft"> </td><td class="mdescRight">Check for "inequality", taking floating point imprecision into account. <a href="classmingfx_1_1_vector2.html#a1cf3488f1f14a9bf7f6e1278c1c63cdb">More...</a><br /></td></tr> <tr class="separator:a1cf3488f1f14a9bf7f6e1278c1c63cdb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a28c44a323e5bd1a251dee9e00e2e1769"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#a28c44a323e5bd1a251dee9e00e2e1769">operator=</a> (const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> &v)</td></tr> <tr class="memdesc:a28c44a323e5bd1a251dee9e00e2e1769"><td class="mdescLeft"> </td><td class="mdescRight">Vector assignment operator. <a href="classmingfx_1_1_vector2.html#a28c44a323e5bd1a251dee9e00e2e1769">More...</a><br /></td></tr> <tr class="separator:a28c44a323e5bd1a251dee9e00e2e1769"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae1fc0ce3ca1af3d0546af32742e13000"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#ae1fc0ce3ca1af3d0546af32742e13000">operator[]</a> (const int i) const</td></tr> <tr class="memdesc:ae1fc0ce3ca1af3d0546af32742e13000"><td class="mdescLeft"> </td><td class="mdescRight">Read only access to the ith coordinate of the vector. <a href="classmingfx_1_1_vector2.html#ae1fc0ce3ca1af3d0546af32742e13000">More...</a><br /></td></tr> <tr class="separator:ae1fc0ce3ca1af3d0546af32742e13000"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a93acf7f4f150cfe53859e31d90eddd1e"><td class="memItemLeft" align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#a93acf7f4f150cfe53859e31d90eddd1e">operator[]</a> (const int i)</td></tr> <tr class="memdesc:a93acf7f4f150cfe53859e31d90eddd1e"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to the ith coordinate of the vector. Use this accessor if you wish to set the coordinate rather than just request its value. Example: <a href="classmingfx_1_1_vector2.html#a93acf7f4f150cfe53859e31d90eddd1e">More...</a><br /></td></tr> <tr class="separator:a93acf7f4f150cfe53859e31d90eddd1e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae84b079eb21494bc7c9a93d32a63712a"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#ae84b079eb21494bc7c9a93d32a63712a">x</a> () const</td></tr> <tr class="memdesc:ae84b079eb21494bc7c9a93d32a63712a"><td class="mdescLeft"> </td><td class="mdescRight">Read only access to the x coordinate. Can also use my_vector[0]. Use the my_vector[0] = 1.0; form if you need to set the value. <a href="classmingfx_1_1_vector2.html#ae84b079eb21494bc7c9a93d32a63712a">More...</a><br /></td></tr> <tr class="separator:ae84b079eb21494bc7c9a93d32a63712a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac427d5c06474777e851bed05ec5d134b"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#ac427d5c06474777e851bed05ec5d134b">y</a> () const</td></tr> <tr class="memdesc:ac427d5c06474777e851bed05ec5d134b"><td class="mdescLeft"> </td><td class="mdescRight">Read only access to the y coordinate. Can also use my_vector[1]. Use the my_vector[1] = 1.0; form if you need to set the value. <a href="classmingfx_1_1_vector2.html#ac427d5c06474777e851bed05ec5d134b">More...</a><br /></td></tr> <tr class="separator:ac427d5c06474777e851bed05ec5d134b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a267e6749091f23263d1620f801f0a831"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#a267e6749091f23263d1620f801f0a831">w</a> () const</td></tr> <tr class="memdesc:a267e6749091f23263d1620f801f0a831"><td class="mdescLeft"> </td><td class="mdescRight">In homogeneous coordinates, the w coordinate for all vectors is 0.0. <a href="classmingfx_1_1_vector2.html#a267e6749091f23263d1620f801f0a831">More...</a><br /></td></tr> <tr class="separator:a267e6749091f23263d1620f801f0a831"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae2208539c6b29712c22f557dcfdd55d9"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#ae2208539c6b29712c22f557dcfdd55d9">Dot</a> (const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> &v) const</td></tr> <tr class="memdesc:ae2208539c6b29712c22f557dcfdd55d9"><td class="mdescLeft"> </td><td class="mdescRight">Returns "this dot v". <a href="classmingfx_1_1_vector2.html#ae2208539c6b29712c22f557dcfdd55d9">More...</a><br /></td></tr> <tr class="separator:ae2208539c6b29712c22f557dcfdd55d9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a71b90903d00cdc318ea42f593db6dbb9"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#a71b90903d00cdc318ea42f593db6dbb9">Length</a> () const</td></tr> <tr class="memdesc:a71b90903d00cdc318ea42f593db6dbb9"><td class="mdescLeft"> </td><td class="mdescRight">Returns the length of the vector. <a href="classmingfx_1_1_vector2.html#a71b90903d00cdc318ea42f593db6dbb9">More...</a><br /></td></tr> <tr class="separator:a71b90903d00cdc318ea42f593db6dbb9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a632ddd5b06c48fa0f6f39550e91082c0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#a632ddd5b06c48fa0f6f39550e91082c0">Normalize</a> ()</td></tr> <tr class="memdesc:a632ddd5b06c48fa0f6f39550e91082c0"><td class="mdescLeft"> </td><td class="mdescRight">Normalizes the vector by making it unit length. <a href="classmingfx_1_1_vector2.html#a632ddd5b06c48fa0f6f39550e91082c0">More...</a><br /></td></tr> <tr class="separator:a632ddd5b06c48fa0f6f39550e91082c0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a70f9f612a99017bf051e40ebd7fa7f83"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#a70f9f612a99017bf051e40ebd7fa7f83">ToUnit</a> () const</td></tr> <tr class="memdesc:a70f9f612a99017bf051e40ebd7fa7f83"><td class="mdescLeft"> </td><td class="mdescRight">Returns a normalized (i.e., unit length) version of the vector without modifying the original ('this') vector. <a href="classmingfx_1_1_vector2.html#a70f9f612a99017bf051e40ebd7fa7f83">More...</a><br /></td></tr> <tr class="separator:a70f9f612a99017bf051e40ebd7fa7f83"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5813ffa3c185551eec1927e1daa4cb17"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#a5813ffa3c185551eec1927e1daa4cb17">Lerp</a> (const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> &b, float alpha) const</td></tr> <tr class="memdesc:a5813ffa3c185551eec1927e1daa4cb17"><td class="mdescLeft"> </td><td class="mdescRight">Linear interpolation between this vector and another. Alpha=0.0 returns this vector, and alpha=1.0 returns the other vector, other values blend between the two. <a href="classmingfx_1_1_vector2.html#a5813ffa3c185551eec1927e1daa4cb17">More...</a><br /></td></tr> <tr class="separator:a5813ffa3c185551eec1927e1daa4cb17"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a80ef53519d50a6a6f158f66755c040d1"><td class="memItemLeft" align="right" valign="top">const float * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#a80ef53519d50a6a6f158f66755c040d1">value_ptr</a> () const</td></tr> <tr class="memdesc:a80ef53519d50a6a6f158f66755c040d1"><td class="mdescLeft"> </td><td class="mdescRight">Returns a const pointer to the raw data array. <a href="classmingfx_1_1_vector2.html#a80ef53519d50a6a6f158f66755c040d1">More...</a><br /></td></tr> <tr class="separator:a80ef53519d50a6a6f158f66755c040d1"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:a06d6c283aba957bddc2b9849698838b2"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#a06d6c283aba957bddc2b9849698838b2">Normalize</a> (const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> &v)</td></tr> <tr class="memdesc:a06d6c283aba957bddc2b9849698838b2"><td class="mdescLeft"> </td><td class="mdescRight">Returns a new vector that is the unit version of v. <a href="classmingfx_1_1_vector2.html#a06d6c283aba957bddc2b9849698838b2">More...</a><br /></td></tr> <tr class="separator:a06d6c283aba957bddc2b9849698838b2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9e81c518908ca06c98ba099b075fe1cd"><td class="memItemLeft" align="right" valign="top">static float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#a9e81c518908ca06c98ba099b075fe1cd">Dot</a> (const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> &v1, const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> &v2)</td></tr> <tr class="memdesc:a9e81c518908ca06c98ba099b075fe1cd"><td class="mdescLeft"> </td><td class="mdescRight">Returns v1 dot v2. <a href="classmingfx_1_1_vector2.html#a9e81c518908ca06c98ba099b075fe1cd">More...</a><br /></td></tr> <tr class="separator:a9e81c518908ca06c98ba099b075fe1cd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7cb11f9fe8962ff9092fc1e5736faacf"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#a7cb11f9fe8962ff9092fc1e5736faacf">Zero</a> ()</td></tr> <tr class="memdesc:a7cb11f9fe8962ff9092fc1e5736faacf"><td class="mdescLeft"> </td><td class="mdescRight">(0,0) - a shortcut for a special vector that is frequently needed <a href="classmingfx_1_1_vector2.html#a7cb11f9fe8962ff9092fc1e5736faacf">More...</a><br /></td></tr> <tr class="separator:a7cb11f9fe8962ff9092fc1e5736faacf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5b51e62f03e95d6be1262f037aecf0fd"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#a5b51e62f03e95d6be1262f037aecf0fd">One</a> ()</td></tr> <tr class="memdesc:a5b51e62f03e95d6be1262f037aecf0fd"><td class="mdescLeft"> </td><td class="mdescRight">(1,1) - a shortcut for a special vector that is frequently needed <a href="classmingfx_1_1_vector2.html#a5b51e62f03e95d6be1262f037aecf0fd">More...</a><br /></td></tr> <tr class="separator:a5b51e62f03e95d6be1262f037aecf0fd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8ef6e0525ec34aaee9cf35bab098ecdb"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#a8ef6e0525ec34aaee9cf35bab098ecdb">UnitX</a> ()</td></tr> <tr class="memdesc:a8ef6e0525ec34aaee9cf35bab098ecdb"><td class="mdescLeft"> </td><td class="mdescRight">(1,0) - a shortcut for a special vector that is frequently needed <a href="classmingfx_1_1_vector2.html#a8ef6e0525ec34aaee9cf35bab098ecdb">More...</a><br /></td></tr> <tr class="separator:a8ef6e0525ec34aaee9cf35bab098ecdb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab7b3ba42a5a63c512bd7b32fd4cc0db0"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#ab7b3ba42a5a63c512bd7b32fd4cc0db0">UnitY</a> ()</td></tr> <tr class="memdesc:ab7b3ba42a5a63c512bd7b32fd4cc0db0"><td class="mdescLeft"> </td><td class="mdescRight">(0,1) - a shortcut for a special vector that is frequently needed <a href="classmingfx_1_1_vector2.html#ab7b3ba42a5a63c512bd7b32fd4cc0db0">More...</a><br /></td></tr> <tr class="separator:ab7b3ba42a5a63c512bd7b32fd4cc0db0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac332b5f01b3357b85e6d279fb059d561"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_vector2.html#ac332b5f01b3357b85e6d279fb059d561">Lerp</a> (const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> &a, const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> &b, float alpha)</td></tr> <tr class="memdesc:ac332b5f01b3357b85e6d279fb059d561"><td class="mdescLeft"> </td><td class="mdescRight">Linear interpolation between two vectors. Alpha=0.0 returns 'a' and alpha=1.0 returns 'b', other values blend between the two. <a href="classmingfx_1_1_vector2.html#ac332b5f01b3357b85e6d279fb059d561">More...</a><br /></td></tr> <tr class="separator:ac332b5f01b3357b85e6d279fb059d561"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a962433a7e3158cf6b224604a0463852f"></a> <h2 class="memtitle"><span class="permalink"><a href="#a962433a7e3158cf6b224604a0463852f">◆ </a></span>Vector2() <span class="overload">[1/4]</span></h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">mingfx::Vector2::Vector2 </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Default constructor to create zero vector. </p> </div> </div> <a id="acc16337b6b06ebea2fde4c4bd1be7abd"></a> <h2 class="memtitle"><span class="permalink"><a href="#acc16337b6b06ebea2fde4c4bd1be7abd">◆ </a></span>Vector2() <span class="overload">[2/4]</span></h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">mingfx::Vector2::Vector2 </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"><em>x</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>y</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Constructs a vector (x,y,0), where the 0 comes from the use of homogeneous coordinates in computer graphics. </p> </div> </div> <a id="a6e3d063a7080bfe199acc70cd5afded2"></a> <h2 class="memtitle"><span class="permalink"><a href="#a6e3d063a7080bfe199acc70cd5afded2">◆ </a></span>Vector2() <span class="overload">[3/4]</span></h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">mingfx::Vector2::Vector2 </td> <td>(</td> <td class="paramtype">float * </td> <td class="paramname"><em>v</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Constructs a vector given a pointer to x,y,z data. </p> </div> </div> <a id="a40f53939581f5d06a1b757b0398525f8"></a> <h2 class="memtitle"><span class="permalink"><a href="#a40f53939581f5d06a1b757b0398525f8">◆ </a></span>Vector2() <span class="overload">[4/4]</span></h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">mingfx::Vector2::Vector2 </td> <td>(</td> <td class="paramtype">const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> & </td> <td class="paramname"><em>v</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Copy constructor for vector. </p> </div> </div> <a id="ac49b009c4b6052ebe71d5cf4ce241b1f"></a> <h2 class="memtitle"><span class="permalink"><a href="#ac49b009c4b6052ebe71d5cf4ce241b1f">◆ </a></span>~Vector2()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual mingfx::Vector2::~Vector2 </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Vector destructor. </p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a id="ae2208539c6b29712c22f557dcfdd55d9"></a> <h2 class="memtitle"><span class="permalink"><a href="#ae2208539c6b29712c22f557dcfdd55d9">◆ </a></span>Dot() <span class="overload">[1/2]</span></h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float mingfx::Vector2::Dot </td> <td>(</td> <td class="paramtype">const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> & </td> <td class="paramname"><em>v</em></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns "this dot v". </p> </div> </div> <a id="a9e81c518908ca06c98ba099b075fe1cd"></a> <h2 class="memtitle"><span class="permalink"><a href="#a9e81c518908ca06c98ba099b075fe1cd">◆ </a></span>Dot() <span class="overload">[2/2]</span></h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static float mingfx::Vector2::Dot </td> <td>(</td> <td class="paramtype">const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> & </td> <td class="paramname"><em>v1</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> & </td> <td class="paramname"><em>v2</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns v1 dot v2. </p> </div> </div> <a id="a71b90903d00cdc318ea42f593db6dbb9"></a> <h2 class="memtitle"><span class="permalink"><a href="#a71b90903d00cdc318ea42f593db6dbb9">◆ </a></span>Length()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float mingfx::Vector2::Length </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns the length of the vector. </p> </div> </div> <a id="ac332b5f01b3357b85e6d279fb059d561"></a> <h2 class="memtitle"><span class="permalink"><a href="#ac332b5f01b3357b85e6d279fb059d561">◆ </a></span>Lerp() <span class="overload">[1/2]</span></h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> mingfx::Vector2::Lerp </td> <td>(</td> <td class="paramtype">const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> & </td> <td class="paramname"><em>a</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> & </td> <td class="paramname"><em>b</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>alpha</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Linear interpolation between two vectors. Alpha=0.0 returns 'a' and alpha=1.0 returns 'b', other values blend between the two. </p> </div> </div> <a id="a5813ffa3c185551eec1927e1daa4cb17"></a> <h2 class="memtitle"><span class="permalink"><a href="#a5813ffa3c185551eec1927e1daa4cb17">◆ </a></span>Lerp() <span class="overload">[2/2]</span></h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> mingfx::Vector2::Lerp </td> <td>(</td> <td class="paramtype">const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> & </td> <td class="paramname"><em>b</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>alpha</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</td> </tr> </table> </div><div class="memdoc"> <p>Linear interpolation between this vector and another. Alpha=0.0 returns this vector, and alpha=1.0 returns the other vector, other values blend between the two. </p> </div> </div> <a id="a632ddd5b06c48fa0f6f39550e91082c0"></a> <h2 class="memtitle"><span class="permalink"><a href="#a632ddd5b06c48fa0f6f39550e91082c0">◆ </a></span>Normalize() <span class="overload">[1/2]</span></h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mingfx::Vector2::Normalize </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Normalizes the vector by making it unit length. </p> </div> </div> <a id="a06d6c283aba957bddc2b9849698838b2"></a> <h2 class="memtitle"><span class="permalink"><a href="#a06d6c283aba957bddc2b9849698838b2">◆ </a></span>Normalize() <span class="overload">[2/2]</span></h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> mingfx::Vector2::Normalize </td> <td>(</td> <td class="paramtype">const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> & </td> <td class="paramname"><em>v</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns a new vector that is the unit version of v. </p> </div> </div> <a id="a5b51e62f03e95d6be1262f037aecf0fd"></a> <h2 class="memtitle"><span class="permalink"><a href="#a5b51e62f03e95d6be1262f037aecf0fd">◆ </a></span>One()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a>& mingfx::Vector2::One </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>(1,1) - a shortcut for a special vector that is frequently needed </p> </div> </div> <a id="a1cf3488f1f14a9bf7f6e1278c1c63cdb"></a> <h2 class="memtitle"><span class="permalink"><a href="#a1cf3488f1f14a9bf7f6e1278c1c63cdb">◆ </a></span>operator!=()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool mingfx::Vector2::operator!= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> & </td> <td class="paramname"><em>v</em></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Check for "inequality", taking floating point imprecision into account. </p> </div> </div> <a id="a28c44a323e5bd1a251dee9e00e2e1769"></a> <h2 class="memtitle"><span class="permalink"><a href="#a28c44a323e5bd1a251dee9e00e2e1769">◆ </a></span>operator=()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classmingfx_1_1_vector2.html">Vector2</a>& mingfx::Vector2::operator= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> & </td> <td class="paramname"><em>v</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Vector assignment operator. </p> </div> </div> <a id="ad7acc2cf4dcd2eca210899c846bb7dfe"></a> <h2 class="memtitle"><span class="permalink"><a href="#ad7acc2cf4dcd2eca210899c846bb7dfe">◆ </a></span>operator==()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool mingfx::Vector2::operator== </td> <td>(</td> <td class="paramtype">const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> & </td> <td class="paramname"><em>v</em></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Check for "equality", taking floating point imprecision into account. </p> </div> </div> <a id="a93acf7f4f150cfe53859e31d90eddd1e"></a> <h2 class="memtitle"><span class="permalink"><a href="#a93acf7f4f150cfe53859e31d90eddd1e">◆ </a></span>operator[]() <span class="overload">[1/2]</span></h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float& mingfx::Vector2::operator[] </td> <td>(</td> <td class="paramtype">const int </td> <td class="paramname"><em>i</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Returns a reference to the ith coordinate of the vector. Use this accessor if you wish to set the coordinate rather than just request its value. Example: </p> <div class="fragment"><div class="line"><a class="code" href="classmingfx_1_1_vector2.html#a962433a7e3158cf6b224604a0463852f">Vector2</a> a;</div> <div class="line">a[0] = 5.0; <span class="comment">// set the x-coordinate of the vector</span></div> <div class="ttc" id="aclassmingfx_1_1_vector2_html_a962433a7e3158cf6b224604a0463852f"><div class="ttname"><a href="classmingfx_1_1_vector2.html#a962433a7e3158cf6b224604a0463852f">mingfx::Vector2::Vector2</a></div><div class="ttdeci">Vector2()</div><div class="ttdoc">Default constructor to create zero vector.</div></div> </div><!-- fragment --> </div> </div> <a id="ae1fc0ce3ca1af3d0546af32742e13000"></a> <h2 class="memtitle"><span class="permalink"><a href="#ae1fc0ce3ca1af3d0546af32742e13000">◆ </a></span>operator[]() <span class="overload">[2/2]</span></h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float mingfx::Vector2::operator[] </td> <td>(</td> <td class="paramtype">const int </td> <td class="paramname"><em>i</em></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Read only access to the ith coordinate of the vector. </p> </div> </div> <a id="a70f9f612a99017bf051e40ebd7fa7f83"></a> <h2 class="memtitle"><span class="permalink"><a href="#a70f9f612a99017bf051e40ebd7fa7f83">◆ </a></span>ToUnit()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> mingfx::Vector2::ToUnit </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns a normalized (i.e., unit length) version of the vector without modifying the original ('this') vector. </p> </div> </div> <a id="a8ef6e0525ec34aaee9cf35bab098ecdb"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8ef6e0525ec34aaee9cf35bab098ecdb">◆ </a></span>UnitX()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a>& mingfx::Vector2::UnitX </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>(1,0) - a shortcut for a special vector that is frequently needed </p> </div> </div> <a id="ab7b3ba42a5a63c512bd7b32fd4cc0db0"></a> <h2 class="memtitle"><span class="permalink"><a href="#ab7b3ba42a5a63c512bd7b32fd4cc0db0">◆ </a></span>UnitY()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a>& mingfx::Vector2::UnitY </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>(0,1) - a shortcut for a special vector that is frequently needed </p> </div> </div> <a id="a80ef53519d50a6a6f158f66755c040d1"></a> <h2 class="memtitle"><span class="permalink"><a href="#a80ef53519d50a6a6f158f66755c040d1">◆ </a></span>value_ptr()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const float* mingfx::Vector2::value_ptr </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns a const pointer to the raw data array. </p> </div> </div> <a id="a267e6749091f23263d1620f801f0a831"></a> <h2 class="memtitle"><span class="permalink"><a href="#a267e6749091f23263d1620f801f0a831">◆ </a></span>w()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">float mingfx::Vector2::w </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>In homogeneous coordinates, the w coordinate for all vectors is 0.0. </p> <p class="definition">Definition at line <a class="el" href="vector2_8h_source.html#l00077">77</a> of file <a class="el" href="vector2_8h_source.html">vector2.h</a>.</p> </div> </div> <a id="ae84b079eb21494bc7c9a93d32a63712a"></a> <h2 class="memtitle"><span class="permalink"><a href="#ae84b079eb21494bc7c9a93d32a63712a">◆ </a></span>x()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">float mingfx::Vector2::x </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Read only access to the x coordinate. Can also use my_vector[0]. Use the my_vector[0] = 1.0; form if you need to set the value. </p> <p class="definition">Definition at line <a class="el" href="vector2_8h_source.html#l00070">70</a> of file <a class="el" href="vector2_8h_source.html">vector2.h</a>.</p> </div> </div> <a id="ac427d5c06474777e851bed05ec5d134b"></a> <h2 class="memtitle"><span class="permalink"><a href="#ac427d5c06474777e851bed05ec5d134b">◆ </a></span>y()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">float mingfx::Vector2::y </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Read only access to the y coordinate. Can also use my_vector[1]. Use the my_vector[1] = 1.0; form if you need to set the value. </p> <p class="definition">Definition at line <a class="el" href="vector2_8h_source.html#l00074">74</a> of file <a class="el" href="vector2_8h_source.html">vector2.h</a>.</p> </div> </div> <a id="a7cb11f9fe8962ff9092fc1e5736faacf"></a> <h2 class="memtitle"><span class="permalink"><a href="#a7cb11f9fe8962ff9092fc1e5736faacf">◆ </a></span>Zero()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static const <a class="el" href="classmingfx_1_1_vector2.html">Vector2</a>& mingfx::Vector2::Zero </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>(0,0) - a shortcut for a special vector that is frequently needed </p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>src/<a class="el" href="vector2_8h_source.html">vector2.h</a></li> </ul> </div><!-- contents --> <!-- HTML footer for doxygen 1.8.9.1--> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.9.1 </small></address> </body> </html>