mirror of
https://github.com/g-truc/glm.git
synced 2024-11-23 01:14:34 +00:00
465 lines
23 KiB
HTML
465 lines
23 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_common</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_common<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:ga5b646f1cd4422eb76ab90496bcd0b60a"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||
|
<tr class="memitem:ga5b646f1cd4422eb76ab90496bcd0b60a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00847.html#ga5b646f1cd4422eb76ab90496bcd0b60a">conjugate</a> (qua< T, Q > const &q)</td></tr>
|
||
|
<tr class="memdesc:ga5b646f1cd4422eb76ab90496bcd0b60a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the q conjugate. <a href="a00847.html#ga5b646f1cd4422eb76ab90496bcd0b60a">More...</a><br /></td></tr>
|
||
|
<tr class="separator:ga5b646f1cd4422eb76ab90496bcd0b60a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:ga50db49335150de11562052667537e517"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||
|
<tr class="memitem:ga50db49335150de11562052667537e517"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00847.html#ga50db49335150de11562052667537e517">inverse</a> (qua< T, Q > const &q)</td></tr>
|
||
|
<tr class="memdesc:ga50db49335150de11562052667537e517"><td class="mdescLeft"> </td><td class="mdescRight">Returns the q inverse. <a href="a00847.html#ga50db49335150de11562052667537e517">More...</a><br /></td></tr>
|
||
|
<tr class="separator:ga50db49335150de11562052667537e517"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:ga45722741ea266b4e861938b365c5f362"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||
|
<tr class="memitem:ga45722741ea266b4e861938b365c5f362"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 4, bool, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00847.html#ga45722741ea266b4e861938b365c5f362">isinf</a> (qua< T, Q > const &x)</td></tr>
|
||
|
<tr class="memdesc:ga45722741ea266b4e861938b365c5f362"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if x holds a positive infinity or negative infinity representation in the underlying implementation's set of floating point representations. <a href="a00847.html#ga45722741ea266b4e861938b365c5f362">More...</a><br /></td></tr>
|
||
|
<tr class="separator:ga45722741ea266b4e861938b365c5f362"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:ga1bb55f8963616502e96dc564384d8a03"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||
|
<tr class="memitem:ga1bb55f8963616502e96dc564384d8a03"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 4, bool, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00847.html#ga1bb55f8963616502e96dc564384d8a03">isnan</a> (qua< T, Q > const &x)</td></tr>
|
||
|
<tr class="memdesc:ga1bb55f8963616502e96dc564384d8a03"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if x holds a NaN (not a number) representation in the underlying implementation's set of floating point representations. <a href="a00847.html#ga1bb55f8963616502e96dc564384d8a03">More...</a><br /></td></tr>
|
||
|
<tr class="separator:ga1bb55f8963616502e96dc564384d8a03"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:gaacd3d0591852faa4bc291b61da88ad44"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||
|
<tr class="memitem:gaacd3d0591852faa4bc291b61da88ad44"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00847.html#gaacd3d0591852faa4bc291b61da88ad44">lerp</a> (qua< T, Q > const &x, qua< T, Q > const &y, T a)</td></tr>
|
||
|
<tr class="memdesc:gaacd3d0591852faa4bc291b61da88ad44"><td class="mdescLeft"> </td><td class="mdescRight">Linear interpolation of two quaternions. <a href="a00847.html#gaacd3d0591852faa4bc291b61da88ad44">More...</a><br /></td></tr>
|
||
|
<tr class="separator:gaacd3d0591852faa4bc291b61da88ad44"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:gafbfe587b8da11fb89a30c3d67dd5ccc2"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||
|
<tr class="memitem:gafbfe587b8da11fb89a30c3d67dd5ccc2"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00847.html#gafbfe587b8da11fb89a30c3d67dd5ccc2">mix</a> (qua< T, Q > const &x, qua< T, Q > const &y, T a)</td></tr>
|
||
|
<tr class="memdesc:gafbfe587b8da11fb89a30c3d67dd5ccc2"><td class="mdescLeft"> </td><td class="mdescRight">Spherical linear interpolation of two quaternions. <a href="a00847.html#gafbfe587b8da11fb89a30c3d67dd5ccc2">More...</a><br /></td></tr>
|
||
|
<tr class="separator:gafbfe587b8da11fb89a30c3d67dd5ccc2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:gae7fc3c945be366b9942b842f55da428a"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||
|
<tr class="memitem:gae7fc3c945be366b9942b842f55da428a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00847.html#gae7fc3c945be366b9942b842f55da428a">slerp</a> (qua< T, Q > const &x, qua< T, Q > const &y, T a)</td></tr>
|
||
|
<tr class="memdesc:gae7fc3c945be366b9942b842f55da428a"><td class="mdescLeft"> </td><td class="mdescRight">Spherical linear interpolation of two quaternions. <a href="a00847.html#gae7fc3c945be366b9942b842f55da428a">More...</a><br /></td></tr>
|
||
|
<tr class="separator:gae7fc3c945be366b9942b842f55da428a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:ga8514da9c52cfee86f716cc0933ce118a"><td class="memTemplParams" colspan="2">template<typename T , typename S , qualifier Q> </td></tr>
|
||
|
<tr class="memitem:ga8514da9c52cfee86f716cc0933ce118a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00847.html#ga8514da9c52cfee86f716cc0933ce118a">slerp</a> (qua< T, Q > const &x, qua< T, Q > const &y, T a, S k)</td></tr>
|
||
|
<tr class="memdesc:ga8514da9c52cfee86f716cc0933ce118a"><td class="mdescLeft"> </td><td class="mdescRight">Spherical linear interpolation of two quaternions with multiple spins over rotation axis. <a href="a00847.html#ga8514da9c52cfee86f716cc0933ce118a">More...</a><br /></td></tr>
|
||
|
<tr class="separator:ga8514da9c52cfee86f716cc0933ce118a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
</table>
|
||
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
<p>Provides common functions for quaternion types</p>
|
||
|
<p>Include <<a class="el" href="a00323.html" title="GLM_EXT_quaternion_common">glm/ext/quaternion_common.hpp</a>> to use the features of this extension.</p>
|
||
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00857.html">GLM_EXT_scalar_common</a> </dd>
|
||
|
<dd>
|
||
|
<a class="el" href="a00868.html">GLM_EXT_vector_common</a> </dd>
|
||
|
<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>
|
||
|
<dd>
|
||
|
<a class="el" href="a00855.html">GLM_EXT_quaternion_transform</a> </dd></dl>
|
||
|
<h2 class="groupheader">Function Documentation</h2>
|
||
|
<a id="ga5b646f1cd4422eb76ab90496bcd0b60a"></a>
|
||
|
<h2 class="memtitle"><span class="permalink"><a href="#ga5b646f1cd4422eb76ab90496bcd0b60a">◆ </a></span>conjugate()</h2>
|
||
|
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR qua<T, Q> glm::conjugate </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 q conjugate. </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="ga50db49335150de11562052667537e517"></a>
|
||
|
<h2 class="memtitle"><span class="permalink"><a href="#ga50db49335150de11562052667537e517">◆ </a></span>inverse()</h2>
|
||
|
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR qua<T, Q> glm::inverse </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 q inverse. </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="ga45722741ea266b4e861938b365c5f362"></a>
|
||
|
<h2 class="memtitle"><span class="permalink"><a href="#ga45722741ea266b4e861938b365c5f362">◆ </a></span>isinf()</h2>
|
||
|
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">GLM_FUNC_DECL vec<4, bool, Q> glm::isinf </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">qua< T, Q > const & </td>
|
||
|
<td class="paramname"><em>x</em></td><td>)</td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Returns true if x holds a positive infinity or negative infinity representation in the underlying implementation's set of floating point representations. </p>
|
||
|
<p>Returns false otherwise, including for implementations with no infinity representations.</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="ga1bb55f8963616502e96dc564384d8a03"></a>
|
||
|
<h2 class="memtitle"><span class="permalink"><a href="#ga1bb55f8963616502e96dc564384d8a03">◆ </a></span>isnan()</h2>
|
||
|
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">GLM_FUNC_DECL vec<4, bool, Q> glm::isnan </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">qua< T, Q > const & </td>
|
||
|
<td class="paramname"><em>x</em></td><td>)</td>
|
||
|
<td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Returns true if x holds a NaN (not a number) representation in the underlying implementation's set of floating point representations. </p>
|
||
|
<p>Returns false otherwise, including for implementations with no NaN representations.</p>
|
||
|
<p>/!\ When using compiler fast math, this function may fail.</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="gaacd3d0591852faa4bc291b61da88ad44"></a>
|
||
|
<h2 class="memtitle"><span class="permalink"><a href="#gaacd3d0591852faa4bc291b61da88ad44">◆ </a></span>lerp()</h2>
|
||
|
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR qua<T, Q> glm::lerp </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">qua< T, Q > const & </td>
|
||
|
<td class="paramname"><em>x</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">qua< T, Q > const & </td>
|
||
|
<td class="paramname"><em>y</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">T </td>
|
||
|
<td class="paramname"><em>a</em> </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td></td>
|
||
|
<td>)</td>
|
||
|
<td></td><td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Linear interpolation of two quaternions. </p>
|
||
|
<p>The interpolation is oriented.</p>
|
||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
<table class="params">
|
||
|
<tr><td class="paramname">x</td><td>A quaternion </td></tr>
|
||
|
<tr><td class="paramname">y</td><td>A quaternion </td></tr>
|
||
|
<tr><td class="paramname">a</td><td>Interpolation factor. The interpolation is defined in the range [0, 1].</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="gafbfe587b8da11fb89a30c3d67dd5ccc2"></a>
|
||
|
<h2 class="memtitle"><span class="permalink"><a href="#gafbfe587b8da11fb89a30c3d67dd5ccc2">◆ </a></span>mix()</h2>
|
||
|
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">GLM_FUNC_DECL qua<T, Q> glm::mix </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">qua< T, Q > const & </td>
|
||
|
<td class="paramname"><em>x</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">qua< T, Q > const & </td>
|
||
|
<td class="paramname"><em>y</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">T </td>
|
||
|
<td class="paramname"><em>a</em> </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td></td>
|
||
|
<td>)</td>
|
||
|
<td></td><td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Spherical linear interpolation of two quaternions. </p>
|
||
|
<p>The interpolation is oriented and the rotation is performed at constant speed. For short path spherical linear interpolation, use the slerp function.</p>
|
||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
<table class="params">
|
||
|
<tr><td class="paramname">x</td><td>A quaternion </td></tr>
|
||
|
<tr><td class="paramname">y</td><td>A quaternion </td></tr>
|
||
|
<tr><td class="paramname">a</td><td>Interpolation factor. The interpolation is defined beyond the range [0, 1].</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>
|
||
|
<dl class="section see"><dt>See also</dt><dd>- slerp(qua<T, Q> const& x, qua<T, Q> const& y, T const& a) </dd></dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a id="gae7fc3c945be366b9942b842f55da428a"></a>
|
||
|
<h2 class="memtitle"><span class="permalink"><a href="#gae7fc3c945be366b9942b842f55da428a">◆ </a></span>slerp() <span class="overload">[1/2]</span></h2>
|
||
|
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">GLM_FUNC_DECL qua<T, Q> glm::slerp </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">qua< T, Q > const & </td>
|
||
|
<td class="paramname"><em>x</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">qua< T, Q > const & </td>
|
||
|
<td class="paramname"><em>y</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">T </td>
|
||
|
<td class="paramname"><em>a</em> </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td></td>
|
||
|
<td>)</td>
|
||
|
<td></td><td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Spherical linear interpolation of two quaternions. </p>
|
||
|
<p>The interpolation always take the short path and the rotation is performed at constant speed.</p>
|
||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
<table class="params">
|
||
|
<tr><td class="paramname">x</td><td>A quaternion </td></tr>
|
||
|
<tr><td class="paramname">y</td><td>A quaternion </td></tr>
|
||
|
<tr><td class="paramname">a</td><td>Interpolation factor. The interpolation is defined beyond the range [0, 1].</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="ga8514da9c52cfee86f716cc0933ce118a"></a>
|
||
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8514da9c52cfee86f716cc0933ce118a">◆ </a></span>slerp() <span class="overload">[2/2]</span></h2>
|
||
|
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">GLM_FUNC_DECL qua<T, Q> glm::slerp </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype">qua< T, Q > const & </td>
|
||
|
<td class="paramname"><em>x</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">qua< T, Q > const & </td>
|
||
|
<td class="paramname"><em>y</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">T </td>
|
||
|
<td class="paramname"><em>a</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">S </td>
|
||
|
<td class="paramname"><em>k</em> </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td></td>
|
||
|
<td>)</td>
|
||
|
<td></td><td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
|
||
|
<p>Spherical linear interpolation of two quaternions with multiple spins over rotation axis. </p>
|
||
|
<p>The interpolation always take the short path when the spin count is positive and long path when count is negative. Rotation is performed at constant speed.</p>
|
||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
<table class="params">
|
||
|
<tr><td class="paramname">x</td><td>A quaternion </td></tr>
|
||
|
<tr><td class="paramname">y</td><td>A quaternion </td></tr>
|
||
|
<tr><td class="paramname">a</td><td>Interpolation factor. The interpolation is defined beyond the range [0, 1]. </td></tr>
|
||
|
<tr><td class="paramname">k</td><td>Additional spin count. If Value is negative interpolation will be on "long" path.</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">S</td><td>An integer 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>
|