glm/doc/api/a00036_source.html

136 lines
20 KiB
HTML
Raw Normal View History

2015-08-02 08:23:00 +00:00
<!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.10"/>
<title>0.9.7: func_trigonometric.hpp Source File</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="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.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">0.9.7
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_275089585c7fc1b5fd5d7d42c69cb1da.html">D:</a></li><li class="navelem"><a class="el" href="dir_7b98f88bffbed4b390b5f8f520d9c08e.html">Source</a></li><li class="navelem"><a class="el" href="dir_1f76e953200861345293ade84ac7fb6c.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_e29b03b892e0e25920d021a614d4db9b.html">glm</a></li><li class="navelem"><a class="el" href="dir_5ce58d942b2d0776e17a9a58abc01e04.html">glm</a></li><li class="navelem"><a class="el" href="dir_e529a619cfdec1fa4c331fb042fd332f.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">func_trigonometric.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00036.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00105.html">setup.hpp</a>&quot;</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00092.html">precision.hpp</a>&quot;</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00146.html">glm</a></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;{</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00158.html#ga0fd3ad793538521f76fa30db7f6edfed">radians</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; <a class="code" href="a00158.html#ga402144a18234e642b702bf585599b46d">degrees</a>);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00158.html#ga402144a18234e642b702bf585599b46d">degrees</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; <a class="code" href="a00158.html#ga0fd3ad793538521f76fa30db7f6edfed">radians</a>);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00158.html#ga4a0ddceb6b1e64ce0e4da209dcb021d5">sin</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; <a class="code" href="a00177.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00158.html#ga728fd86f14609e37d83f82429995b7b3">cos</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; <a class="code" href="a00177.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00158.html#gab3ae890c38b7d3aa4d5e00998fd296b2">tan</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; <a class="code" href="a00177.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>); </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00158.html#ga88e29b8289e882859d76a25798dd9490">asin</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; x);</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00158.html#ga58ad259b788528fe0a4bd2eeb5e381cc">acos</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; x);</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00158.html#gae8f22458bba8f2321ceb1bfc4a543216">atan</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; y, vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; x);</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00158.html#gae8f22458bba8f2321ceb1bfc4a543216">atan</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; y_over_x);</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00158.html#gad8f89c12efe6f8d3ae8046625b266254">sinh</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; <a class="code" href="a00177.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00158.html#ga660582a4e5e843b6c1cd535777e8c295">cosh</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; <a class="code" href="a00177.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00158.html#ga234e904a0075f88654a594b5f837711f">tanh</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; <a class="code" href="a00177.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00158.html#ga72bf44c1984e1afb63acf821ba33cac7">asinh</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; x);</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; </div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00158.html#ga3f368ad3e1883b60748ca2634d816104">acosh</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; x);</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160;</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00158.html#gaffa8decdd8620759f4e6fe4834768b87">atanh</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; x);</div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160;</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;<span class="preprocessor">#include &quot;func_trigonometric.inl&quot;</span></div>
<div class="ttc" id="a00158_html_gae8f22458bba8f2321ceb1bfc4a543216"><div class="ttname"><a href="a00158.html#gae8f22458bba8f2321ceb1bfc4a543216">glm::atan</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; atan(vecType&lt; T, P &gt; const &amp;y_over_x)</div><div class="ttdoc">Arc tangent. </div></div>
<div class="ttc" id="a00158_html_ga58ad259b788528fe0a4bd2eeb5e381cc"><div class="ttname"><a href="a00158.html#ga58ad259b788528fe0a4bd2eeb5e381cc">glm::acos</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; acos(vecType&lt; T, P &gt; const &amp;x)</div><div class="ttdoc">Arc cosine. </div></div>
<div class="ttc" id="a00158_html_ga234e904a0075f88654a594b5f837711f"><div class="ttname"><a href="a00158.html#ga234e904a0075f88654a594b5f837711f">glm::tanh</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; tanh(vecType&lt; T, P &gt; const &amp;angle)</div><div class="ttdoc">Returns the hyperbolic tangent function, sinh(angle) / cosh(angle) </div></div>
<div class="ttc" id="a00158_html_ga660582a4e5e843b6c1cd535777e8c295"><div class="ttname"><a href="a00158.html#ga660582a4e5e843b6c1cd535777e8c295">glm::cosh</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; cosh(vecType&lt; T, P &gt; const &amp;angle)</div><div class="ttdoc">Returns the hyperbolic cosine function, (exp(x) + exp(-x)) / 2. </div></div>
<div class="ttc" id="a00158_html_ga72bf44c1984e1afb63acf821ba33cac7"><div class="ttname"><a href="a00158.html#ga72bf44c1984e1afb63acf821ba33cac7">glm::asinh</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; asinh(vecType&lt; T, P &gt; const &amp;x)</div><div class="ttdoc">Arc hyperbolic sine; returns the inverse of sinh. </div></div>
<div class="ttc" id="a00158_html_ga0fd3ad793538521f76fa30db7f6edfed"><div class="ttname"><a href="a00158.html#ga0fd3ad793538521f76fa30db7f6edfed">glm::radians</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; radians(vecType&lt; T, P &gt; const &amp;degrees)</div><div class="ttdoc">Converts degrees to radians and returns the result. </div></div>
<div class="ttc" id="a00158_html_ga728fd86f14609e37d83f82429995b7b3"><div class="ttname"><a href="a00158.html#ga728fd86f14609e37d83f82429995b7b3">glm::cos</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; cos(vecType&lt; T, P &gt; const &amp;angle)</div><div class="ttdoc">The standard trigonometric cosine function. </div></div>
<div class="ttc" id="a00158_html_ga4a0ddceb6b1e64ce0e4da209dcb021d5"><div class="ttname"><a href="a00158.html#ga4a0ddceb6b1e64ce0e4da209dcb021d5">glm::sin</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; sin(vecType&lt; T, P &gt; const &amp;angle)</div><div class="ttdoc">The standard trigonometric sine function. </div></div>
<div class="ttc" id="a00158_html_gad8f89c12efe6f8d3ae8046625b266254"><div class="ttname"><a href="a00158.html#gad8f89c12efe6f8d3ae8046625b266254">glm::sinh</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; sinh(vecType&lt; T, P &gt; const &amp;angle)</div><div class="ttdoc">Returns the hyperbolic sine function, (exp(x) - exp(-x)) / 2. </div></div>
<div class="ttc" id="a00158_html_ga402144a18234e642b702bf585599b46d"><div class="ttname"><a href="a00158.html#ga402144a18234e642b702bf585599b46d">glm::degrees</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; degrees(vecType&lt; T, P &gt; const &amp;radians)</div><div class="ttdoc">Converts radians to degrees and returns the result. </div></div>
<div class="ttc" id="a00158_html_gab3ae890c38b7d3aa4d5e00998fd296b2"><div class="ttname"><a href="a00158.html#gab3ae890c38b7d3aa4d5e00998fd296b2">glm::tan</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; tan(vecType&lt; T, P &gt; const &amp;angle)</div><div class="ttdoc">The standard trigonometric tangent function. </div></div>
<div class="ttc" id="a00146_html"><div class="ttname"><a href="a00146.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00040">_noise.hpp:40</a></div></div>
<div class="ttc" id="a00105_html"><div class="ttname"><a href="a00105.html">setup.hpp</a></div><div class="ttdoc">OpenGL Mathematics (glm.g-truc.net) </div></div>
<div class="ttc" id="a00177_html_gad4a4448baedb198b2b1e7880d2544dc9"><div class="ttname"><a href="a00177.html#gad4a4448baedb198b2b1e7880d2544dc9">glm::angle</a></div><div class="ttdeci">GLM_FUNC_DECL T angle(tquat&lt; T, P &gt; const &amp;x)</div><div class="ttdoc">Returns the quaternion rotation angle. </div></div>
<div class="ttc" id="a00158_html_ga3f368ad3e1883b60748ca2634d816104"><div class="ttname"><a href="a00158.html#ga3f368ad3e1883b60748ca2634d816104">glm::acosh</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; acosh(vecType&lt; T, P &gt; const &amp;x)</div><div class="ttdoc">Arc hyperbolic cosine; returns the non-negative inverse of cosh. </div></div>
<div class="ttc" id="a00092_html"><div class="ttname"><a href="a00092.html">precision.hpp</a></div><div class="ttdoc">OpenGL Mathematics (glm.g-truc.net) </div></div>
<div class="ttc" id="a00158_html_ga88e29b8289e882859d76a25798dd9490"><div class="ttname"><a href="a00158.html#ga88e29b8289e882859d76a25798dd9490">glm::asin</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; asin(vecType&lt; T, P &gt; const &amp;x)</div><div class="ttdoc">Arc sine. </div></div>
<div class="ttc" id="a00158_html_gaffa8decdd8620759f4e6fe4834768b87"><div class="ttname"><a href="a00158.html#gaffa8decdd8620759f4e6fe4834768b87">glm::atanh</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; atanh(vecType&lt; T, P &gt; const &amp;x)</div><div class="ttdoc">Arc hyperbolic tangent; returns the inverse of tanh. </div></div>
</div><!-- fragment --></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.10
</small></address>
</body>
</html>