mirror/glm
1
0
Fork 0
mirror of https://github.com/g-truc/glm.git synced 2024-11-10 04:31:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
33b4a621a6
glm/doc/api/a00856.html
Christophe 33b0eb9fa3 Updated doc
2024-01-24 14:43:07 +01:00

215 lines
9.8 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>1.0.0 API documentation: GLM_EXT_quaternion_trigonometric</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">1.0.0 API documentation
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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_EXT_quaternion_trigonometric<div class="ingroups"><a class="el" href="a00894.html">Stable 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:ga8aa248b31d5ade470c87304df5eb7bd8"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga8aa248b31d5ade470c87304df5eb7bd8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00856.html#ga8aa248b31d5ade470c87304df5eb7bd8">angle</a> (qua&lt; T, Q &gt; const &amp;x)</td></tr>
<tr class="memdesc:ga8aa248b31d5ade470c87304df5eb7bd8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the quaternion rotation angle. <a href="a00856.html#ga8aa248b31d5ade470c87304df5eb7bd8">More...</a><br /></td></tr>
<tr class="separator:ga8aa248b31d5ade470c87304df5eb7bd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5c0095cfcb218c75a4b79d7687950036"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga5c0095cfcb218c75a4b79d7687950036"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00856.html#ga5c0095cfcb218c75a4b79d7687950036">angleAxis</a> (T const &amp;angle, vec&lt; 3, T, Q &gt; const &amp;axis)</td></tr>
<tr class="memdesc:ga5c0095cfcb218c75a4b79d7687950036"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a quaternion from an angle and a normalized axis. <a href="a00856.html#ga5c0095cfcb218c75a4b79d7687950036">More...</a><br /></td></tr>
<tr class="separator:ga5c0095cfcb218c75a4b79d7687950036"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga764254f10248b505e936e5309a88c23d"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga764254f10248b505e936e5309a88c23d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 3, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00856.html#ga764254f10248b505e936e5309a88c23d">axis</a> (qua&lt; T, Q &gt; const &amp;x)</td></tr>
<tr class="memdesc:ga764254f10248b505e936e5309a88c23d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the q rotation axis. <a href="a00856.html#ga764254f10248b505e936e5309a88c23d">More...</a><br /></td></tr>
<tr class="separator:ga764254f10248b505e936e5309a88c23d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Provides trigonometric functions for quaternion types</p>
<p>Include &lt;<a class="el" href="a00350.html" title="GLM_EXT_quaternion_trigonometric">glm/ext/quaternion_trigonometric.hpp</a>&gt; to use the features of this extension.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00851.html">GLM_EXT_quaternion_float</a> </dd>
<dd>
<a class="el" href="a00848.html">GLM_EXT_quaternion_double</a> </dd>
<dd>
<a class="el" href="a00850.html">GLM_EXT_quaternion_exponential</a> </dd>
<dd>
<a class="el" href="a00853.html">GLM_EXT_quaternion_geometric</a> </dd>
<dd>
<a class="el" href="a00854.html">GLM_EXT_quaternion_relational</a> </dd>
<dd>
<a class="el" href="a00855.html">GLM_EXT_quaternion_transform</a> </dd></dl>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga8aa248b31d5ade470c87304df5eb7bd8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8aa248b31d5ade470c87304df5eb7bd8">&#9670;&nbsp;</a></span>angle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL T glm::angle </td>
<td>(</td>
<td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the quaternion rotation angle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>A normalized quaternion.</td></tr>
</table>
</dd>
</dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
<tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga5c0095cfcb218c75a4b79d7687950036"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5c0095cfcb218c75a4b79d7687950036">&#9670;&nbsp;</a></span>angleAxis()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::angleAxis </td>
<td>(</td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>axis</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a quaternion from an angle and a normalized axis. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">angle</td><td>Angle expressed in radians. </td></tr>
<tr><td class="paramname">axis</td><td>Axis of the quaternion, must be normalized.</td></tr>
</table>
</dd>
</dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
<tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga764254f10248b505e936e5309a88c23d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga764254f10248b505e936e5309a88c23d">&#9670;&nbsp;</a></span>axis()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec&lt;3, T, Q&gt; glm::axis </td>
<td>(</td>
<td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the q rotation axis. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
<tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink