mirror of
https://github.com/g-truc/glm.git
synced 2024-12-01 20:24:38 +00:00
99 lines
27 KiB
HTML
99 lines
27 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: quaternion.hpp Source File</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>
|
||
|
|
<!-- 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_d522931ffa1371640980b621734a4381.html">Users</a></li><li class="navelem"><a class="el" href="dir_02cc19cee4c4780485bfe81520450212.html">christophericcio</a></li><li class="navelem"><a class="el" href="dir_54de7df3bc9880881b14ec07f256fd2e.html">Documents</a></li><li class="navelem"><a class="el" href="dir_6399a054f5929b58eaa476233e406ce8.html">Repository</a></li><li class="navelem"><a class="el" href="dir_627f4a52155b61a75c7c4851d7df9027.html">Github</a></li><li class="navelem"><a class="el" href="dir_ffdfd01cf51cdb2fe8bd5e55c6e0c4e8.html">glm</a></li><li class="navelem"><a class="el" href="dir_4ca6aa55b50e6be994025af27820140e.html">glm</a></li><li class="navelem"><a class="el" href="dir_3da5c411f748022d233cc92a3c5e2a02.html">gtx</a></li> </ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">gtx/quaternion.hpp</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<a href="a01375.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// Dependency:</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "../glm.hpp"</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "../gtc/constants.hpp"</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "../gtc/quaternion.hpp"</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "../ext/quaternion_exponential.hpp"</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "../gtx/norm.hpp"</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef GLM_ENABLE_EXPERIMENTAL</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"># error "GLM: GLM_GTX_quaternion is an experimental extension and may change in the future. Use #define GLM_ENABLE_EXPERIMENTAL before including it, if you really want to use it."</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor"># pragma message("GLM: GLM_GTX_quaternion extension included")</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span><a class="code" href="a00794.html">glm</a></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  GLM_FUNC_DECL qua<T, Q> <a class="code" href="a00771.html#ga5ee8332600b2aca3a77622a28d857b55">quat_identity</a>();</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  GLM_FUNC_DECL vec<3, T, Q> <a class="code" href="a00771.html#ga9f5f77255756e5668dfee7f0d07ed021">cross</a>(</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  qua<T, Q> <span class="keyword">const</span>& q,</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>
|
||
|
|
<div class="ttc" id="a00771_html_ga5eb36f51e1638e710451eba194dbc011"><div class="ttname"><a href="a00771.html#ga5eb36f51e1638e710451eba194dbc011">glm::toQuat</a></div><div class="ttdeci">GLM_FUNC_DECL qua< T, Q > toQuat(mat< 4, 4, T, Q > const &x)</div><div class="ttdoc">Converts a 4 * 4 matrix to a quaternion. </div><div class="ttdef"><b>Definition:</b> <a href="a01375_source.html#l00134">gtx/quaternion.hpp:134</a></div></div>
|
||
|
|
<div class="ttc" id="a00666_html_ga333ab70047fbe4132406100c292dbc89"><div class="ttname"><a href="a00666.html#ga333ab70047fbe4132406100c292dbc89">glm::mat3_cast</a></div><div class="ttdeci">GLM_FUNC_DECL mat< 3, 3, T, Q > mat3_cast(qua< T, Q > const &x)</div><div class="ttdoc">Converts a quaternion to a 3 * 3 matrix. </div></div>
|
||
|
|
<div class="ttc" id="a00771_html_gadfa2c77094e8cc9adad321d938855ffb"><div class="ttname"><a href="a00771.html#gadfa2c77094e8cc9adad321d938855ffb">glm::toMat4</a></div><div class="ttdeci">GLM_FUNC_DECL mat< 4, 4, T, Q > toMat4(qua< T, Q > const &x)</div><div class="ttdoc">Converts a quaternion to a 4 * 4 matrix. </div><div class="ttdef"><b>Definition:</b> <a href="a01375_source.html#l00120">gtx/quaternion.hpp:120</a></div></div>
|
||
|
|
<div class="ttc" id="a00771_html_gaab0afabb894b28a983fb8ec610409d56"><div class="ttname"><a href="a00771.html#gaab0afabb894b28a983fb8ec610409d56">glm::toMat3</a></div><div class="ttdeci">GLM_FUNC_DECL mat< 3, 3, T, Q > toMat3(qua< T, Q > const &x)</div><div class="ttdoc">Converts a quaternion to a 3 * 3 matrix. </div><div class="ttdef"><b>Definition:</b> <a href="a01375_source.html#l00113">gtx/quaternion.hpp:113</a></div></div>
|
||
|
|
<div class="ttc" id="a00771_html_ga03e61282831cc3f52cc76f72f52ad2c5"><div class="ttname"><a href="a00771.html#ga03e61282831cc3f52cc76f72f52ad2c5">glm::rotation</a></div><div class="ttdeci">GLM_FUNC_DECL qua< T, Q > rotation(vec< 3, T, Q > const &orig, vec< 3, T, Q > const &dest)</div><div class="ttdoc">Compute the rotation between two vectors. </div></div>
|
||
|
|
<div class="ttc" id="a00666_html_ga1113212d9bdefc2e31ad40e5bbb506f3"><div class="ttname"><a href="a00666.html#ga1113212d9bdefc2e31ad40e5bbb506f3">glm::mat4_cast</a></div><div class="ttdeci">GLM_FUNC_DECL mat< 4, 4, T, Q > mat4_cast(qua< T, Q > const &x)</div><div class="ttdoc">Converts a quaternion to a 4 * 4 matrix. </div></div>
|
||
|
|
<div class="ttc" id="a00771_html_ga321953c1b2e7befe6f5dcfddbfc6b76b"><div class="ttname"><a href="a00771.html#ga321953c1b2e7befe6f5dcfddbfc6b76b">glm::extractRealComponent</a></div><div class="ttdeci">GLM_FUNC_DECL T extractRealComponent(qua< T, Q > const &q)</div><div class="ttdoc">Extract the real component of a quaternion. </div></div>
|
||
|
|
<div class="ttc" id="a00666_html_ga1108a4ab88ca87bac321454eea7702f8"><div class="ttname"><a href="a00666.html#ga1108a4ab88ca87bac321454eea7702f8">glm::quat_cast</a></div><div class="ttdeci">GLM_FUNC_DECL qua< T, Q > quat_cast(mat< 3, 3, T, Q > const &x)</div><div class="ttdoc">Converts a pure rotation 3 * 3 matrix to a quaternion. </div></div>
|
||
|
|
<div class="ttc" id="a00771_html_ga0b9bf3459e132ad8a18fe970669e3e35"><div class="ttname"><a href="a00771.html#ga0b9bf3459e132ad8a18fe970669e3e35">glm::squad</a></div><div class="ttdeci">GLM_FUNC_DECL qua< T, Q > squad(qua< T, Q > const &q1, qua< T, Q > const &q2, qua< T, Q > const &s1, qua< T, Q > const &s2, T const &h)</div><div class="ttdoc">Compute a point on a path according squad equation. </div></div>
|
||
|
|
<div class="ttc" id="a00771_html_ga9f5f77255756e5668dfee7f0d07ed021"><div class="ttname"><a href="a00771.html#ga9f5f77255756e5668dfee7f0d07ed021">glm::cross</a></div><div class="ttdeci">GLM_FUNC_DECL vec< 3, T, Q > cross(vec< 3, T, Q > const &v, qua< T, Q > const &q)</div><div class="ttdoc">Compute a cross product between a vector and a quaternion. </div></div>
|
||
|
|
<div class="ttc" id="a00771_html_ga5ee8332600b2aca3a77622a28d857b55"><div class="ttname"><a href="a00771.html#ga5ee8332600b2aca3a77622a28d857b55">glm::quat_identity</a></div><div class="ttdeci">GLM_FUNC_DECL qua< T, Q > quat_identity()</div><div class="ttdoc">Create an identity quaternion. </div></div>
|
||
|
|
<div class="ttc" id="a00771_html_ga58a609b1b8ab965f5df2702e8ca4e75b"><div class="ttname"><a href="a00771.html#ga58a609b1b8ab965f5df2702e8ca4e75b">glm::length2</a></div><div class="ttdeci">GLM_FUNC_DECL T length2(qua< T, Q > const &q)</div><div class="ttdoc">Returns the squared length of x. </div></div>
|
||
|
|
<div class="ttc" id="a00771_html_gafcb78dfff45fbf19a7fcb2bd03fbf196"><div class="ttname"><a href="a00771.html#gafcb78dfff45fbf19a7fcb2bd03fbf196">glm::rotate</a></div><div class="ttdeci">GLM_FUNC_DECL vec< 4, T, Q > rotate(qua< T, Q > const &q, vec< 4, T, Q > const &v)</div><div class="ttdoc">Rotates a 4 components vector by a quaternion. </div></div>
|
||
|
|
<div class="ttc" id="a00771_html_gadc576cc957adc2a568cdcbc3799175bc"><div class="ttname"><a href="a00771.html#gadc576cc957adc2a568cdcbc3799175bc">glm::shortMix</a></div><div class="ttdeci">GLM_FUNC_DECL qua< T, Q > shortMix(qua< T, Q > const &x, qua< T, Q > const &y, T const &a)</div><div class="ttdoc">Quaternion interpolation using the rotation short path. </div></div>
|
||
|
|
<div class="ttc" id="a00794_html"><div class="ttname"><a href="a00794.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00002_source.html#l00018">common.hpp:18</a></div></div>
|
||
|
|
<div class="ttc" id="a00771_html_ga264e10708d58dd0ff53b7902a2bd2561"><div class="ttname"><a href="a00771.html#ga264e10708d58dd0ff53b7902a2bd2561">glm::fastMix</a></div><div class="ttdeci">GLM_FUNC_DECL qua< T, Q > fastMix(qua< T, Q > const &x, qua< T, Q > const &y, T const &a)</div><div class="ttdoc">Quaternion normalized linear interpolation. </div></div>
|
||
|
|
</div><!-- fragment --></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>
|