Updated API doc
This commit is contained in:
Christophe Riccio
@@ -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.9 API documenation: GLM_GTX_matrix_interpolation</title>
|
||||
<title>0.9.9 API documenation: 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>
|
||||
@@ -77,151 +77,63 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
<div class="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">GLM_GTX_matrix_interpolation<div class="ingroups"><a class="el" href="a00157.html">GTX Extensions (Experimental)</a></div></div> </div>
|
||||
<div class="title">GLM_GTX_polar_coordinates<div class="ingroups"><a class="el" href="a00148.html">Experimental extensions</a></div></div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Allows to directly interpolate two exiciting matrices.
|
||||
<p>Include <<a class="el" href="a00080.html" title="GLM_GTX_polar_coordinates ">glm/gtx/polar_coordinates.hpp</a>> to use the features of this extension.
|
||||
<a href="#details">More...</a></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr class="memitem:ga8a1bad8efb86c86a3ace904d23863019"><td class="memTemplParams" colspan="2">template<typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga8a1bad8efb86c86a3ace904d23863019"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#ga8a1bad8efb86c86a3ace904d23863019">axisAngle</a> (mat< 4, 4, T, P > const &mat, vec< 3, T, P > &axis, T &angle)</td></tr>
|
||||
<tr class="memdesc:ga8a1bad8efb86c86a3ace904d23863019"><td class="mdescLeft"> </td><td class="mdescRight">Get the axis and angle of the rotation from a matrix. <a href="a00210.html#ga8a1bad8efb86c86a3ace904d23863019">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga8a1bad8efb86c86a3ace904d23863019"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaf4c62093a1e1d61c5d1e0d1e02455cbf"><td class="memTemplParams" colspan="2">template<typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:gaf4c62093a1e1d61c5d1e0d1e02455cbf"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat< 4, 4, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#gaf4c62093a1e1d61c5d1e0d1e02455cbf">axisAngleMatrix</a> (vec< 3, T, P > const &axis, T const angle)</td></tr>
|
||||
<tr class="memdesc:gaf4c62093a1e1d61c5d1e0d1e02455cbf"><td class="mdescLeft"> </td><td class="mdescRight">Build a matrix from axis and angle. <a href="a00210.html#gaf4c62093a1e1d61c5d1e0d1e02455cbf">More...</a><br /></td></tr>
|
||||
<tr class="separator:gaf4c62093a1e1d61c5d1e0d1e02455cbf"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga7d194e86005f40cde677d6d2fadf6205"><td class="memTemplParams" colspan="2">template<typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga7d194e86005f40cde677d6d2fadf6205"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat< 4, 4, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#ga7d194e86005f40cde677d6d2fadf6205">extractMatrixRotation</a> (mat< 4, 4, T, P > const &mat)</td></tr>
|
||||
<tr class="memdesc:ga7d194e86005f40cde677d6d2fadf6205"><td class="mdescLeft"> </td><td class="mdescRight">Extracts the rotation part of a matrix. <a href="a00210.html#ga7d194e86005f40cde677d6d2fadf6205">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga7d194e86005f40cde677d6d2fadf6205"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga8614879ae96ceaf18a4ef1b8ce2bc5aa"><td class="memTemplParams" colspan="2">template<typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga8614879ae96ceaf18a4ef1b8ce2bc5aa"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat< 4, 4, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#ga8614879ae96ceaf18a4ef1b8ce2bc5aa">interpolate</a> (mat< 4, 4, T, P > const &m1, mat< 4, 4, T, P > const &m2, T const delta)</td></tr>
|
||||
<tr class="memdesc:ga8614879ae96ceaf18a4ef1b8ce2bc5aa"><td class="mdescLeft"> </td><td class="mdescRight">Build a interpolation of 4 * 4 matrixes. <a href="a00210.html#ga8614879ae96ceaf18a4ef1b8ce2bc5aa">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga8614879ae96ceaf18a4ef1b8ce2bc5aa"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga1821d5b3324201e60a9e2823d0b5d0c8"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga1821d5b3324201e60a9e2823d0b5d0c8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#ga1821d5b3324201e60a9e2823d0b5d0c8">euclidean</a> (vec< 2, T, Q > const &polar)</td></tr>
|
||||
<tr class="memdesc:ga1821d5b3324201e60a9e2823d0b5d0c8"><td class="mdescLeft"> </td><td class="mdescRight">Convert Polar to Euclidean coordinates. <a href="a00210.html#ga1821d5b3324201e60a9e2823d0b5d0c8">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga1821d5b3324201e60a9e2823d0b5d0c8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gab83ac2c0e55b684b06b6c46c28b1590d"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gab83ac2c0e55b684b06b6c46c28b1590d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#gab83ac2c0e55b684b06b6c46c28b1590d">polar</a> (vec< 3, T, Q > const &euclidean)</td></tr>
|
||||
<tr class="memdesc:gab83ac2c0e55b684b06b6c46c28b1590d"><td class="mdescLeft"> </td><td class="mdescRight">Convert Euclidean to Polar coordinates, x is the xz distance, y, the latitude and z the longitude. <a href="a00210.html#gab83ac2c0e55b684b06b6c46c28b1590d">More...</a><br /></td></tr>
|
||||
<tr class="separator:gab83ac2c0e55b684b06b6c46c28b1590d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Allows to directly interpolate two exiciting matrices. </p>
|
||||
<p><<a class="el" href="a00069.html" title="GLM_GTX_matrix_interpolation ">glm/gtx/matrix_interpolation.hpp</a>> need to be included to use these functionalities. </p>
|
||||
<p>Include <<a class="el" href="a00080.html" title="GLM_GTX_polar_coordinates ">glm/gtx/polar_coordinates.hpp</a>> to use the features of this extension. </p>
|
||||
<p>Conversion from Euclidean space to polar space and revert. </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga8a1bad8efb86c86a3ace904d23863019"></a>
|
||||
<a class="anchor" id="ga1821d5b3324201e60a9e2823d0b5d0c8"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL void glm::axisAngle </td>
|
||||
<td class="memname">GLM_FUNC_DECL vec<3, T, Q> glm::euclidean </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">mat< 4, 4, T, P > const & </td>
|
||||
<td class="paramname"><em>mat</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< 3, T, P > & </td>
|
||||
<td class="paramname"><em>axis</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T & </td>
|
||||
<td class="paramname"><em>angle</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Get the axis and angle of the rotation from a matrix. </p>
|
||||
<p>From GLM_GTX_matrix_interpolation extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gaf4c62093a1e1d61c5d1e0d1e02455cbf"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL mat<4, 4, T, P> glm::axisAngleMatrix </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< 3, T, P > const & </td>
|
||||
<td class="paramname"><em>axis</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const </td>
|
||||
<td class="paramname"><em>angle</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Build a matrix from axis and angle. </p>
|
||||
<p>From GLM_GTX_matrix_interpolation extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga7d194e86005f40cde677d6d2fadf6205"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL mat<4, 4, T, P> glm::extractMatrixRotation </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">mat< 4, 4, T, P > const & </td>
|
||||
<td class="paramname"><em>mat</em></td><td>)</td>
|
||||
<td class="paramtype">vec< 2, T, Q > const & </td>
|
||||
<td class="paramname"><em>polar</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Extracts the rotation part of a matrix. </p>
|
||||
<p>From GLM_GTX_matrix_interpolation extension. </p>
|
||||
<p>Convert Polar to Euclidean coordinates. </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00210.html" title="Include <glm/gtx/polar_coordinates.hpp> to use the features of this extension. ">GLM_GTX_polar_coordinates</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga8614879ae96ceaf18a4ef1b8ce2bc5aa"></a>
|
||||
<a class="anchor" id="gab83ac2c0e55b684b06b6c46c28b1590d"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL mat<4, 4, T, P> glm::interpolate </td>
|
||||
<td class="memname">GLM_FUNC_DECL vec<3, T, Q> glm::polar </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">mat< 4, 4, T, P > const & </td>
|
||||
<td class="paramname"><em>m1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td class="paramtype">vec< 3, T, Q > const & </td>
|
||||
<td class="paramname"><em>euclidean</em></td><td>)</td>
|
||||
<td></td>
|
||||
<td class="paramtype">mat< 4, 4, T, P > const & </td>
|
||||
<td class="paramname"><em>m2</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const </td>
|
||||
<td class="paramname"><em>delta</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Build a interpolation of 4 * 4 matrixes. </p>
|
||||
<p>From GLM_GTX_matrix_interpolation extension. Warning! works only with rotation and/or translation matrixes, scale will generate unexpected results. </p>
|
||||
<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="a00210.html" title="Include <glm/gtx/polar_coordinates.hpp> to use the features of this extension. ">GLM_GTX_polar_coordinates</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user