mewin/glm
1
0
Fork 0
Code Releases Activity

Updated doxygen doncumentation

Browse Source
This commit is contained in:
Christophe Riccio
2012-12-22 14:49:37 +01:00
parent 87a54a52a0
commit b31d1b560c
27 changed files with 1354 additions and 1206 deletions
Download Patch File Download Diff File Expand all files Collapse all files

96
doc/api/a00198.html
View File

@@ -47,9 +47,6 @@ Functions</h2></td></tr>
<tr class="memitem:gacd88ee5f0938469119199bdb216c68a1"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
<tr class="memitem:gacd88ee5f0938469119199bdb216c68a1"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00198.html#gacd88ee5f0938469119199bdb216c68a1">cross</a> (detail::tvec3&lt; valType &gt; const &amp;v, detail::tquat&lt; valType &gt; const &amp;q)</td></tr>
<tr class="separator:gacd88ee5f0938469119199bdb216c68a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaf23d24e27b4e4954d6e0dcf8cc4451c"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
<tr class="memitem:gaaf23d24e27b4e4954d6e0dcf8cc4451c"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00198.html#gaaf23d24e27b4e4954d6e0dcf8cc4451c">eulerAngles</a> (detail::tquat&lt; valType &gt; const &amp;x)</td></tr>
<tr class="separator:gaaf23d24e27b4e4954d6e0dcf8cc4451c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae94ef4f3c0dd37dd65a95de207d1a27a"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
<tr class="memitem:gae94ef4f3c0dd37dd65a95de207d1a27a"><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00198.html#gae94ef4f3c0dd37dd65a95de207d1a27a">exp</a> (detail::tquat&lt; valType &gt; const &amp;q, valType const &amp;exponent)</td></tr>
<tr class="separator:gae94ef4f3c0dd37dd65a95de207d1a27a"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -65,15 +62,9 @@ Functions</h2></td></tr>
<tr class="memitem:ga68d8d03cc87b3980abec4d80534f3d8e"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
<tr class="memitem:ga68d8d03cc87b3980abec4d80534f3d8e"><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00198.html#ga68d8d03cc87b3980abec4d80534f3d8e">log</a> (detail::tquat&lt; valType &gt; const &amp;q)</td></tr>
<tr class="separator:ga68d8d03cc87b3980abec4d80534f3d8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf2a0323dbf6c6fb3f37b445aa899c1c7"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
<tr class="memitem:gaf2a0323dbf6c6fb3f37b445aa899c1c7"><td class="memTemplItemLeft" align="right" valign="top">valType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00198.html#gaf2a0323dbf6c6fb3f37b445aa899c1c7">pitch</a> (detail::tquat&lt; valType &gt; const &amp;x)</td></tr>
<tr class="separator:gaf2a0323dbf6c6fb3f37b445aa899c1c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7765f7d8a3399af25f8bc7956a77c7b2"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
<tr class="memitem:ga7765f7d8a3399af25f8bc7956a77c7b2"><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00198.html#ga7765f7d8a3399af25f8bc7956a77c7b2">pow</a> (detail::tquat&lt; valType &gt; const &amp;x, valType const &amp;y)</td></tr>
<tr class="separator:ga7765f7d8a3399af25f8bc7956a77c7b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7ef4c8c1ce1ca988add2f73392db0a06"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
<tr class="memitem:ga7ef4c8c1ce1ca988add2f73392db0a06"><td class="memTemplItemLeft" align="right" valign="top">valType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00198.html#ga7ef4c8c1ce1ca988add2f73392db0a06">roll</a> (detail::tquat&lt; valType &gt; const &amp;x)</td></tr>
<tr class="separator:ga7ef4c8c1ce1ca988add2f73392db0a06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad1ada3be83514169fed6054b4e68b5ca"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
<tr class="memitem:gad1ada3be83514169fed6054b4e68b5ca"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00198.html#gad1ada3be83514169fed6054b4e68b5ca">rotate</a> (detail::tquat&lt; valType &gt; const &amp;q, detail::tvec3&lt; valType &gt; const &amp;v)</td></tr>
<tr class="separator:gad1ada3be83514169fed6054b4e68b5ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -98,9 +89,6 @@ Functions</h2></td></tr>
<tr class="memitem:ga25b6237ccb6c4a69d57a181aac99aa43"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
<tr class="memitem:ga25b6237ccb6c4a69d57a181aac99aa43"><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00198.html#ga25b6237ccb6c4a69d57a181aac99aa43">toQuat</a> (detail::tmat4x4&lt; valType &gt; const &amp;x)</td></tr>
<tr class="separator:ga25b6237ccb6c4a69d57a181aac99aa43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaac012c1a6bc37ce07a87745d9c596eed"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
<tr class="memitem:gaac012c1a6bc37ce07a87745d9c596eed"><td class="memTemplItemLeft" align="right" valign="top">valType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00198.html#gaac012c1a6bc37ce07a87745d9c596eed">yaw</a> (detail::tquat&lt; valType &gt; const &amp;x)</td></tr>
<tr class="separator:gaac012c1a6bc37ce07a87745d9c596eed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Extented quaternion types and functions. </p>
@@ -162,25 +150,6 @@ Functions</h2></td></tr>
<p>Compute a cross product between a vector and a quaternion. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00198.html" title="Extented quaternion types and functions.">GLM_GTX_quaternion</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaaf23d24e27b4e4954d6e0dcf8cc4451c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec3&lt;valType&gt; glm::eulerAngles </td>
<td>(</td>
<td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns euler angles, yitch as x, yaw as y, roll as z. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00198.html" title="Extented quaternion types and functions.">GLM_GTX_quaternion</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gae94ef4f3c0dd37dd65a95de207d1a27a"></a>
@@ -318,25 +287,6 @@ Functions</h2></td></tr>
<p>Returns a log of a quaternion. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00198.html" title="Extented quaternion types and functions.">GLM_GTX_quaternion</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaf2a0323dbf6c6fb3f37b445aa899c1c7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valType glm::pitch </td>
<td>(</td>
<td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns pitch value of euler angles expressed in radians if GLM_FORCE_RADIANS is define or degrees otherwise. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00198.html" title="Extented quaternion types and functions.">GLM_GTX_quaternion</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga7765f7d8a3399af25f8bc7956a77c7b2"></a>
@@ -366,25 +316,6 @@ Functions</h2></td></tr>
<p>Returns x raised to the y power. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00198.html" title="Extented quaternion types and functions.">GLM_GTX_quaternion</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga7ef4c8c1ce1ca988add2f73392db0a06"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valType glm::roll </td>
<td>(</td>
<td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns roll value of euler angles expressed in radians if GLM_FORCE_RADIANS is define or degrees otherwise. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00198.html" title="Extented quaternion types and functions.">GLM_GTX_quaternion</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gad1ada3be83514169fed6054b4e68b5ca"></a>
@@ -547,7 +478,7 @@ Functions</h2></td></tr>
<p>Converts a quaternion to a 3 * 3 matrix. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00198.html" title="Extented quaternion types and functions.">GLM_GTX_quaternion</a> </dd></dl>
<p>Definition at line <a class="el" href="a00077_source.html#l00177">177</a> of file <a class="el" href="a00077_source.html">gtx/quaternion.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00077_source.html#l00149">149</a> of file <a class="el" href="a00077_source.html">gtx/quaternion.hpp</a>.</p>
<p>References <a class="el" href="a00153.html#gae04ce320008c9bec0037b4ba21853cb5">glm::mat3_cast()</a>.</p>
@@ -570,7 +501,7 @@ Functions</h2></td></tr>
<p>Converts a quaternion to a 4 * 4 matrix. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00198.html" title="Extented quaternion types and functions.">GLM_GTX_quaternion</a> </dd></dl>
<p>Definition at line <a class="el" href="a00077_source.html#l00184">184</a> of file <a class="el" href="a00077_source.html">gtx/quaternion.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00077_source.html#l00156">156</a> of file <a class="el" href="a00077_source.html">gtx/quaternion.hpp</a>.</p>
<p>References <a class="el" href="a00153.html#ga8c376eb15971eb52d85df5ee26825627">glm::mat4_cast()</a>.</p>
@@ -593,7 +524,7 @@ Functions</h2></td></tr>
<p>Converts a 3 * 3 matrix to a quaternion. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00198.html" title="Extented quaternion types and functions.">GLM_GTX_quaternion</a> </dd></dl>
<p>Definition at line <a class="el" href="a00077_source.html#l00191">191</a> of file <a class="el" href="a00077_source.html">gtx/quaternion.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00077_source.html#l00163">163</a> of file <a class="el" href="a00077_source.html">gtx/quaternion.hpp</a>.</p>
<p>References <a class="el" href="a00153.html#ga4d37447d81ceade1d10d68c995a4d881">glm::quat_cast()</a>.</p>
@@ -616,29 +547,10 @@ Functions</h2></td></tr>
<p>Converts a 4 * 4 matrix to a quaternion. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00198.html" title="Extented quaternion types and functions.">GLM_GTX_quaternion</a> </dd></dl>
<p>Definition at line <a class="el" href="a00077_source.html#l00198">198</a> of file <a class="el" href="a00077_source.html">gtx/quaternion.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00077_source.html#l00170">170</a> of file <a class="el" href="a00077_source.html">gtx/quaternion.hpp</a>.</p>
<p>References <a class="el" href="a00153.html#ga4d37447d81ceade1d10d68c995a4d881">glm::quat_cast()</a>.</p>
</div>
</div>
<a class="anchor" id="gaac012c1a6bc37ce07a87745d9c596eed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valType glm::yaw </td>
<td>(</td>
<td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns yaw value of euler angles expressed in radians if GLM_FORCE_RADIANS is define or degrees otherwise. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00198.html" title="Extented quaternion types and functions.">GLM_GTX_quaternion</a> </dd></dl>
</div>
</div>
</div><!-- contents -->