etk/class_etk__Plane.html

184 lines
13 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<title>etk Library</title>
<link rel="stylesheet" href="base.css">
<link rel="stylesheet" href="menu.css">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="container">
<h1><a href="index.html">etk library</a></h1>
<h4><a href="http://github.com/heeroyui/etk/">&nbsp;&nbsp;&nbsp;[ sources ]</a></h4>
<h3>API:</h3> <div id="menu">
<ul class="niveau1">
<li class="sousmenu"><a href="namespace_etk.html">etk</a>
<ul class="niveau2">
<li><a href="namespace_etk__color.html">color</a>
</li>
<li><a href="namespace_etk__tool.html">tool</a>
</li>
<li><a href="namespace_etk__archive.html">archive</a>
</li>
<li><a href="namespace_etk__theme.html">theme</a>
</li>
</ul>
</li>
<li><a href="namespace_u32char.html">u32char</a>
</li>
<li><a href="namespace_utf8.html">utf8</a>
</li>
<li><a href="namespace_std.html">std</a>
</li>
<li><a href="namespace_debug.html">debug</a>
</li>
</ul>
</div>
<br/><h3>Associate libraries:</h3><div id="menu">
<ul class="niveau1"><li><a href="../ewol/index.html">ewol</a></li>
</ul><ul class="niveau1"><li><a href="../ejson/index.html">ejson</a></li>
</ul><ul class="niveau1"><li><a href="../egami/index.html">egami</a></li>
</ul><ul class="niveau1"><li><a href="../ege/index.html">ege</a></li>
</ul><ul class="niveau1"><li><a href="../esvg/index.html">esvg</a></li>
</ul><ul class="niveau1"><li><a href="../exml/index.html">exml</a></li>
</ul></div>
<br/>
<br/>
<br/>
<br/>
<br/>
<br/>
</div>
</div>
<div class="container" id="content">
<h1>class: etk::Plane</h1><hr/><h2>Description:</h2>
<br/><br/>
<h2>Constructor and Destructor:</h2>
<pre>
+ <a class="code-function" href="#8565">Plane</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <a class="code-function" href="#8567">Plane</a> (<a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; <span class="code-argument">_normal</span>,<br/> <span class="code-type" >T</span> <span class="code-argument">_intercept</span>);<br/>+ <a class="code-function" href="#8570">Plane</a> (<span class="code-storage-keyword">const</span> Plane & <span class="code-argument">obj</span>);<br/>+ <a class="code-function" href="#8572">~Plane</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<h2>Synopsis:</h2>
<pre>
+ <a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; <a class="code-member" href="#8563">m_normal</a>;<br/>+ <span class="code-type" >T</span> <a class="code-member" href="#8564">m_intercept</a>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#8574">setNormal</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; & <span class="code-argument">_obj</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#8576">setIntercept</a> (<span class="code-type" >float</span> <span class="code-argument">_intercept</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#8578">setFromPoints</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; & <span class="code-argument">p0</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; & <span class="code-argument">p1</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; & <span class="code-argument">p2</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#8582">calculateIntercept</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; & <span class="code-argument">_pointOnPlane</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#8584">normalize</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; <a class="code-function" href="#8586">getNormal</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >float</span> <a class="code-function" href="#8588">getIntercept</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#8590">intersect3</a> (<span class="code-storage-keyword">const</span> Plane&lt;T&gt; & <span class="code-argument">_p2</span>,<br/> <span class="code-storage-keyword">const</span> Plane&lt;T&gt; & <span class="code-argument">_p3</span>,<br/> <a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; & <span class="code-argument">_result</span>);<br/>+ <span class="code-type" >float</span> <a class="code-function" href="#8594">getDistance</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; & <span class="code-argument">_point</span>) <span class="code-storage-keyword">const</span>;<br/>+ Plane&lt;T&gt; <a class="code-function" href="#8596">linearInterpolate</a> (<span class="code-storage-keyword">const</span> Plane&lt;T&gt; & <span class="code-argument">_p2</span>,<br/> <span class="code-type" >float</span> <span class="code-argument">_factor</span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#8599">operator ==</a> (<span class="code-storage-keyword">const</span> Plane&lt;T&gt; & <span class="code-argument">_obj</span>) <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#8601">operator !=</a> (<span class="code-storage-keyword">const</span> Plane&lt;T&gt; & <span class="code-argument">_obj</span>) <span class="code-storage-keyword">const</span>;<br/>+ Plane&lt;T&gt; <a class="code-function" href="#8603">operator -</a> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/>+ Plane&lt;T&gt; <a class="code-function" href="#8605">operator +</a> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/></pre>
<br/>
<h2>Detail:</h2>
<a id="8563"/><a id="8564"/><h3>m_normal</h3><pre>
+ <a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; <span class="code-member">m_normal</span>;<br/></pre>
X.N+intercept=0<br/>
<br/>
<hr/>
<a id="8565"/><h3>m_intercept</h3><pre>
+ <span class="code-type" >T</span> <span class="code-member">m_intercept</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="8567"/><h3>Plane</h3><pre>
+ <span class="code-function">Plane</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
Constructor<br/>
<br/>
<hr/>
<a id="8570"/><h3>Plane</h3><pre>
+ <span class="code-function">Plane</span> (<a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; <span class="code-argument">_normal</span>,<br/> <span class="code-type" >T</span> <span class="code-argument">_intercept</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="8572"/><h3>Plane</h3><pre>
+ <span class="code-function">Plane</span> (<span class="code-storage-keyword">const</span> Plane & <span class="code-argument">obj</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="8574"/><h3>~Plane</h3><pre>
+ <span class="code-function">~Plane</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
Destructor<br/>
<br/>
<hr/>
<a id="8576"/><h3>setNormal</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setNormal</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; & <span class="code-argument">_obj</span>);<br/></pre>
<br/>
<hr/>
<a id="8578"/><h3>setIntercept</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setIntercept</span> (<span class="code-type" >float</span> <span class="code-argument">_intercept</span>);<br/></pre>
<br/>
<hr/>
<a id="8582"/><h3>setFromPoints</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setFromPoints</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; & <span class="code-argument">p0</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; & <span class="code-argument">p1</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; & <span class="code-argument">p2</span>);<br/></pre>
<br/>
<hr/>
<a id="8584"/><h3>calculateIntercept</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">calculateIntercept</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; & <span class="code-argument">_pointOnPlane</span>);<br/></pre>
<br/>
<hr/>
<a id="8586"/><h3>normalize</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">normalize</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<hr/>
<a id="8588"/><h3>getNormal</h3><pre>
+ <a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; <span class="code-function">getNormal</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<hr/>
<a id="8590"/><h3>getIntercept</h3><pre>
+ <span class="code-type" >float</span> <span class="code-function">getIntercept</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<hr/>
<a id="8594"/><h3>intersect3</h3><pre>
+ <span class="code-type" >bool</span> <span class="code-function">intersect3</span> (<span class="code-storage-keyword">const</span> Plane&lt;T&gt; & <span class="code-argument">_p2</span>,<br/> <span class="code-storage-keyword">const</span> Plane&lt;T&gt; & <span class="code-argument">_p3</span>,<br/> <a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; & <span class="code-argument">_result</span>);<br/></pre>
<br/>
<hr/>
<a id="8596"/><h3>getDistance</h3><pre>
+ <span class="code-type" >float</span> <span class="code-function">getDistance</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_etk__Vector3D.html">etk::Vector3D</a>&lt;T&gt; & <span class="code-argument">_point</span>) <span class="code-storage-keyword">const</span>;<br/></pre>
<br/>
<hr/>
<a id="8599"/><h3>linearInterpolate</h3><pre>
+ Plane&lt;T&gt; <span class="code-function">linearInterpolate</span> (<span class="code-storage-keyword">const</span> Plane&lt;T&gt; & <span class="code-argument">_p2</span>,<br/> <span class="code-type" >float</span> <span class="code-argument">_factor</span>);<br/></pre>
<br/>
<hr/>
<a id="8601"/><h3>operator ==</h3><pre>
+ <span class="code-type" >bool</span> <span class="code-function">operator ==</span> (<span class="code-storage-keyword">const</span> Plane&lt;T&gt; & <span class="code-argument">_obj</span>) <span class="code-storage-keyword">const</span>;<br/></pre>
<br/>
<hr/>
<a id="8603"/><h3>operator !=</h3><pre>
+ <span class="code-type" >bool</span> <span class="code-function">operator !=</span> (<span class="code-storage-keyword">const</span> Plane&lt;T&gt; & <span class="code-argument">_obj</span>) <span class="code-storage-keyword">const</span>;<br/></pre>
<br/>
<hr/>
<a id="8605"/><h3>operator -</h3><pre>
+ Plane&lt;T&gt; <span class="code-function">operator -</span> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/></pre>
<br/>
<hr/>
<h3>operator +</h3><pre>
+ Plane&lt;T&gt; <span class="code-function">operator +</span> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/></pre>
<br/>
<hr/>
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-46753803-1', 'heeroyui.github.io');
ga('send', 'pageview');
</script>
</body>
</html>