mirror of
https://github.com/g-truc/glm.git
synced 2024-11-23 09:14:34 +00:00
5bbbb460d3
"param" was not being recognised as a keyword, messing up the layout of `glm::rotation()`'s parameter description.
623 lines
32 KiB
HTML
623 lines
32 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.14"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>0.9.9 API documenation: GLM_GTX_quaternion</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>
|
|
<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 documenation
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<!-- 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 class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">GLM_GTX_quaternion<div class="ingroups"><a class="el" href="a00705.html">Experimental extensions</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: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="a00769.html#ga2f32f970411c44cdd38bb98960198385">cross</a> (qua< T, Q > const &q, vec< 3, T, Q > const &v)</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="a00769.html#ga9f5f77255756e5668dfee7f0d07ed021">cross</a> (vec< 3, T, Q > const &v, qua< T, Q > const &q)</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="a00769.html#ga321953c1b2e7befe6f5dcfddbfc6b76b">extractRealComponent</a> (qua< T, Q > const &q)</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="a00769.html#ga264e10708d58dd0ff53b7902a2bd2561">fastMix</a> (qua< T, Q > const &x, qua< T, Q > const &y, T const &a)</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="a00769.html#gacc5cd5f3e78de61d141c2355417424de">intermediate</a> (qua< T, Q > const &prev, qua< T, Q > const &curr, qua< T, Q > const &next)</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="a00769.html#ga58a609b1b8ab965f5df2702e8ca4e75b">length2</a> (qua< T, Q > const &q)</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="a00769.html#ga5ee8332600b2aca3a77622a28d857b55">quat_identity</a> ()</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="a00769.html#ga07da6ef58646442efe93b0c273d73776">rotate</a> (qua< T, Q > const &q, vec< 3, T, Q > const &v)</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="a00769.html#gafcb78dfff45fbf19a7fcb2bd03fbf196">rotate</a> (qua< T, Q > const &q, vec< 4, T, Q > const &v)</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="a00769.html#ga03e61282831cc3f52cc76f72f52ad2c5">rotation</a> (vec< 3, T, Q > const &orig, vec< 3, T, Q > const &dest)</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="a00769.html#gadc576cc957adc2a568cdcbc3799175bc">shortMix</a> (qua< T, Q > const &x, qua< T, Q > const &y, T const &a)</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="a00769.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="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="a00769.html#gaab0afabb894b28a983fb8ec610409d56">toMat3</a> (qua< T, Q > const &x)</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="a00769.html#gadfa2c77094e8cc9adad321d938855ffb">toMat4</a> (qua< T, Q > const &x)</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="a00769.html#ga798de5d186499c9a9231cd92c8afaef1">toQuat</a> (mat< 3, 3, T, Q > const &x)</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="a00769.html#ga5eb36f51e1638e710451eba194dbc011">toQuat</a> (mat< 4, 4, T, Q > const &x)</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>
|
|
<p>Include <<a class="el" href="a01373.html" title="GLM_GTX_quaternion ">glm/gtx/quaternion.hpp</a>> to use the features of this extension. </p>
|
|
<p>Extented quaternion types and functions </p>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga2f32f970411c44cdd38bb98960198385"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga2f32f970411c44cdd38bb98960198385">◆ </a></span>cross() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL vec<3, T, Q> glm::cross </td>
|
|
<td>(</td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>q</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vec< 3, T, Q > const & </td>
|
|
<td class="paramname"><em>v</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Compute a cross product between a quaternion and a vector. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00769.html" title="Include <glm/gtx/quaternion.hpp> to use the features of this extension. ">GLM_GTX_quaternion</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9f5f77255756e5668dfee7f0d07ed021"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9f5f77255756e5668dfee7f0d07ed021">◆ </a></span>cross() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL vec<3, T, Q> glm::cross </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vec< 3, T, Q > const & </td>
|
|
<td class="paramname"><em>v</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>q</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<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="a00769.html" title="Include <glm/gtx/quaternion.hpp> to use the features of this extension. ">GLM_GTX_quaternion</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga321953c1b2e7befe6f5dcfddbfc6b76b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga321953c1b2e7befe6f5dcfddbfc6b76b">◆ </a></span>extractRealComponent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL T glm::extractRealComponent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>q</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Extract the real component of a quaternion. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00769.html" title="Include <glm/gtx/quaternion.hpp> to use the features of this extension. ">GLM_GTX_quaternion</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga264e10708d58dd0ff53b7902a2bd2561"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga264e10708d58dd0ff53b7902a2bd2561">◆ </a></span>fastMix()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL qua<T, Q> glm::fastMix </td>
|
|
<td>(</td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">T const & </td>
|
|
<td class="paramname"><em>a</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Quaternion normalized linear interpolation. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00769.html" title="Include <glm/gtx/quaternion.hpp> to use the features of this extension. ">GLM_GTX_quaternion</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gacc5cd5f3e78de61d141c2355417424de"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gacc5cd5f3e78de61d141c2355417424de">◆ </a></span>intermediate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL qua<T, Q> glm::intermediate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>prev</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>curr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>next</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an intermediate control point for squad interpolation. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00769.html" title="Include <glm/gtx/quaternion.hpp> to use the features of this extension. ">GLM_GTX_quaternion</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga58a609b1b8ab965f5df2702e8ca4e75b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga58a609b1b8ab965f5df2702e8ca4e75b">◆ </a></span>length2()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL T glm::length2 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>q</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the squared length of x. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00769.html" title="Include <glm/gtx/quaternion.hpp> to use the features of this extension. ">GLM_GTX_quaternion</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga5ee8332600b2aca3a77622a28d857b55"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga5ee8332600b2aca3a77622a28d857b55">◆ </a></span>quat_identity()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL qua<T, Q> glm::quat_identity </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create an identity quaternion. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00769.html" title="Include <glm/gtx/quaternion.hpp> to use the features of this extension. ">GLM_GTX_quaternion</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga07da6ef58646442efe93b0c273d73776"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga07da6ef58646442efe93b0c273d73776">◆ </a></span>rotate() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL vec<3, T, Q> glm::rotate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>q</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vec< 3, T, Q > const & </td>
|
|
<td class="paramname"><em>v</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns quarternion square root. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00769.html" title="Include <glm/gtx/quaternion.hpp> to use the features of this extension. ">GLM_GTX_quaternion</a> Rotates a 3 components vector by a quaternion.</dd>
|
|
<dd>
|
|
<a class="el" href="a00769.html" title="Include <glm/gtx/quaternion.hpp> to use the features of this extension. ">GLM_GTX_quaternion</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gafcb78dfff45fbf19a7fcb2bd03fbf196"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gafcb78dfff45fbf19a7fcb2bd03fbf196">◆ </a></span>rotate() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL vec<4, T, Q> glm::rotate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>q</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vec< 4, T, Q > const & </td>
|
|
<td class="paramname"><em>v</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Rotates a 4 components vector by a quaternion. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00769.html" title="Include <glm/gtx/quaternion.hpp> to use the features of this extension. ">GLM_GTX_quaternion</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga03e61282831cc3f52cc76f72f52ad2c5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga03e61282831cc3f52cc76f72f52ad2c5">◆ </a></span>rotation()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL qua<T, Q> glm::rotation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vec< 3, T, Q > const & </td>
|
|
<td class="paramname"><em>orig</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vec< 3, T, Q > const & </td>
|
|
<td class="paramname"><em>dest</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Compute the rotation between two vectors. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">orig</td><td>vector, needs to be normalized </td></tr>
|
|
<tr><td class="paramname">dest</td><td>vector, needs to be normalized</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00769.html" title="Include <glm/gtx/quaternion.hpp> to use the features of this extension. ">GLM_GTX_quaternion</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gadc576cc957adc2a568cdcbc3799175bc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gadc576cc957adc2a568cdcbc3799175bc">◆ </a></span>shortMix()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL qua<T, Q> glm::shortMix </td>
|
|
<td>(</td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">T const & </td>
|
|
<td class="paramname"><em>a</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Quaternion interpolation using the rotation short path. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00769.html" title="Include <glm/gtx/quaternion.hpp> to use the features of this extension. ">GLM_GTX_quaternion</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga0b9bf3459e132ad8a18fe970669e3e35"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga0b9bf3459e132ad8a18fe970669e3e35">◆ </a></span>squad()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL qua<T, Q> glm::squad </td>
|
|
<td>(</td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>q1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>q2</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>s1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>s2</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">T const & </td>
|
|
<td class="paramname"><em>h</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Compute a point on a path according squad equation. </p>
|
|
<p>q1 and q2 are control points; s1 and s2 are intermediate control points.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00769.html" title="Include <glm/gtx/quaternion.hpp> to use the features of this extension. ">GLM_GTX_quaternion</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaab0afabb894b28a983fb8ec610409d56"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaab0afabb894b28a983fb8ec610409d56">◆ </a></span>toMat3()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL mat<3, 3, T, Q> glm::toMat3 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>x</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Converts a quaternion to a 3 * 3 matrix. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00769.html" title="Include <glm/gtx/quaternion.hpp> to use the features of this extension. ">GLM_GTX_quaternion</a> </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="a01373_source.html#l00113">113</a> of file <a class="el" href="a01373_source.html">gtx/quaternion.hpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="a00663.html#ga333ab70047fbe4132406100c292dbc89">glm::mat3_cast()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gadfa2c77094e8cc9adad321d938855ffb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gadfa2c77094e8cc9adad321d938855ffb">◆ </a></span>toMat4()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL mat<4, 4, T, Q> glm::toMat4 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
|
<td class="paramname"><em>x</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Converts a quaternion to a 4 * 4 matrix. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00769.html" title="Include <glm/gtx/quaternion.hpp> to use the features of this extension. ">GLM_GTX_quaternion</a> </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="a01373_source.html#l00120">120</a> of file <a class="el" href="a01373_source.html">gtx/quaternion.hpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="a00663.html#ga1113212d9bdefc2e31ad40e5bbb506f3">glm::mat4_cast()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga798de5d186499c9a9231cd92c8afaef1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga798de5d186499c9a9231cd92c8afaef1">◆ </a></span>toQuat() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL qua<T, Q> glm::toQuat </td>
|
|
<td>(</td>
|
|
<td class="paramtype">mat< 3, 3, T, Q > const & </td>
|
|
<td class="paramname"><em>x</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Converts a 3 * 3 matrix to a quaternion. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00769.html" title="Include <glm/gtx/quaternion.hpp> to use the features of this extension. ">GLM_GTX_quaternion</a> </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="a01373_source.html#l00127">127</a> of file <a class="el" href="a01373_source.html">gtx/quaternion.hpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="a00663.html#ga1108a4ab88ca87bac321454eea7702f8">glm::quat_cast()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga5eb36f51e1638e710451eba194dbc011"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga5eb36f51e1638e710451eba194dbc011">◆ </a></span>toQuat() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL qua<T, Q> glm::toQuat </td>
|
|
<td>(</td>
|
|
<td class="paramtype">mat< 4, 4, T, Q > const & </td>
|
|
<td class="paramname"><em>x</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Converts a 4 * 4 matrix to a quaternion. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00769.html" title="Include <glm/gtx/quaternion.hpp> to use the features of this extension. ">GLM_GTX_quaternion</a> </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="a01373_source.html#l00134">134</a> of file <a class="el" href="a01373_source.html">gtx/quaternion.hpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="a00663.html#ga1108a4ab88ca87bac321454eea7702f8">glm::quat_cast()</a>.</p>
|
|
|
|
</div>
|
|
</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.14
|
|
</small></address>
|
|
</body>
|
|
</html>
|