mirror of
https://github.com/g-truc/glm.git
synced 2024-11-25 09:54:35 +00:00
241 lines
12 KiB
HTML
241 lines
12 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_geometric</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_geometric<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:ga9a47ad9ca44bc04eeaac260d42105134"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||
|
|
<tr class="memitem:ga9a47ad9ca44bc04eeaac260d42105134"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER GLM_CONSTEXPR qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00853.html#ga9a47ad9ca44bc04eeaac260d42105134">cross</a> (qua< T, Q > const &q1, qua< T, Q > const &q2)</td></tr>
|
||
|
|
<tr class="memdesc:ga9a47ad9ca44bc04eeaac260d42105134"><td class="mdescLeft"> </td><td class="mdescRight">Compute a cross product. <a href="a00853.html#ga9a47ad9ca44bc04eeaac260d42105134">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga9a47ad9ca44bc04eeaac260d42105134"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:gadaab7b4495755b4102838d7834cd9544"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||
|
|
<tr class="memitem:gadaab7b4495755b4102838d7834cd9544"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00853.html#gadaab7b4495755b4102838d7834cd9544">dot</a> (qua< T, Q > const &x, qua< T, Q > const &y)</td></tr>
|
||
|
|
<tr class="memdesc:gadaab7b4495755b4102838d7834cd9544"><td class="mdescLeft"> </td><td class="mdescRight">Returns dot product of q1 and q2, i.e., q1[0] * q2[0] + q1[1] * q2[1] + ... <a href="a00853.html#gadaab7b4495755b4102838d7834cd9544">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:gadaab7b4495755b4102838d7834cd9544"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:gab703732449be6c7199369b3f9a91ed38"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||
|
|
<tr class="memitem:gab703732449be6c7199369b3f9a91ed38"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00853.html#gab703732449be6c7199369b3f9a91ed38">length</a> (qua< T, Q > const &q)</td></tr>
|
||
|
|
<tr class="memdesc:gab703732449be6c7199369b3f9a91ed38"><td class="mdescLeft"> </td><td class="mdescRight">Returns the norm of a quaternions. <a href="a00853.html#gab703732449be6c7199369b3f9a91ed38">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:gab703732449be6c7199369b3f9a91ed38"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:gabf30e3263fffe8dcc6659aea76ae8927"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||
|
|
<tr class="memitem:gabf30e3263fffe8dcc6659aea76ae8927"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua< T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00853.html#gabf30e3263fffe8dcc6659aea76ae8927">normalize</a> (qua< T, Q > const &q)</td></tr>
|
||
|
|
<tr class="memdesc:gabf30e3263fffe8dcc6659aea76ae8927"><td class="mdescLeft"> </td><td class="mdescRight">Returns the normalized quaternion. <a href="a00853.html#gabf30e3263fffe8dcc6659aea76ae8927">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:gabf30e3263fffe8dcc6659aea76ae8927"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<p>Provides geometric functions for quaternion types</p>
|
||
|
|
<p>Include <<a class="el" href="a00341.html" title="GLM_EXT_quaternion_geometric">glm/ext/quaternion_geometric.hpp</a>> to use the features of this extension.</p>
|
||
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00888.html">Geometric functions</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></dl>
|
||
|
|
<h2 class="groupheader">Function Documentation</h2>
|
||
|
|
<a id="ga9a47ad9ca44bc04eeaac260d42105134"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9a47ad9ca44bc04eeaac260d42105134">◆ </a></span>cross()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">GLM_FUNC_QUALIFIER GLM_CONSTEXPR qua<T, Q> glm::cross </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
||
|
|
<td class="paramname"><em>q1</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">qua< T, Q > const & </td>
|
||
|
|
<td class="paramname"><em>q2</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Compute a cross product. </p>
|
||
|
|
<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>
|
||
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00853.html">GLM_EXT_quaternion_geometric</a> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="gadaab7b4495755b4102838d7834cd9544"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gadaab7b4495755b4102838d7834cd9544">◆ </a></span>dot()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR T glm::dot </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></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Returns dot product of q1 and q2, i.e., q1[0] * q2[0] + q1[1] * q2[1] + ... </p>
|
||
|
|
<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>
|
||
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00853.html">GLM_EXT_quaternion_geometric</a> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="gab703732449be6c7199369b3f9a91ed38"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gab703732449be6c7199369b3f9a91ed38">◆ </a></span>length()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">GLM_FUNC_DECL T glm::length </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 norm of a quaternions. </p>
|
||
|
|
<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>
|
||
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00853.html">GLM_EXT_quaternion_geometric</a> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="gabf30e3263fffe8dcc6659aea76ae8927"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gabf30e3263fffe8dcc6659aea76ae8927">◆ </a></span>normalize()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">GLM_FUNC_DECL qua<T, Q> glm::normalize </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 normalized quaternion. </p>
|
||
|
|
<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>
|
||
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00853.html">GLM_EXT_quaternion_geometric</a> </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>
|