mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API documentation

Browse Source
This commit is contained in:
Christophe Riccio
2016-09-11 12:44:33 +02:00
parent 9f0110f5b0
commit 454d480ceb
395 changed files with 58950 additions and 58068 deletions
Download Patch File Download Diff File Expand all files Collapse all files

104
doc/api/a00223.html
View File

@@ -4,7 +4,7 @@
<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.10"/>
<title>0.9.7: GLM_GTX_projection</title>
<title>0.9.8: GLM_GTX_rotate_normalized_axis</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>
@@ -18,7 +18,7 @@
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">0.9.7
<div id="projectname">0.9.8
</div>
</td>
</tr>
@@ -39,35 +39,44 @@
<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="a00161.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_rotate_normalized_axis<div class="ingroups"><a class="el" href="a00155.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:gadf29123bcf748fc9d6fb0998192184cf"><td class="memTemplParams" colspan="2">template&lt;typename vecType &gt; </td></tr>
<tr class="memitem:gadf29123bcf748fc9d6fb0998192184cf"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00223.html#gadf29123bcf748fc9d6fb0998192184cf">proj</a> (vecType const &amp;x, vecType const &amp;Normal)</td></tr>
<tr class="separator:gadf29123bcf748fc9d6fb0998192184cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaada623964a895def5a8b77b5b7887dc4"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gaada623964a895def5a8b77b5b7887dc4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00223.html#gaada623964a895def5a8b77b5b7887dc4">rotateNormalizedAxis</a> (tmat4x4&lt; T, P &gt; const &amp;m, T const &amp;angle, tvec3&lt; T, P &gt; const &amp;axis)</td></tr>
<tr class="separator:gaada623964a895def5a8b77b5b7887dc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6c00234d844faef36a6a94669fbd1639"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga6c00234d844faef36a6a94669fbd1639"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tquat&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00223.html#ga6c00234d844faef36a6a94669fbd1639">rotateNormalizedAxis</a> (tquat&lt; T, P &gt; const &amp;q, T const &amp;angle, tvec3&lt; T, P &gt; const &amp;axis)</td></tr>
<tr class="separator:ga6c00234d844faef36a6a94669fbd1639"><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="a00093.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/projection.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Quaternions and matrices rotations around normalized axis. </p>
<p>&lt;<a class="el" href="a00093.html" title="GLM_GTX_rotate_normalized_axis ">glm/gtx/rotate_normalized_axis.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gadf29123bcf748fc9d6fb0998192184cf"></a>
<a class="anchor" id="gaada623964a895def5a8b77b5b7887dc4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vecType glm::proj </td>
<td class="memname">GLM_FUNC_DECL tmat4x4&lt;T, P&gt; glm::rotateNormalizedAxis </td>
<td>(</td>
<td class="paramtype">vecType const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
<td class="paramtype">tmat4x4&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vecType const &amp;&#160;</td>
<td class="paramname"><em>Normal</em>&#160;</td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>axis</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -77,8 +86,71 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Projects x on Normal. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00223.html" title="Projection of a vector to other one. ">GLM_GTX_projection</a> </dd></dl>
<p>Builds a rotation 4 * 4 matrix created from a normalized axis and an angle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">m</td><td>Input matrix multiplied by this rotation matrix. </td></tr>
<tr><td class="paramname">angle</td><td>Rotation angle expressed in radians if GLM_FORCE_RADIANS is define or degrees otherwise. </td></tr>
<tr><td class="paramname">axis</td><td>Rotation axis, must be normalized. </td></tr>
</table>
</dd>
</dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Value type used to build the matrix. Currently supported: half (not recommanded), float or double.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00223.html" title="Quaternions and matrices rotations around normalized axis. ">GLM_GTX_rotate_normalized_axis</a> </dd>
<dd>
- rotate(T angle, T x, T y, T z) </dd>
<dd>
- rotate(tmat4x4&lt;T, P&gt; const &amp; m, T angle, T x, T y, T z) </dd>
<dd>
- rotate(T angle, tvec3&lt;T, P&gt; const &amp; v) </dd></dl>
</div>
</div>
<a class="anchor" id="ga6c00234d844faef36a6a94669fbd1639"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tquat&lt;T, P&gt; glm::rotateNormalizedAxis </td>
<td>(</td>
<td class="paramtype">tquat&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>q</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>axis</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotates a quaternion from a vector of 3 components normalized axis and an angle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">q</td><td>Source orientation </td></tr>
<tr><td class="paramname">angle</td><td>Angle expressed in radians if GLM_FORCE_RADIANS is define or degrees otherwise. </td></tr>
<tr><td class="paramname">axis</td><td>Normalized axis of the rotation, must be normalized.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00223.html" title="Quaternions and matrices rotations around normalized axis. ">GLM_GTX_rotate_normalized_axis</a> </dd></dl>
</div>
</div>