mirror of https://github.com/g-truc/glm.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
288 lines
14 KiB
HTML
288 lines
14 KiB
HTML
<!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_transform</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&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_EXT_quaternion_transform<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:gaab2d37ef7265819f1d2939b9dc2c52ac"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:gaab2d37ef7265819f1d2939b9dc2c52ac"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00855.html#gaab2d37ef7265819f1d2939b9dc2c52ac">exp</a> (qua< T, Q > const &q)</td></tr>
|
|
<tr class="memdesc:gaab2d37ef7265819f1d2939b9dc2c52ac"><td class="mdescLeft"> </td><td class="mdescRight">Returns a exponential of a quaternion. <a href="a00855.html#gaab2d37ef7265819f1d2939b9dc2c52ac">More...</a><br /></td></tr>
|
|
<tr class="separator:gaab2d37ef7265819f1d2939b9dc2c52ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa5f7b20e296671b16ce25a2ab7ad5473"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:gaa5f7b20e296671b16ce25a2ab7ad5473"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00855.html#gaa5f7b20e296671b16ce25a2ab7ad5473">log</a> (qua< T, Q > const &q)</td></tr>
|
|
<tr class="memdesc:gaa5f7b20e296671b16ce25a2ab7ad5473"><td class="mdescLeft"> </td><td class="mdescRight">Returns a logarithm of a quaternion. <a href="a00855.html#gaa5f7b20e296671b16ce25a2ab7ad5473">More...</a><br /></td></tr>
|
|
<tr class="separator:gaa5f7b20e296671b16ce25a2ab7ad5473"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4975ffcacd312a8c0bbd046a76c5607e"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga4975ffcacd312a8c0bbd046a76c5607e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00855.html#ga4975ffcacd312a8c0bbd046a76c5607e">pow</a> (qua< T, Q > const &q, T y)</td></tr>
|
|
<tr class="memdesc:ga4975ffcacd312a8c0bbd046a76c5607e"><td class="mdescLeft"> </td><td class="mdescRight">Returns a quaternion raised to a power. <a href="a00855.html#ga4975ffcacd312a8c0bbd046a76c5607e">More...</a><br /></td></tr>
|
|
<tr class="separator:ga4975ffcacd312a8c0bbd046a76c5607e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabfc57de6d4d2e11970f54119c5ccf0f5"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:gabfc57de6d4d2e11970f54119c5ccf0f5"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00855.html#gabfc57de6d4d2e11970f54119c5ccf0f5">rotate</a> (qua< T, Q > const &q, T const &angle, vec< 3, T, Q > const &axis)</td></tr>
|
|
<tr class="memdesc:gabfc57de6d4d2e11970f54119c5ccf0f5"><td class="mdescLeft"> </td><td class="mdescRight">Rotates a quaternion from a vector of 3 components axis and an angle. <a href="a00855.html#gabfc57de6d4d2e11970f54119c5ccf0f5">More...</a><br /></td></tr>
|
|
<tr class="separator:gabfc57de6d4d2e11970f54119c5ccf0f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga64b7b255ed7bcba616fe6b44470b022e"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga64b7b255ed7bcba616fe6b44470b022e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00855.html#ga64b7b255ed7bcba616fe6b44470b022e">sqrt</a> (qua< T, Q > const &q)</td></tr>
|
|
<tr class="memdesc:ga64b7b255ed7bcba616fe6b44470b022e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the square root of a quaternion. <a href="a00855.html#ga64b7b255ed7bcba616fe6b44470b022e">More...</a><br /></td></tr>
|
|
<tr class="separator:ga64b7b255ed7bcba616fe6b44470b022e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Provides transformation functions for quaternion types</p>
|
|
<p>Include <<a class="el" href="a00347.html" title="GLM_EXT_quaternion_transform">glm/ext/quaternion_transform.hpp</a>> 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="a00856.html">GLM_EXT_quaternion_trigonometric</a> </dd></dl>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="gaab2d37ef7265819f1d2939b9dc2c52ac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaab2d37ef7265819f1d2939b9dc2c52ac">◆ </a></span>exp()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL qua<T, Q> glm::exp </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 a exponential of a quaternion. </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>
|
|
<a id="gaa5f7b20e296671b16ce25a2ab7ad5473"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaa5f7b20e296671b16ce25a2ab7ad5473">◆ </a></span>log()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL qua<T, Q> glm::log </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 a logarithm of a quaternion. </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>
|
|
<a id="ga4975ffcacd312a8c0bbd046a76c5607e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga4975ffcacd312a8c0bbd046a76c5607e">◆ </a></span>pow()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL qua<T, Q> glm::pow </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">T </td>
|
|
<td class="paramname"><em>y</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a quaternion raised to a power. </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>
|
|
<a id="gabfc57de6d4d2e11970f54119c5ccf0f5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gabfc57de6d4d2e11970f54119c5ccf0f5">◆ </a></span>rotate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL qua<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">T const & </td>
|
|
<td class="paramname"><em>angle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vec< 3, T, Q > const & </td>
|
|
<td class="paramname"><em>axis</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Rotates a quaternion from a vector of 3 components 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>Axis of the rotation</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
|
|
<tr><td class="paramname">Q</td><td>Value from qualifier enum </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga64b7b255ed7bcba616fe6b44470b022e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga64b7b255ed7bcba616fe6b44470b022e">◆ </a></span>sqrt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL qua<T, Q> glm::sqrt </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 square root of a quaternion. </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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.18
|
|
</small></address>
|
|
</body>
|
|
</html>
|