|
|
- <!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_e6ae9283c4fa4619048a0a88dfd00585.html">gtc</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="headertitle">
- <div class="title">gtc/quaternion.hpp</div> </div>
- </div><!--header-->
- <div class="contents">
- <a href="a01371.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 "../gtc/constants.hpp"</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "../gtc/matrix_transform.hpp"</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "../ext/vector_relational.hpp"</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "../ext/quaternion_common.hpp"</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "../ext/quaternion_float.hpp"</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "../ext/quaternion_float_precision.hpp"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "../ext/quaternion_double.hpp"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "../ext/quaternion_double_precision.hpp"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "../ext/quaternion_relational.hpp"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "../ext/quaternion_geometric.hpp"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "../ext/quaternion_trigonometric.hpp"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "../ext/quaternion_transform.hpp"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "../detail/type_mat3x3.hpp"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "../detail/type_mat4x4.hpp"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "../detail/type_vec3.hpp"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "../detail/type_vec4.hpp"</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"># pragma message("GLM: GLM_GTC_quaternion extension included")</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">namespace </span><a class="code" href="a00793.html">glm</a></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  GLM_FUNC_DECL vec<3, T, Q> <a class="code" href="a00663.html#gaf4dd967dead22dd932fc7460ceecb03f">eulerAngles</a>(qua<T, Q> <span class="keyword">const</span>& x);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  GLM_FUNC_DECL T <a class="code" href="a00663.html#ga0cc5ad970d0b00829b139fe0fe5a1e13">roll</a>(qua<T, Q> <span class="keyword">const</span>& x);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  GLM_FUNC_DECL T <a class="code" href="a00663.html#ga7603e81477b46ddb448896909bc04928">pitch</a>(qua<T, Q> <span class="keyword">const</span>& x);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  GLM_FUNC_DECL T <a class="code" href="a00663.html#ga8da38cdfdc452dafa660c2f46506bad5">yaw</a>(qua<T, Q> <span class="keyword">const</span>& x);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  GLM_FUNC_DECL mat<3, 3, T, Q> <a class="code" href="a00663.html#ga333ab70047fbe4132406100c292dbc89">mat3_cast</a>(qua<T, Q> <span class="keyword">const</span>& x);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  GLM_FUNC_DECL mat<4, 4, T, Q> <a class="code" href="a00663.html#ga1113212d9bdefc2e31ad40e5bbb506f3">mat4_cast</a>(qua<T, Q> <span class="keyword">const</span>& x);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  GLM_FUNC_DECL qua<T, Q> <a class="code" href="a00663.html#ga4524810f07f72e8c7bdc7764fa11cb58">quat_cast</a>(mat<3, 3, T, Q> <span class="keyword">const</span>& x);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  GLM_FUNC_DECL qua<T, Q> <a class="code" href="a00663.html#ga4524810f07f72e8c7bdc7764fa11cb58">quat_cast</a>(mat<4, 4, T, Q> <span class="keyword">const</span>& x);</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  GLM_FUNC_DECL vec<4, bool, Q> <a class="code" href="a00663.html#gad091a2d22c8acfebfa92bcfca1dfe9c4">lessThan</a>(qua<T, Q> <span class="keyword">const</span>& x, qua<T, Q> <span class="keyword">const</span>& y);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  GLM_FUNC_DECL vec<4, bool, Q> <a class="code" href="a00663.html#gac00012eea281800d2403f4ea8443134d">lessThanEqual</a>(qua<T, Q> <span class="keyword">const</span>& x, qua<T, Q> <span class="keyword">const</span>& y);</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  GLM_FUNC_DECL vec<4, bool, Q> <a class="code" href="a00663.html#ga8f7fa76e06c417b757ddfd438f3f677b">greaterThan</a>(qua<T, Q> <span class="keyword">const</span>& x, qua<T, Q> <span class="keyword">const</span>& y);</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  GLM_FUNC_DECL vec<4, bool, Q> <a class="code" href="a00663.html#ga388cbeba987dae7b5937f742efa49a5a">greaterThanEqual</a>(qua<T, Q> <span class="keyword">const</span>& x, qua<T, Q> <span class="keyword">const</span>& y);</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  GLM_FUNC_DECL qua<T, Q> <a class="code" href="a00663.html#gabe7fc5ec5feb41ab234d5d2b6254697f">quatLookAt</a>(</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  vec<3, T, Q> <span class="keyword">const</span>& direction,</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  vec<3, T, Q> <span class="keyword">const</span>& up);</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  GLM_FUNC_DECL qua<T, Q> <a class="code" href="a00663.html#gaf6529ac8c04a57fcc35865b5c9437cc8">quatLookAtRH</a>(</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  vec<3, T, Q> <span class="keyword">const</span>& direction,</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  vec<3, T, Q> <span class="keyword">const</span>& up);</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  GLM_FUNC_DECL qua<T, Q> <a class="code" href="a00663.html#ga2da350c73411be3bb19441b226b81a74">quatLookAtLH</a>(</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  vec<3, T, Q> <span class="keyword">const</span>& direction,</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  vec<3, T, Q> <span class="keyword">const</span>& up);</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> } <span class="comment">//namespace glm</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="preprocessor">#include "quaternion.inl"</span></div><div class="ttc" id="a00663_html_gad091a2d22c8acfebfa92bcfca1dfe9c4"><div class="ttname"><a href="a00663.html#gad091a2d22c8acfebfa92bcfca1dfe9c4">glm::lessThan</a></div><div class="ttdeci">GLM_FUNC_DECL vec< 4, bool, Q > lessThan(qua< T, Q > const &x, qua< T, Q > const &y)</div><div class="ttdoc">Returns the component-wise comparison result of x < y. </div></div>
- <div class="ttc" id="a00793_html"><div class="ttname"><a href="a00793.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="a00663_html_ga4524810f07f72e8c7bdc7764fa11cb58"><div class="ttname"><a href="a00663.html#ga4524810f07f72e8c7bdc7764fa11cb58">glm::quat_cast</a></div><div class="ttdeci">GLM_FUNC_DECL qua< T, Q > quat_cast(mat< 4, 4, T, Q > const &x)</div><div class="ttdoc">Converts a pure rotation 4 * 4 matrix to a quaternion. </div></div>
- <div class="ttc" id="a00663_html_gabe7fc5ec5feb41ab234d5d2b6254697f"><div class="ttname"><a href="a00663.html#gabe7fc5ec5feb41ab234d5d2b6254697f">glm::quatLookAt</a></div><div class="ttdeci">GLM_FUNC_DECL qua< T, Q > quatLookAt(vec< 3, T, Q > const &direction, vec< 3, T, Q > const &up)</div><div class="ttdoc">Build a look at quaternion based on the default handedness. </div></div>
- <div class="ttc" id="a00663_html_gaf4dd967dead22dd932fc7460ceecb03f"><div class="ttname"><a href="a00663.html#gaf4dd967dead22dd932fc7460ceecb03f">glm::eulerAngles</a></div><div class="ttdeci">GLM_FUNC_DECL vec< 3, T, Q > eulerAngles(qua< T, Q > const &x)</div><div class="ttdoc">Returns euler angles, pitch as x, yaw as y, roll as z. </div></div>
- <div class="ttc" id="a00663_html_ga333ab70047fbe4132406100c292dbc89"><div class="ttname"><a href="a00663.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="a00663_html_ga388cbeba987dae7b5937f742efa49a5a"><div class="ttname"><a href="a00663.html#ga388cbeba987dae7b5937f742efa49a5a">glm::greaterThanEqual</a></div><div class="ttdeci">GLM_FUNC_DECL vec< 4, bool, Q > greaterThanEqual(qua< T, Q > const &x, qua< T, Q > const &y)</div><div class="ttdoc">Returns the component-wise comparison of result x >= y. </div></div>
- <div class="ttc" id="a00663_html_ga8f7fa76e06c417b757ddfd438f3f677b"><div class="ttname"><a href="a00663.html#ga8f7fa76e06c417b757ddfd438f3f677b">glm::greaterThan</a></div><div class="ttdeci">GLM_FUNC_DECL vec< 4, bool, Q > greaterThan(qua< T, Q > const &x, qua< T, Q > const &y)</div><div class="ttdoc">Returns the component-wise comparison of result x > y. </div></div>
- <div class="ttc" id="a00663_html_ga7603e81477b46ddb448896909bc04928"><div class="ttname"><a href="a00663.html#ga7603e81477b46ddb448896909bc04928">glm::pitch</a></div><div class="ttdeci">GLM_FUNC_DECL T pitch(qua< T, Q > const &x)</div><div class="ttdoc">Returns pitch value of euler angles expressed in radians. </div></div>
- <div class="ttc" id="a00663_html_gaf6529ac8c04a57fcc35865b5c9437cc8"><div class="ttname"><a href="a00663.html#gaf6529ac8c04a57fcc35865b5c9437cc8">glm::quatLookAtRH</a></div><div class="ttdeci">GLM_FUNC_DECL qua< T, Q > quatLookAtRH(vec< 3, T, Q > const &direction, vec< 3, T, Q > const &up)</div><div class="ttdoc">Build a right-handed look at quaternion. </div></div>
- <div class="ttc" id="a00663_html_ga2da350c73411be3bb19441b226b81a74"><div class="ttname"><a href="a00663.html#ga2da350c73411be3bb19441b226b81a74">glm::quatLookAtLH</a></div><div class="ttdeci">GLM_FUNC_DECL qua< T, Q > quatLookAtLH(vec< 3, T, Q > const &direction, vec< 3, T, Q > const &up)</div><div class="ttdoc">Build a left-handed look at quaternion. </div></div>
- <div class="ttc" id="a00663_html_ga1113212d9bdefc2e31ad40e5bbb506f3"><div class="ttname"><a href="a00663.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="a00663_html_ga0cc5ad970d0b00829b139fe0fe5a1e13"><div class="ttname"><a href="a00663.html#ga0cc5ad970d0b00829b139fe0fe5a1e13">glm::roll</a></div><div class="ttdeci">GLM_FUNC_DECL T roll(qua< T, Q > const &x)</div><div class="ttdoc">Returns roll value of euler angles expressed in radians. </div></div>
- <div class="ttc" id="a00663_html_ga8da38cdfdc452dafa660c2f46506bad5"><div class="ttname"><a href="a00663.html#ga8da38cdfdc452dafa660c2f46506bad5">glm::yaw</a></div><div class="ttdeci">GLM_FUNC_DECL T yaw(qua< T, Q > const &x)</div><div class="ttdoc">Returns yaw value of euler angles expressed in radians. </div></div>
- <div class="ttc" id="a00663_html_gac00012eea281800d2403f4ea8443134d"><div class="ttname"><a href="a00663.html#gac00012eea281800d2403f4ea8443134d">glm::lessThanEqual</a></div><div class="ttdeci">GLM_FUNC_DECL vec< 4, bool, Q > lessThanEqual(qua< T, Q > const &x, qua< T, Q > const &y)</div><div class="ttdoc">Returns the component-wise comparison of result x <= y. </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>
|
