Updated API documentation
This commit is contained in:
Christophe Riccio
@@ -4,7 +4,7 @@
|
||||
<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.10"/>
|
||||
<title>0.9.9 API documenation: GLM_GTX_polar_coordinates</title>
|
||||
<title>0.9.9 API documenation: GLM_GTX_norm</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>
|
||||
@@ -78,63 +78,257 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
<div class="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">GLM_GTX_polar_coordinates<div class="ingroups"><a class="el" href="a00148.html">Experimental extensions</a></div></div> </div>
|
||||
<div class="title">GLM_GTX_norm<div class="ingroups"><a class="el" href="a00154.html">Experimental extensions</a></div></div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Include <<a class="el" href="a00080.html" title="GLM_GTX_polar_coordinates ">glm/gtx/polar_coordinates.hpp</a>> to use the features of this extension.
|
||||
<p>Include <<a class="el" href="a00071.html" title="GLM_GTX_norm ">glm/gtx/norm.hpp</a>> to use the features of this extension.
|
||||
<a href="#details">More...</a></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr class="memitem:ga1821d5b3324201e60a9e2823d0b5d0c8"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga1821d5b3324201e60a9e2823d0b5d0c8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#ga1821d5b3324201e60a9e2823d0b5d0c8">euclidean</a> (vec< 2, T, Q > const &polar)</td></tr>
|
||||
<tr class="memdesc:ga1821d5b3324201e60a9e2823d0b5d0c8"><td class="mdescLeft"> </td><td class="mdescRight">Convert Polar to Euclidean coordinates. <a href="a00210.html#ga1821d5b3324201e60a9e2823d0b5d0c8">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga1821d5b3324201e60a9e2823d0b5d0c8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gab83ac2c0e55b684b06b6c46c28b1590d"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gab83ac2c0e55b684b06b6c46c28b1590d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#gab83ac2c0e55b684b06b6c46c28b1590d">polar</a> (vec< 3, T, Q > const &euclidean)</td></tr>
|
||||
<tr class="memdesc:gab83ac2c0e55b684b06b6c46c28b1590d"><td class="mdescLeft"> </td><td class="mdescRight">Convert Euclidean to Polar coordinates, x is the xz distance, y, the latitude and z the longitude. <a href="a00210.html#gab83ac2c0e55b684b06b6c46c28b1590d">More...</a><br /></td></tr>
|
||||
<tr class="separator:gab83ac2c0e55b684b06b6c46c28b1590d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga85660f1b79f66c09c7b5a6f80e68c89f"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga85660f1b79f66c09c7b5a6f80e68c89f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#ga85660f1b79f66c09c7b5a6f80e68c89f">distance2</a> (vec< L, T, Q > const &p0, vec< L, T, Q > const &p1)</td></tr>
|
||||
<tr class="memdesc:ga85660f1b79f66c09c7b5a6f80e68c89f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the squared distance between p0 and p1, i.e., length2(p0 - p1). <a href="a00210.html#ga85660f1b79f66c09c7b5a6f80e68c89f">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga85660f1b79f66c09c7b5a6f80e68c89f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gae2fc0b2aa967bebfd6a244700bff6997"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gae2fc0b2aa967bebfd6a244700bff6997"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#gae2fc0b2aa967bebfd6a244700bff6997">l1Norm</a> (vec< 3, T, Q > const &x, vec< 3, T, Q > const &y)</td></tr>
|
||||
<tr class="memdesc:gae2fc0b2aa967bebfd6a244700bff6997"><td class="mdescLeft"> </td><td class="mdescRight">Returns the L1 norm between x and y. <a href="a00210.html#gae2fc0b2aa967bebfd6a244700bff6997">More...</a><br /></td></tr>
|
||||
<tr class="separator:gae2fc0b2aa967bebfd6a244700bff6997"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga1a7491e2037ceeb37f83ce41addfc0be"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga1a7491e2037ceeb37f83ce41addfc0be"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#ga1a7491e2037ceeb37f83ce41addfc0be">l1Norm</a> (vec< 3, T, Q > const &v)</td></tr>
|
||||
<tr class="memdesc:ga1a7491e2037ceeb37f83ce41addfc0be"><td class="mdescLeft"> </td><td class="mdescRight">Returns the L1 norm of v. <a href="a00210.html#ga1a7491e2037ceeb37f83ce41addfc0be">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga1a7491e2037ceeb37f83ce41addfc0be"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga41340b2ef40a9307ab0f137181565168"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga41340b2ef40a9307ab0f137181565168"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#ga41340b2ef40a9307ab0f137181565168">l2Norm</a> (vec< 3, T, Q > const &x, vec< 3, T, Q > const &y)</td></tr>
|
||||
<tr class="memdesc:ga41340b2ef40a9307ab0f137181565168"><td class="mdescLeft"> </td><td class="mdescRight">Returns the L2 norm between x and y. <a href="a00210.html#ga41340b2ef40a9307ab0f137181565168">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga41340b2ef40a9307ab0f137181565168"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gae288bde8f0e41fb4ed62e65137b18cba"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gae288bde8f0e41fb4ed62e65137b18cba"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#gae288bde8f0e41fb4ed62e65137b18cba">l2Norm</a> (vec< 3, T, Q > const &x)</td></tr>
|
||||
<tr class="memdesc:gae288bde8f0e41fb4ed62e65137b18cba"><td class="mdescLeft"> </td><td class="mdescRight">Returns the L2 norm of v. <a href="a00210.html#gae288bde8f0e41fb4ed62e65137b18cba">More...</a><br /></td></tr>
|
||||
<tr class="separator:gae288bde8f0e41fb4ed62e65137b18cba"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga8d1789651050adb7024917984b41c3de"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga8d1789651050adb7024917984b41c3de"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#ga8d1789651050adb7024917984b41c3de">length2</a> (vec< L, T, Q > const &x)</td></tr>
|
||||
<tr class="memdesc:ga8d1789651050adb7024917984b41c3de"><td class="mdescLeft"> </td><td class="mdescRight">Returns the squared length of x. <a href="a00210.html#ga8d1789651050adb7024917984b41c3de">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga8d1789651050adb7024917984b41c3de"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gacad23d30497eb16f67709f2375d1f66a"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gacad23d30497eb16f67709f2375d1f66a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#gacad23d30497eb16f67709f2375d1f66a">lxNorm</a> (vec< 3, T, Q > const &x, vec< 3, T, Q > const &y, unsigned int Depth)</td></tr>
|
||||
<tr class="memdesc:gacad23d30497eb16f67709f2375d1f66a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the L norm between x and y. <a href="a00210.html#gacad23d30497eb16f67709f2375d1f66a">More...</a><br /></td></tr>
|
||||
<tr class="separator:gacad23d30497eb16f67709f2375d1f66a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gac61b6d81d796d6eb4d4183396a19ab91"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gac61b6d81d796d6eb4d4183396a19ab91"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00210.html#gac61b6d81d796d6eb4d4183396a19ab91">lxNorm</a> (vec< 3, T, Q > const &x, unsigned int Depth)</td></tr>
|
||||
<tr class="memdesc:gac61b6d81d796d6eb4d4183396a19ab91"><td class="mdescLeft"> </td><td class="mdescRight">Returns the L norm of v. <a href="a00210.html#gac61b6d81d796d6eb4d4183396a19ab91">More...</a><br /></td></tr>
|
||||
<tr class="separator:gac61b6d81d796d6eb4d4183396a19ab91"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Include <<a class="el" href="a00080.html" title="GLM_GTX_polar_coordinates ">glm/gtx/polar_coordinates.hpp</a>> to use the features of this extension. </p>
|
||||
<p>Conversion from Euclidean space to polar space and revert. </p>
|
||||
<p>Include <<a class="el" href="a00071.html" title="GLM_GTX_norm ">glm/gtx/norm.hpp</a>> to use the features of this extension. </p>
|
||||
<p>Various ways to compute vector norms. </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga1821d5b3324201e60a9e2823d0b5d0c8"></a>
|
||||
<a class="anchor" id="ga85660f1b79f66c09c7b5a6f80e68c89f"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL vec<3, T, Q> glm::euclidean </td>
|
||||
<td class="memname">GLM_FUNC_DECL T glm::distance2 </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< 2, T, Q > const & </td>
|
||||
<td class="paramname"><em>polar</em></td><td>)</td>
|
||||
<td class="paramtype">vec< L, T, Q > const & </td>
|
||||
<td class="paramname"><em>p0</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< L, T, Q > const & </td>
|
||||
<td class="paramname"><em>p1</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Convert Polar to Euclidean coordinates. </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00210.html" title="Include <glm/gtx/polar_coordinates.hpp> to use the features of this extension. ">GLM_GTX_polar_coordinates</a> </dd></dl>
|
||||
<p>Returns the squared distance between p0 and p1, i.e., length2(p0 - p1). </p>
|
||||
<p>From GLM_GTX_norm extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gab83ac2c0e55b684b06b6c46c28b1590d"></a>
|
||||
<a class="anchor" id="gae2fc0b2aa967bebfd6a244700bff6997"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL vec<3, T, Q> glm::polar </td>
|
||||
<td class="memname">GLM_FUNC_DECL T glm::l1Norm </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< 3, T, Q > const & </td>
|
||||
<td class="paramname"><em>euclidean</em></td><td>)</td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< 3, 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 the L1 norm between x and y. </p>
|
||||
<p>From GLM_GTX_norm extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga1a7491e2037ceeb37f83ce41addfc0be"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL T glm::l1Norm </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< 3, T, Q > const & </td>
|
||||
<td class="paramname"><em>v</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Convert Euclidean to Polar coordinates, x is the xz distance, y, the latitude and z the longitude. </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00210.html" title="Include <glm/gtx/polar_coordinates.hpp> to use the features of this extension. ">GLM_GTX_polar_coordinates</a> </dd></dl>
|
||||
<p>Returns the L1 norm of v. </p>
|
||||
<p>From GLM_GTX_norm extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga41340b2ef40a9307ab0f137181565168"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL T glm::l2Norm </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< 3, T, Q > const & </td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< 3, 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 the L2 norm between x and y. </p>
|
||||
<p>From GLM_GTX_norm extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gae288bde8f0e41fb4ed62e65137b18cba"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL T glm::l2Norm </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< 3, T, Q > const & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Returns the L2 norm of v. </p>
|
||||
<p>From GLM_GTX_norm extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga8d1789651050adb7024917984b41c3de"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL T glm::length2 </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< L, T, Q > const & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Returns the squared length of x. </p>
|
||||
<p>From GLM_GTX_norm extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gacad23d30497eb16f67709f2375d1f66a"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL T glm::lxNorm </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< 3, T, Q > const & </td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< 3, T, Q > const & </td>
|
||||
<td class="paramname"><em>y</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">unsigned int </td>
|
||||
<td class="paramname"><em>Depth</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Returns the L norm between x and y. </p>
|
||||
<p>From GLM_GTX_norm extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gac61b6d81d796d6eb4d4183396a19ab91"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL T glm::lxNorm </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< 3, T, Q > const & </td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">unsigned int </td>
|
||||
<td class="paramname"><em>Depth</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Returns the L norm of v. </p>
|
||||
<p>From GLM_GTX_norm extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user