glm/doc/api/a00965.html

198 lines
9.1 KiB
HTML
Raw Permalink Normal View History

2024-01-24 13:40:22 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2017-08-15 19:22:51 +00:00
<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"/>
2024-01-24 13:40:22 +00:00
<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_GTX_rotate_normalized_axis</title>
2017-08-15 19:22:51 +00:00
<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;">
2017-08-17 18:39:22 +00:00
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
2017-08-15 19:22:51 +00:00
<td id="projectalign" style="padding-left: 0.5em;">
2024-01-24 13:40:22 +00:00
<div id="projectname">1.0.0 API documentation
2017-08-15 19:22:51 +00:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2024-01-24 13:40:22 +00:00
<!-- Generated by Doxygen 1.8.18 -->
2017-08-15 19:22:51 +00:00
<script type="text/javascript">
2024-01-24 13:40:22 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2017-08-15 19:22:51 +00:00
var searchBox = new SearchBox("searchBox", "search",false,'Search');
2024-01-24 13:40:22 +00:00
/* @license-end */
2017-08-15 19:22:51 +00:00
</script>
2024-01-24 13:40:22 +00:00
<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>
2017-08-15 19:22:51 +00:00
</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">
2024-01-24 13:40:22 +00:00
<div class="title">GLM_GTX_rotate_normalized_axis<div class="ingroups"><a class="el" href="a00896.html">Experimental extensions</a></div></div> </div>
2017-08-15 19:22:51 +00:00
</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>
2018-05-08 11:51:58 +00:00
<tr class="memitem:ga50efd7ebca0f7a603bb3cc11e34c708d"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
2024-01-24 13:40:22 +00:00
<tr class="memitem:ga50efd7ebca0f7a603bb3cc11e34c708d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat&lt; 4, 4, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00965.html#ga50efd7ebca0f7a603bb3cc11e34c708d">rotateNormalizedAxis</a> (mat&lt; 4, 4, T, Q &gt; const &amp;m, T const &amp;angle, vec&lt; 3, T, Q &gt; const &amp;axis)</td></tr>
<tr class="memdesc:ga50efd7ebca0f7a603bb3cc11e34c708d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds a rotation 4 * 4 matrix created from a normalized axis and an angle. <a href="a00965.html#ga50efd7ebca0f7a603bb3cc11e34c708d">More...</a><br /></td></tr>
2018-05-08 11:51:58 +00:00
<tr class="separator:ga50efd7ebca0f7a603bb3cc11e34c708d"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-09-02 21:34:18 +00:00
<tr class="memitem:ga08f9c5411437d528019a25bfc01473d1"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
2024-01-24 13:40:22 +00:00
<tr class="memitem:ga08f9c5411437d528019a25bfc01473d1"><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="a00965.html#ga08f9c5411437d528019a25bfc01473d1">rotateNormalizedAxis</a> (qua&lt; T, Q &gt; const &amp;q, T const &amp;angle, vec&lt; 3, T, Q &gt; const &amp;axis)</td></tr>
<tr class="memdesc:ga08f9c5411437d528019a25bfc01473d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotates a quaternion from a vector of 3 components normalized axis and an angle. <a href="a00965.html#ga08f9c5411437d528019a25bfc01473d1">More...</a><br /></td></tr>
2018-09-02 21:34:18 +00:00
<tr class="separator:ga08f9c5411437d528019a25bfc01473d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
2017-08-15 19:22:51 +00:00
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
2024-01-24 13:40:22 +00:00
<p>Include &lt;<a class="el" href="a00716.html" title="GLM_GTX_rotate_normalized_axis">glm/gtx/rotate_normalized_axis.hpp</a>&gt; to use the features of this extension.</p>
2018-05-08 11:51:58 +00:00
<p>Quaternions and matrices rotations around normalized axis. </p>
2017-08-15 19:22:51 +00:00
<h2 class="groupheader">Function Documentation</h2>
2024-01-24 13:40:22 +00:00
<a id="ga50efd7ebca0f7a603bb3cc11e34c708d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga50efd7ebca0f7a603bb3cc11e34c708d">&#9670;&nbsp;</a></span>rotateNormalizedAxis() <span class="overload">[1/2]</span></h2>
2017-08-15 19:22:51 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2018-05-08 11:51:58 +00:00
<td class="memname">GLM_FUNC_DECL mat&lt;4, 4, T, Q&gt; glm::rotateNormalizedAxis </td>
2017-08-17 17:53:21 +00:00
<td>(</td>
<td class="paramtype">mat&lt; 4, 4, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2018-05-08 11:51:58 +00:00
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>, </td>
2017-08-17 17:53:21 +00:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2018-05-08 11:51:58 +00:00
<td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>axis</em>&#160;</td>
2017-08-17 17:53:21 +00:00
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
2018-05-08 11:51:58 +00:00
<p>Builds a rotation 4 * 4 matrix created from a normalized axis and an angle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">m</td><td>Input matrix multiplied by this rotation matrix. </td></tr>
<tr><td class="paramname">angle</td><td>Rotation angle expressed in radians. </td></tr>
<tr><td class="paramname">axis</td><td>Rotation axis, 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>Value type used to build the matrix. Currently supported: half (not recommended), float or double.</td></tr>
</table>
</dd>
</dl>
2024-01-24 13:40:22 +00:00
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00965.html">GLM_GTX_rotate_normalized_axis</a> </dd>
2018-05-08 11:51:58 +00:00
<dd>
- rotate(T angle, T x, T y, T z) </dd>
<dd>
- rotate(mat&lt;4, 4, T, Q&gt; const&amp; m, T angle, T x, T y, T z) </dd>
<dd>
- rotate(T angle, vec&lt;3, T, Q&gt; const&amp; v) </dd></dl>
</div>
</div>
2024-01-24 13:40:22 +00:00
<a id="ga08f9c5411437d528019a25bfc01473d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga08f9c5411437d528019a25bfc01473d1">&#9670;&nbsp;</a></span>rotateNormalizedAxis() <span class="overload">[2/2]</span></h2>
2017-08-17 17:53:21 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2018-09-02 21:34:18 +00:00
<td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::rotateNormalizedAxis </td>
2017-08-17 17:53:21 +00:00
<td>(</td>
2018-09-02 21:34:18 +00:00
<td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
2018-05-08 11:51:58 +00:00
<td class="paramname"><em>q</em>, </td>
2017-08-17 17:53:21 +00:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2018-05-08 11:51:58 +00:00
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>, </td>
2017-08-15 19:22:51 +00:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2018-05-08 11:51:58 +00:00
<td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>axis</em>&#160;</td>
2017-08-15 19:22:51 +00:00
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
2018-05-08 11:51:58 +00:00
<p>Rotates a quaternion from a vector of 3 components normalized axis and an angle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">q</td><td>Source orientation </td></tr>
<tr><td class="paramname">angle</td><td>Angle expressed in radians. </td></tr>
<tr><td class="paramname">axis</td><td>Normalized axis of the rotation, must be normalized.</td></tr>
</table>
</dd>
</dl>
2024-01-24 13:40:22 +00:00
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00965.html">GLM_GTX_rotate_normalized_axis</a> </dd></dl>
2017-08-15 19:22:51 +00:00
</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"/>
2024-01-24 13:40:22 +00:00
</a> 1.8.18
2017-08-15 19:22:51 +00:00
</small></address>
</body>
</html>