mirror of
https://github.com/g-truc/glm.git
synced 2024-11-25 09:54:35 +00:00
182 lines
18 KiB
HTML
182 lines
18 KiB
HTML
<!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.8.10"/>
|
|
<title>0.9.9 API documentation: quaternion.hpp File 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/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.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 id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">0.9.9 API documentation
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.10 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</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="dir_3a581ba30d25676e4b797b1f96d53b45.html">F:</a></li><li class="navelem"><a class="el" href="dir_9e5fe034a00e89334fd5186c3e7db156.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_d9496f0844b48bc7e53b5af8c99b9ab2.html">Source</a></li><li class="navelem"><a class="el" href="dir_a8bee7be44182a33f3820393ae0b105d.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_44e5e654415abd9ca6fdeaddaff8565e.html">glm</a></li><li class="navelem"><a class="el" href="dir_cef2d71d502cb69a9252bca2297d9549.html">glm</a></li><li class="navelem"><a class="el" href="dir_f35778ec600a1b9bbc4524e62e226aa2.html">gtx</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">gtx/quaternion.hpp File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="a00352.html">GLM_GTX_quaternion</a>
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><a href="a00126_source.html">Go to the source code of this file.</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:ga2f32f970411c44cdd38bb98960198385"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga2f32f970411c44cdd38bb98960198385"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00352.html#ga2f32f970411c44cdd38bb98960198385">cross</a> (qua< T, Q > const &q, vec< 3, T, Q > const &v)</td></tr>
|
|
<tr class="memdesc:ga2f32f970411c44cdd38bb98960198385"><td class="mdescLeft"> </td><td class="mdescRight">Compute a cross product between a quaternion and a vector. <a href="a00352.html#ga2f32f970411c44cdd38bb98960198385">More...</a><br /></td></tr>
|
|
<tr class="separator:ga2f32f970411c44cdd38bb98960198385"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9f5f77255756e5668dfee7f0d07ed021"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga9f5f77255756e5668dfee7f0d07ed021"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00352.html#ga9f5f77255756e5668dfee7f0d07ed021">cross</a> (vec< 3, T, Q > const &v, qua< T, Q > const &q)</td></tr>
|
|
<tr class="memdesc:ga9f5f77255756e5668dfee7f0d07ed021"><td class="mdescLeft"> </td><td class="mdescRight">Compute a cross product between a vector and a quaternion. <a href="a00352.html#ga9f5f77255756e5668dfee7f0d07ed021">More...</a><br /></td></tr>
|
|
<tr class="separator:ga9f5f77255756e5668dfee7f0d07ed021"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga321953c1b2e7befe6f5dcfddbfc6b76b"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga321953c1b2e7befe6f5dcfddbfc6b76b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00352.html#ga321953c1b2e7befe6f5dcfddbfc6b76b">extractRealComponent</a> (qua< T, Q > const &q)</td></tr>
|
|
<tr class="memdesc:ga321953c1b2e7befe6f5dcfddbfc6b76b"><td class="mdescLeft"> </td><td class="mdescRight">Extract the real component of a quaternion. <a href="a00352.html#ga321953c1b2e7befe6f5dcfddbfc6b76b">More...</a><br /></td></tr>
|
|
<tr class="separator:ga321953c1b2e7befe6f5dcfddbfc6b76b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga264e10708d58dd0ff53b7902a2bd2561"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga264e10708d58dd0ff53b7902a2bd2561"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00352.html#ga264e10708d58dd0ff53b7902a2bd2561">fastMix</a> (qua< T, Q > const &x, qua< T, Q > const &y, T const &a)</td></tr>
|
|
<tr class="memdesc:ga264e10708d58dd0ff53b7902a2bd2561"><td class="mdescLeft"> </td><td class="mdescRight">Quaternion normalized linear interpolation. <a href="a00352.html#ga264e10708d58dd0ff53b7902a2bd2561">More...</a><br /></td></tr>
|
|
<tr class="separator:ga264e10708d58dd0ff53b7902a2bd2561"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gacc5cd5f3e78de61d141c2355417424de"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:gacc5cd5f3e78de61d141c2355417424de"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00352.html#gacc5cd5f3e78de61d141c2355417424de">intermediate</a> (qua< T, Q > const &prev, qua< T, Q > const &curr, qua< T, Q > const &next)</td></tr>
|
|
<tr class="memdesc:gacc5cd5f3e78de61d141c2355417424de"><td class="mdescLeft"> </td><td class="mdescRight">Returns an intermediate control point for squad interpolation. <a href="a00352.html#gacc5cd5f3e78de61d141c2355417424de">More...</a><br /></td></tr>
|
|
<tr class="separator:gacc5cd5f3e78de61d141c2355417424de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga58a609b1b8ab965f5df2702e8ca4e75b"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga58a609b1b8ab965f5df2702e8ca4e75b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00352.html#ga58a609b1b8ab965f5df2702e8ca4e75b">length2</a> (qua< T, Q > const &q)</td></tr>
|
|
<tr class="memdesc:ga58a609b1b8ab965f5df2702e8ca4e75b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the squared length of x. <a href="a00352.html#ga58a609b1b8ab965f5df2702e8ca4e75b">More...</a><br /></td></tr>
|
|
<tr class="separator:ga58a609b1b8ab965f5df2702e8ca4e75b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5ee8332600b2aca3a77622a28d857b55"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga5ee8332600b2aca3a77622a28d857b55"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00352.html#ga5ee8332600b2aca3a77622a28d857b55">quat_identity</a> ()</td></tr>
|
|
<tr class="memdesc:ga5ee8332600b2aca3a77622a28d857b55"><td class="mdescLeft"> </td><td class="mdescRight">Create an identity quaternion. <a href="a00352.html#ga5ee8332600b2aca3a77622a28d857b55">More...</a><br /></td></tr>
|
|
<tr class="separator:ga5ee8332600b2aca3a77622a28d857b55"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga07da6ef58646442efe93b0c273d73776"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga07da6ef58646442efe93b0c273d73776"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00352.html#ga07da6ef58646442efe93b0c273d73776">rotate</a> (qua< T, Q > const &q, vec< 3, T, Q > const &v)</td></tr>
|
|
<tr class="memdesc:ga07da6ef58646442efe93b0c273d73776"><td class="mdescLeft"> </td><td class="mdescRight">Returns quarternion square root. <a href="a00352.html#ga07da6ef58646442efe93b0c273d73776">More...</a><br /></td></tr>
|
|
<tr class="separator:ga07da6ef58646442efe93b0c273d73776"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafcb78dfff45fbf19a7fcb2bd03fbf196"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:gafcb78dfff45fbf19a7fcb2bd03fbf196"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 4, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00352.html#gafcb78dfff45fbf19a7fcb2bd03fbf196">rotate</a> (qua< T, Q > const &q, vec< 4, T, Q > const &v)</td></tr>
|
|
<tr class="memdesc:gafcb78dfff45fbf19a7fcb2bd03fbf196"><td class="mdescLeft"> </td><td class="mdescRight">Rotates a 4 components vector by a quaternion. <a href="a00352.html#gafcb78dfff45fbf19a7fcb2bd03fbf196">More...</a><br /></td></tr>
|
|
<tr class="separator:gafcb78dfff45fbf19a7fcb2bd03fbf196"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga03e61282831cc3f52cc76f72f52ad2c5"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga03e61282831cc3f52cc76f72f52ad2c5"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00352.html#ga03e61282831cc3f52cc76f72f52ad2c5">rotation</a> (vec< 3, T, Q > const &orig, vec< 3, T, Q > const &dest)</td></tr>
|
|
<tr class="memdesc:ga03e61282831cc3f52cc76f72f52ad2c5"><td class="mdescLeft"> </td><td class="mdescRight">Compute the rotation between two vectors. <a href="a00352.html#ga03e61282831cc3f52cc76f72f52ad2c5">More...</a><br /></td></tr>
|
|
<tr class="separator:ga03e61282831cc3f52cc76f72f52ad2c5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gadc576cc957adc2a568cdcbc3799175bc"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:gadc576cc957adc2a568cdcbc3799175bc"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00352.html#gadc576cc957adc2a568cdcbc3799175bc">shortMix</a> (qua< T, Q > const &x, qua< T, Q > const &y, T const &a)</td></tr>
|
|
<tr class="memdesc:gadc576cc957adc2a568cdcbc3799175bc"><td class="mdescLeft"> </td><td class="mdescRight">Quaternion interpolation using the rotation short path. <a href="a00352.html#gadc576cc957adc2a568cdcbc3799175bc">More...</a><br /></td></tr>
|
|
<tr class="separator:gadc576cc957adc2a568cdcbc3799175bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0b9bf3459e132ad8a18fe970669e3e35"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga0b9bf3459e132ad8a18fe970669e3e35"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00352.html#ga0b9bf3459e132ad8a18fe970669e3e35">squad</a> (qua< T, Q > const &q1, qua< T, Q > const &q2, qua< T, Q > const &s1, qua< T, Q > const &s2, T const &h)</td></tr>
|
|
<tr class="memdesc:ga0b9bf3459e132ad8a18fe970669e3e35"><td class="mdescLeft"> </td><td class="mdescRight">Compute a point on a path according squad equation. <a href="a00352.html#ga0b9bf3459e132ad8a18fe970669e3e35">More...</a><br /></td></tr>
|
|
<tr class="separator:ga0b9bf3459e132ad8a18fe970669e3e35"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaab0afabb894b28a983fb8ec610409d56"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:gaab0afabb894b28a983fb8ec610409d56"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat< 3, 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00352.html#gaab0afabb894b28a983fb8ec610409d56">toMat3</a> (qua< T, Q > const &x)</td></tr>
|
|
<tr class="memdesc:gaab0afabb894b28a983fb8ec610409d56"><td class="mdescLeft"> </td><td class="mdescRight">Converts a quaternion to a 3 * 3 matrix. <a href="a00352.html#gaab0afabb894b28a983fb8ec610409d56">More...</a><br /></td></tr>
|
|
<tr class="separator:gaab0afabb894b28a983fb8ec610409d56"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gadfa2c77094e8cc9adad321d938855ffb"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:gadfa2c77094e8cc9adad321d938855ffb"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat< 4, 4, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00352.html#gadfa2c77094e8cc9adad321d938855ffb">toMat4</a> (qua< T, Q > const &x)</td></tr>
|
|
<tr class="memdesc:gadfa2c77094e8cc9adad321d938855ffb"><td class="mdescLeft"> </td><td class="mdescRight">Converts a quaternion to a 4 * 4 matrix. <a href="a00352.html#gadfa2c77094e8cc9adad321d938855ffb">More...</a><br /></td></tr>
|
|
<tr class="separator:gadfa2c77094e8cc9adad321d938855ffb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga798de5d186499c9a9231cd92c8afaef1"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga798de5d186499c9a9231cd92c8afaef1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00352.html#ga798de5d186499c9a9231cd92c8afaef1">toQuat</a> (mat< 3, 3, T, Q > const &x)</td></tr>
|
|
<tr class="memdesc:ga798de5d186499c9a9231cd92c8afaef1"><td class="mdescLeft"> </td><td class="mdescRight">Converts a 3 * 3 matrix to a quaternion. <a href="a00352.html#ga798de5d186499c9a9231cd92c8afaef1">More...</a><br /></td></tr>
|
|
<tr class="separator:ga798de5d186499c9a9231cd92c8afaef1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5eb36f51e1638e710451eba194dbc011"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga5eb36f51e1638e710451eba194dbc011"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00352.html#ga5eb36f51e1638e710451eba194dbc011">toQuat</a> (mat< 4, 4, T, Q > const &x)</td></tr>
|
|
<tr class="memdesc:ga5eb36f51e1638e710451eba194dbc011"><td class="mdescLeft"> </td><td class="mdescRight">Converts a 4 * 4 matrix to a quaternion. <a href="a00352.html#ga5eb36f51e1638e710451eba194dbc011">More...</a><br /></td></tr>
|
|
<tr class="separator:ga5eb36f51e1638e710451eba194dbc011"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><a class="el" href="a00352.html">GLM_GTX_quaternion</a> </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00280.html" title="Features that implement in C++ the GLSL specification as closely as possible. ">Core features</a> (dependence) </dd>
|
|
<dd>
|
|
gtx_extented_min_max (dependence) </dd></dl>
|
|
|
|
<p>Definition in file <a class="el" href="a00126_source.html">gtx/quaternion.hpp</a>.</p>
|
|
</div></div><!-- contents -->
|
|
<!-- 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.8.10
|
|
</small></address>
|
|
</body>
|
|
</html>
|