Updated doxygen for 0.9.6 API

This commit is contained in:
Christophe Riccio
2014-11-25 01:28:32 +01:00
parent c273be264c
commit 39334f282c
464 changed files with 68872 additions and 70562 deletions

View File

@@ -3,8 +3,8 @@
<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.8.5"/>
<title>GLM: GLM_GTX_projection</title>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>0.9.6: GLM_GTX_polar_coordinates</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>
@@ -16,9 +16,9 @@
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">GLM
&#160;<span id="projectnumber">0.9.5</span>
<div id="projectname">0.9.6
</div>
</td>
</tr>
@@ -26,13 +26,11 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
@@ -41,46 +39,58 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_projection<div class="ingroups"><a class="el" href="a00165.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_polar_coordinates<div class="ingroups"><a class="el" href="a00160.html">GTX Extensions (Experimental)</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga08294223071a96e777de7033cc708439"><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
<tr class="memitem:ga08294223071a96e777de7033cc708439"><td class="memTemplItemLeft" align="right" valign="top">vecType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00221.html#ga08294223071a96e777de7033cc708439">proj</a> (vecType const &amp;x, vecType const &amp;Normal)</td></tr>
<tr class="separator:ga08294223071a96e777de7033cc708439"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga45ece1fbf7260c43e0f873c498202581"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga45ece1fbf7260c43e0f873c498202581"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00221.html#ga45ece1fbf7260c43e0f873c498202581">euclidean</a> (tvec2&lt; T, P &gt; const &amp;polar)</td></tr>
<tr class="separator:ga45ece1fbf7260c43e0f873c498202581"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafcf95a38c780a4ad5ba14c8ac9e522bb"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gafcf95a38c780a4ad5ba14c8ac9e522bb"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00221.html#gafcf95a38c780a4ad5ba14c8ac9e522bb">polar</a> (tvec3&lt; T, P &gt; const &amp;euclidean)</td></tr>
<tr class="separator:gafcf95a38c780a4ad5ba14c8ac9e522bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Projection of a vector to other one. </p>
<p>&lt;<a class="el" href="a00097.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/projection.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Conversion from Euclidean space to polar space and revert. </p>
<p>&lt;<a class="el" href="a00091.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/polar_coordinates.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga08294223071a96e777de7033cc708439"></a>
<a class="anchor" id="ga45ece1fbf7260c43e0f873c498202581"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vecType glm::proj </td>
<td class="memname">GLM_FUNC_DECL tvec3&lt;T, P&gt; glm::euclidean </td>
<td>(</td>
<td class="paramtype">vecType const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td class="paramtype">tvec2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>polar</em></td><td>)</td>
<td></td>
<td class="paramtype">vecType const &amp;&#160;</td>
<td class="paramname"><em>Normal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Projects x on Normal. </p>
<p>From GLM_GTX_projection extension. </p>
<p>Convert Polar to Euclidean coordinates. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00221.html" title="Conversion from Euclidean space to polar space and revert. ">GLM_GTX_polar_coordinates</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gafcf95a38c780a4ad5ba14c8ac9e522bb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tvec3&lt;T, P&gt; glm::polar </td>
<td>(</td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>euclidean</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert Euclidean to Polar coordinates, x is the xz distance, y, the latitude and z the longitude. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00221.html" title="Conversion from Euclidean space to polar space and revert. ">GLM_GTX_polar_coordinates</a> </dd></dl>
</div>
</div>
@@ -89,7 +99,7 @@ Functions</h2></td></tr>
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</a> 1.8.8
</small></address>
</body>
</html>