Updated API

This commit is contained in:
Christophe Riccio
2014-11-30 21:57:58 +01:00
parent a1e34d02ff
commit 6285ed64d3
385 changed files with 60361 additions and 60106 deletions

View File

@@ -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.8"/>
<title>0.9.6: spline.hpp Source File</title>
<title>0.9.6: std_based_type.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>
@@ -46,54 +46,51 @@
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">spline.hpp</div> </div>
<div class="title">std_based_type.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00109.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="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment">// Dependency:</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#include &quot;../gtx/optimum_pow.hpp&quot;</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(GLM_EXT_INCLUDED))</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_spline extension included&quot;)</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment">// Dependency:</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#include &lt;cstdlib&gt;</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00146.html">glm</a></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;{</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00232.html#ga8119c04f8210fd0d292757565cd6918d">catmullRom</a>(</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; genType <span class="keyword">const</span> &amp; v1, </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; genType <span class="keyword">const</span> &amp; v2, </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; genType <span class="keyword">const</span> &amp; v3, </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; genType <span class="keyword">const</span> &amp; v4, </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> &amp; s);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00232.html#gaa69e143f6374d32f934a8edeaa50bac9">hermite</a>(</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; genType <span class="keyword">const</span> &amp; v1, </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; genType <span class="keyword">const</span> &amp; t1, </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; genType <span class="keyword">const</span> &amp; v2, </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; genType <span class="keyword">const</span> &amp; t2, </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> &amp; s);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00232.html#ga6b867eb52e2fc933d2e0bf26aabc9a70">cubic</a>(</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; genType <span class="keyword">const</span> &amp; v1, </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; genType <span class="keyword">const</span> &amp; v2, </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; genType <span class="keyword">const</span> &amp; v3, </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; genType <span class="keyword">const</span> &amp; v4, </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> &amp; s);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="preprocessor">#include &quot;spline.inl&quot;</span></div>
<div class="ttc" id="a00232_html_ga8119c04f8210fd0d292757565cd6918d"><div class="ttname"><a href="a00232.html#ga8119c04f8210fd0d292757565cd6918d">glm::catmullRom</a></div><div class="ttdeci">GLM_FUNC_DECL genType catmullRom(genType const &amp;v1, genType const &amp;v2, genType const &amp;v3, genType const &amp;v4, typename genType::value_type const &amp;s)</div><div class="ttdoc">Return a point from a catmull rom curve. </div></div>
<div class="ttc" id="a00232_html_ga6b867eb52e2fc933d2e0bf26aabc9a70"><div class="ttname"><a href="a00232.html#ga6b867eb52e2fc933d2e0bf26aabc9a70">glm::cubic</a></div><div class="ttdeci">GLM_FUNC_DECL genType cubic(genType const &amp;v1, genType const &amp;v2, genType const &amp;v3, genType const &amp;v4, typename genType::value_type const &amp;s)</div><div class="ttdoc">Return a point from a cubic curve. </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#l00031">_noise.hpp:31</a></div></div>
<div class="ttc" id="a00232_html_gaa69e143f6374d32f934a8edeaa50bac9"><div class="ttname"><a href="a00232.html#gaa69e143f6374d32f934a8edeaa50bac9">glm::hermite</a></div><div class="ttdeci">GLM_FUNC_DECL genType hermite(genType const &amp;v1, genType const &amp;t1, genType const &amp;v2, genType const &amp;t2, typename genType::value_type const &amp;s)</div><div class="ttdoc">Return a point from a hermite curve. </div></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(GLM_EXT_INCLUDED))</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_std_based_type extension included&quot;)</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00145.html">glm</a></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;{</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="a00231.html#ga47c940f279a6b97ffc301eb4526a445a"> 59</a></span>&#160; <span class="keyword">typedef</span> tvec1&lt;std::size_t, defaultp&gt; <a class="code" href="a00231.html#ga47c940f279a6b97ffc301eb4526a445a">size1</a>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="a00231.html#gac0ef172641a1555684da0beb735c2a79"> 63</a></span>&#160; <span class="keyword">typedef</span> tvec2&lt;std::size_t, defaultp&gt; <a class="code" href="a00231.html#gac0ef172641a1555684da0beb735c2a79">size2</a>;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div>
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="a00231.html#ga51b5e9650c459973134ffb4236ae88b6"> 67</a></span>&#160; <span class="keyword">typedef</span> tvec3&lt;std::size_t, defaultp&gt; <a class="code" href="a00231.html#ga51b5e9650c459973134ffb4236ae88b6">size3</a>;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="a00231.html#gaf07a3f432e328c99d35637225c988121"> 71</a></span>&#160; <span class="keyword">typedef</span> tvec4&lt;std::size_t, defaultp&gt; <a class="code" href="a00231.html#gaf07a3f432e328c99d35637225c988121">size4</a>;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div>
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="a00231.html#ga77d0b061efa41cb2ed2285d09294314e"> 75</a></span>&#160; <span class="keyword">typedef</span> tvec1&lt;std::size_t, defaultp&gt; <a class="code" href="a00231.html#ga77d0b061efa41cb2ed2285d09294314e">size1_t</a>;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="a00231.html#gaa7d72bbe318d27da9d30f27095e4c75e"> 79</a></span>&#160; <span class="keyword">typedef</span> tvec2&lt;std::size_t, defaultp&gt; <a class="code" href="a00231.html#gaa7d72bbe318d27da9d30f27095e4c75e">size2_t</a>;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div>
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="a00231.html#gad364e6c302642e3bb89d756df5d0c8c6"> 83</a></span>&#160; <span class="keyword">typedef</span> tvec3&lt;std::size_t, defaultp&gt; <a class="code" href="a00231.html#gad364e6c302642e3bb89d756df5d0c8c6">size3_t</a>;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="a00231.html#ga06862b7d59094244025d34407b2cb796"> 87</a></span>&#160; <span class="keyword">typedef</span> tvec4&lt;std::size_t, defaultp&gt; <a class="code" href="a00231.html#ga06862b7d59094244025d34407b2cb796">size4_t</a>;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<span class="preprocessor">#include &quot;std_based_type.inl&quot;</span></div>
<div class="ttc" id="a00231_html_ga47c940f279a6b97ffc301eb4526a445a"><div class="ttname"><a href="a00231.html#ga47c940f279a6b97ffc301eb4526a445a">glm::size1</a></div><div class="ttdeci">tvec1&lt; std::size_t, defaultp &gt; size1</div><div class="ttdoc">Vector type based of one std::size_t component. </div><div class="ttdef"><b>Definition:</b> <a href="a00109_source.html#l00059">std_based_type.hpp:59</a></div></div>
<div class="ttc" id="a00231_html_gac0ef172641a1555684da0beb735c2a79"><div class="ttname"><a href="a00231.html#gac0ef172641a1555684da0beb735c2a79">glm::size2</a></div><div class="ttdeci">tvec2&lt; std::size_t, defaultp &gt; size2</div><div class="ttdoc">Vector type based of two std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00109_source.html#l00063">std_based_type.hpp:63</a></div></div>
<div class="ttc" id="a00231_html_gaf07a3f432e328c99d35637225c988121"><div class="ttname"><a href="a00231.html#gaf07a3f432e328c99d35637225c988121">glm::size4</a></div><div class="ttdeci">tvec4&lt; std::size_t, defaultp &gt; size4</div><div class="ttdoc">Vector type based of four std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00109_source.html#l00071">std_based_type.hpp:71</a></div></div>
<div class="ttc" id="a00231_html_gaa7d72bbe318d27da9d30f27095e4c75e"><div class="ttname"><a href="a00231.html#gaa7d72bbe318d27da9d30f27095e4c75e">glm::size2_t</a></div><div class="ttdeci">tvec2&lt; std::size_t, defaultp &gt; size2_t</div><div class="ttdoc">Vector type based of two std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00109_source.html#l00079">std_based_type.hpp:79</a></div></div>
<div class="ttc" id="a00231_html_ga06862b7d59094244025d34407b2cb796"><div class="ttname"><a href="a00231.html#ga06862b7d59094244025d34407b2cb796">glm::size4_t</a></div><div class="ttdeci">tvec4&lt; std::size_t, defaultp &gt; size4_t</div><div class="ttdoc">Vector type based of four std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00109_source.html#l00087">std_based_type.hpp:87</a></div></div>
<div class="ttc" id="a00231_html_ga77d0b061efa41cb2ed2285d09294314e"><div class="ttname"><a href="a00231.html#ga77d0b061efa41cb2ed2285d09294314e">glm::size1_t</a></div><div class="ttdeci">tvec1&lt; std::size_t, defaultp &gt; size1_t</div><div class="ttdoc">Vector type based of one std::size_t component. </div><div class="ttdef"><b>Definition:</b> <a href="a00109_source.html#l00075">std_based_type.hpp:75</a></div></div>
<div class="ttc" id="a00231_html_ga51b5e9650c459973134ffb4236ae88b6"><div class="ttname"><a href="a00231.html#ga51b5e9650c459973134ffb4236ae88b6">glm::size3</a></div><div class="ttdeci">tvec3&lt; std::size_t, defaultp &gt; size3</div><div class="ttdoc">Vector type based of three std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00109_source.html#l00067">std_based_type.hpp:67</a></div></div>
<div class="ttc" id="a00231_html_gad364e6c302642e3bb89d756df5d0c8c6"><div class="ttname"><a href="a00231.html#gad364e6c302642e3bb89d756df5d0c8c6">glm::size3_t</a></div><div class="ttdeci">tvec3&lt; std::size_t, defaultp &gt; size3_t</div><div class="ttdoc">Vector type based of three std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00109_source.html#l00083">std_based_type.hpp:83</a></div></div>
<div class="ttc" id="a00145_html"><div class="ttname"><a href="a00145.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00039">_noise.hpp:39</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>