glm/doc/api/a00785.html
Christophe Riccio 0c2e470baf Updated API doc
2018-09-02 23:34:18 +02:00

310 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>0.9.9 API documenation: GLM_GTX_vector_query</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">0.9.9 API documenation
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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_GTX_vector_query<div class="ingroups"><a class="el" href="a00705.html">Experimental 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:ga13da4a787a2ff70e95d561fb19ff91b4"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga13da4a787a2ff70e95d561fb19ff91b4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00785.html#ga13da4a787a2ff70e95d561fb19ff91b4">areCollinear</a> (vec&lt; L, T, Q &gt; const &amp;v0, vec&lt; L, T, Q &gt; const &amp;v1, T const &amp;epsilon)</td></tr>
<tr class="separator:ga13da4a787a2ff70e95d561fb19ff91b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac7b95b3f798e3c293262b2bdaad47c57"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gac7b95b3f798e3c293262b2bdaad47c57"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00785.html#gac7b95b3f798e3c293262b2bdaad47c57">areOrthogonal</a> (vec&lt; L, T, Q &gt; const &amp;v0, vec&lt; L, T, Q &gt; const &amp;v1, T const &amp;epsilon)</td></tr>
<tr class="separator:gac7b95b3f798e3c293262b2bdaad47c57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1b091c3d7f9ee3b0708311c001c293e3"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga1b091c3d7f9ee3b0708311c001c293e3"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00785.html#ga1b091c3d7f9ee3b0708311c001c293e3">areOrthonormal</a> (vec&lt; L, T, Q &gt; const &amp;v0, vec&lt; L, T, Q &gt; const &amp;v1, T const &amp;epsilon)</td></tr>
<tr class="separator:ga1b091c3d7f9ee3b0708311c001c293e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf6ec1688eab7442fe96fe4941d5d4e76"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gaf6ec1688eab7442fe96fe4941d5d4e76"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, bool, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00785.html#gaf6ec1688eab7442fe96fe4941d5d4e76">isCompNull</a> (vec&lt; L, T, Q &gt; const &amp;v, T const &amp;epsilon)</td></tr>
<tr class="separator:gaf6ec1688eab7442fe96fe4941d5d4e76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac3c974f459fd75453134fad7ae89a39e"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gac3c974f459fd75453134fad7ae89a39e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00785.html#gac3c974f459fd75453134fad7ae89a39e">isNormalized</a> (vec&lt; L, T, Q &gt; const &amp;v, T const &amp;epsilon)</td></tr>
<tr class="separator:gac3c974f459fd75453134fad7ae89a39e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab4a3637dbcb4bb42dc55caea7a1e0495"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gab4a3637dbcb4bb42dc55caea7a1e0495"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00785.html#gab4a3637dbcb4bb42dc55caea7a1e0495">isNull</a> (vec&lt; L, T, Q &gt; const &amp;v, T const &amp;epsilon)</td></tr>
<tr class="separator:gab4a3637dbcb4bb42dc55caea7a1e0495"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Include &lt;<a class="el" href="a00611.html" title="GLM_GTX_vector_query ">glm/gtx/vector_query.hpp</a>&gt; to use the features of this extension. </p>
<p>Query informations of vector types </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga13da4a787a2ff70e95d561fb19ff91b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga13da4a787a2ff70e95d561fb19ff91b4">&#9670;&nbsp;</a></span>areCollinear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL bool glm::areCollinear </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>v0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether two vectors are collinears. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00785.html" title="Include &lt;glm/gtx/vector_query.hpp&gt; to use the features of this extension. ">GLM_GTX_vector_query</a> extensions. </dd></dl>
</div>
</div>
<a id="gac7b95b3f798e3c293262b2bdaad47c57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac7b95b3f798e3c293262b2bdaad47c57">&#9670;&nbsp;</a></span>areOrthogonal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL bool glm::areOrthogonal </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>v0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether two vectors are orthogonals. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00785.html" title="Include &lt;glm/gtx/vector_query.hpp&gt; to use the features of this extension. ">GLM_GTX_vector_query</a> extensions. </dd></dl>
</div>
</div>
<a id="ga1b091c3d7f9ee3b0708311c001c293e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1b091c3d7f9ee3b0708311c001c293e3">&#9670;&nbsp;</a></span>areOrthonormal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL bool glm::areOrthonormal </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>v0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether two vectors are orthonormal. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00785.html" title="Include &lt;glm/gtx/vector_query.hpp&gt; to use the features of this extension. ">GLM_GTX_vector_query</a> extensions. </dd></dl>
</div>
</div>
<a id="gaf6ec1688eab7442fe96fe4941d5d4e76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf6ec1688eab7442fe96fe4941d5d4e76">&#9670;&nbsp;</a></span>isCompNull()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec&lt;L, bool, Q&gt; glm::isCompNull </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether a each component of a vector is null. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00785.html" title="Include &lt;glm/gtx/vector_query.hpp&gt; to use the features of this extension. ">GLM_GTX_vector_query</a> extensions. </dd></dl>
</div>
</div>
<a id="gac3c974f459fd75453134fad7ae89a39e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac3c974f459fd75453134fad7ae89a39e">&#9670;&nbsp;</a></span>isNormalized()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL bool glm::isNormalized </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether a vector is normalized. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00785.html" title="Include &lt;glm/gtx/vector_query.hpp&gt; to use the features of this extension. ">GLM_GTX_vector_query</a> extensions. </dd></dl>
</div>
</div>
<a id="gab4a3637dbcb4bb42dc55caea7a1e0495"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab4a3637dbcb4bb42dc55caea7a1e0495">&#9670;&nbsp;</a></span>isNull()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL bool glm::isNull </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether a vector is null. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00785.html" title="Include &lt;glm/gtx/vector_query.hpp&gt; to use the features of this extension. ">GLM_GTX_vector_query</a> extensions. </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.14
</small></address>
</body>
</html>