Updated docs

This commit is contained in:
2019-12-19 11:29:26 +01:00
parent 559f229b7b
commit 4d68b6ab0a
356 changed files with 11771 additions and 2723 deletions

View File

@@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IntelliPhoto: src/Image/IntelliRasterImage.h Source File</title>
<title>IntelliPhoto: intelliphoto/src/Image/IntelliRasterImage.h 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>
@@ -95,42 +95,41 @@ $(document).ready(function(){initNavTree('_intelli_raster_image_8h_source.html',
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include&quot;<a class="code" href="_intelli_image_8h.html">Image/IntelliImage.h</a>&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
<div class="line"><a name="l00006"></a><span class="lineno"><a class="line" href="class_intelli_raster_image.html"> 6</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_intelli_raster_image.html">IntelliRasterImage</a> : <span class="keyword">public</span> <a class="code" href="class_intelli_image.html">IntelliImage</a>{</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; <span class="keyword">friend</span> <a class="code" href="class_intelli_tool.html">IntelliTool</a>;</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_raster_image.html#a87cf2d360c129d64a5db0db85818eb60">calculateVisiblity</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; <a class="code" href="class_intelli_raster_image.html#aad9b561fe499a4da3c6ef98971aa3468">IntelliRasterImage</a>(<span class="keywordtype">int</span> weight, <span class="keywordtype">int</span> height);</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; <span class="keyword">virtual</span> <a class="code" href="class_intelli_raster_image.html#a844a2b58c43f7e01f2ca116286371bc8">~IntelliRasterImage</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; <span class="comment">//returns the filtered output</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="keyword">virtual</span> QImage <a class="code" href="class_intelli_raster_image.html#ae43393397b0141a8033fe34d3a1b1884">getDisplayable</a>(<span class="keyword">const</span> QSize&amp; displaySize,<span class="keywordtype">int</span> alpha) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="keyword">virtual</span> QImage <a class="code" href="class_intelli_raster_image.html#ae43393397b0141a8033fe34d3a1b1884">getDisplayable</a>(<span class="keywordtype">int</span> alpha=255) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="comment">//gets a copy of the image !allocated</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keyword">virtual</span> <a class="code" href="class_intelli_image.html">IntelliImage</a>* <a class="code" href="class_intelli_raster_image.html#a8f901301b106504de3c27308ade897dc">getDeepCopy</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="comment">//sets the data for the visible image</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_raster_image.html#a6462fa5f94c5e64e9e1f0c4658e0507b">setPolygon</a>(<span class="keyword">const</span> std::vector&lt;QPoint&gt;&amp; polygonData) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;};</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="class_intelli_raster_image.html"> 9</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_intelli_raster_image.html">IntelliRasterImage</a> : <span class="keyword">public</span> <a class="code" href="class_intelli_image.html">IntelliImage</a>{</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; <span class="keyword">friend</span> <a class="code" href="class_intelli_tool.html">IntelliTool</a>;</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_raster_image.html#a87cf2d360c129d64a5db0db85818eb60">calculateVisiblity</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <a class="code" href="class_intelli_raster_image.html#aad9b561fe499a4da3c6ef98971aa3468">IntelliRasterImage</a>(<span class="keywordtype">int</span> weight, <span class="keywordtype">int</span> height);</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">virtual</span> <a class="code" href="class_intelli_raster_image.html#a844a2b58c43f7e01f2ca116286371bc8">~IntelliRasterImage</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">virtual</span> QImage <a class="code" href="class_intelli_raster_image.html#ae43393397b0141a8033fe34d3a1b1884">getDisplayable</a>(<span class="keyword">const</span> QSize&amp; displaySize,<span class="keywordtype">int</span> alpha) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">virtual</span> QImage <a class="code" href="class_intelli_raster_image.html#ae43393397b0141a8033fe34d3a1b1884">getDisplayable</a>(<span class="keywordtype">int</span> alpha=255) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">virtual</span> <a class="code" href="class_intelli_image.html">IntelliImage</a>* <a class="code" href="class_intelli_raster_image.html#a8f901301b106504de3c27308ade897dc">getDeepCopy</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_raster_image.html#a6462fa5f94c5e64e9e1f0c4658e0507b">setPolygon</a>(<span class="keyword">const</span> std::vector&lt;QPoint&gt;&amp; polygonData) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;};</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="a_intelli_image_8h_html"><div class="ttname"><a href="_intelli_image_8h.html">IntelliImage.h</a></div></div>
<div class="ttc" id="aclass_intelli_raster_image_html_a844a2b58c43f7e01f2ca116286371bc8"><div class="ttname"><a href="class_intelli_raster_image.html#a844a2b58c43f7e01f2ca116286371bc8">IntelliRasterImage::~IntelliRasterImage</a></div><div class="ttdeci">virtual ~IntelliRasterImage() override</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_raster_image_8cpp_source.html#l00011">IntelliRasterImage.cpp:11</a></div></div>
<div class="ttc" id="aclass_intelli_tool_html"><div class="ttname"><a href="class_intelli_tool.html">IntelliTool</a></div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_8h_source.html#l00010">IntelliTool.h:10</a></div></div>
<div class="ttc" id="aclass_intelli_raster_image_html_ae43393397b0141a8033fe34d3a1b1884"><div class="ttname"><a href="class_intelli_raster_image.html#ae43393397b0141a8033fe34d3a1b1884">IntelliRasterImage::getDisplayable</a></div><div class="ttdeci">virtual QImage getDisplayable(const QSize &amp;displaySize, int alpha) override</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_raster_image_8cpp_source.html#l00029">IntelliRasterImage.cpp:29</a></div></div>
<div class="ttc" id="aclass_intelli_image_html"><div class="ttname"><a href="class_intelli_image.html">IntelliImage</a></div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8h_source.html#l00018">IntelliImage.h:18</a></div></div>
<div class="ttc" id="aclass_intelli_raster_image_html_a8f901301b106504de3c27308ade897dc"><div class="ttname"><a href="class_intelli_raster_image.html#a8f901301b106504de3c27308ade897dc">IntelliRasterImage::getDeepCopy</a></div><div class="ttdeci">virtual IntelliImage * getDeepCopy() override</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_raster_image_8cpp_source.html#l00015">IntelliRasterImage.cpp:15</a></div></div>
<div class="ttc" id="aclass_intelli_raster_image_html_a87cf2d360c129d64a5db0db85818eb60"><div class="ttname"><a href="class_intelli_raster_image.html#a87cf2d360c129d64a5db0db85818eb60">IntelliRasterImage::calculateVisiblity</a></div><div class="ttdeci">virtual void calculateVisiblity() override</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_raster_image_8cpp_source.html#l00021">IntelliRasterImage.cpp:21</a></div></div>
<div class="ttc" id="aclass_intelli_raster_image_html_a6462fa5f94c5e64e9e1f0c4658e0507b"><div class="ttname"><a href="class_intelli_raster_image.html#a6462fa5f94c5e64e9e1f0c4658e0507b">IntelliRasterImage::setPolygon</a></div><div class="ttdeci">virtual void setPolygon(const std::vector&lt; QPoint &gt; &amp;polygonData) override</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_raster_image_8cpp_source.html#l00041">IntelliRasterImage.cpp:41</a></div></div>
<div class="ttc" id="aclass_intelli_raster_image_html_aad9b561fe499a4da3c6ef98971aa3468"><div class="ttname"><a href="class_intelli_raster_image.html#aad9b561fe499a4da3c6ef98971aa3468">IntelliRasterImage::IntelliRasterImage</a></div><div class="ttdeci">IntelliRasterImage(int weight, int height)</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_raster_image_8cpp_source.html#l00006">IntelliRasterImage.cpp:6</a></div></div>
<div class="ttc" id="aclass_intelli_raster_image_html"><div class="ttname"><a href="class_intelli_raster_image.html">IntelliRasterImage</a></div><div class="ttdef"><b>Definition:</b> <a href="_intelli_raster_image_8h_source.html#l00006">IntelliRasterImage.h:6</a></div></div>
<div class="ttc" id="aclass_intelli_raster_image_html_a844a2b58c43f7e01f2ca116286371bc8"><div class="ttname"><a href="class_intelli_raster_image.html#a844a2b58c43f7e01f2ca116286371bc8">IntelliRasterImage::~IntelliRasterImage</a></div><div class="ttdeci">virtual ~IntelliRasterImage() override</div><div class="ttdoc">An Destructor.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_raster_image_8cpp_source.html#l00011">IntelliRasterImage.cpp:11</a></div></div>
<div class="ttc" id="aclass_intelli_tool_html"><div class="ttname"><a href="class_intelli_tool.html">IntelliTool</a></div><div class="ttdoc">An abstract class that manages the basic events, like mouse clicks or scrolls events.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_8h_source.html#l00013">IntelliTool.h:13</a></div></div>
<div class="ttc" id="aclass_intelli_raster_image_html_ae43393397b0141a8033fe34d3a1b1884"><div class="ttname"><a href="class_intelli_raster_image.html#ae43393397b0141a8033fe34d3a1b1884">IntelliRasterImage::getDisplayable</a></div><div class="ttdeci">virtual QImage getDisplayable(const QSize &amp;displaySize, int alpha) override</div><div class="ttdoc">A function returning the displayable ImageData in a requested transparence and size.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_raster_image_8cpp_source.html#l00029">IntelliRasterImage.cpp:29</a></div></div>
<div class="ttc" id="aclass_intelli_image_html"><div class="ttname"><a href="class_intelli_image.html">IntelliImage</a></div><div class="ttdoc">An abstract class which manages the basic IntelliImage operations.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8h_source.html#l00024">IntelliImage.h:24</a></div></div>
<div class="ttc" id="aclass_intelli_raster_image_html_a8f901301b106504de3c27308ade897dc"><div class="ttname"><a href="class_intelli_raster_image.html#a8f901301b106504de3c27308ade897dc">IntelliRasterImage::getDeepCopy</a></div><div class="ttdeci">virtual IntelliImage * getDeepCopy() override</div><div class="ttdoc">A function that copys all that returns a [allocated] Image.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_raster_image_8cpp_source.html#l00015">IntelliRasterImage.cpp:15</a></div></div>
<div class="ttc" id="aclass_intelli_raster_image_html_a87cf2d360c129d64a5db0db85818eb60"><div class="ttname"><a href="class_intelli_raster_image.html#a87cf2d360c129d64a5db0db85818eb60">IntelliRasterImage::calculateVisiblity</a></div><div class="ttdeci">virtual void calculateVisiblity() override</div><div class="ttdoc">A function that calculates the visibility of the image if a polygon is given. [does nothing in Raster...</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_raster_image_8cpp_source.html#l00021">IntelliRasterImage.cpp:21</a></div></div>
<div class="ttc" id="aclass_intelli_raster_image_html_a6462fa5f94c5e64e9e1f0c4658e0507b"><div class="ttname"><a href="class_intelli_raster_image.html#a6462fa5f94c5e64e9e1f0c4658e0507b">IntelliRasterImage::setPolygon</a></div><div class="ttdeci">virtual void setPolygon(const std::vector&lt; QPoint &gt; &amp;polygonData) override</div><div class="ttdoc">An abstract function that sets the data of the visible Polygon, if needed.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_raster_image_8cpp_source.html#l00041">IntelliRasterImage.cpp:41</a></div></div>
<div class="ttc" id="aclass_intelli_raster_image_html_aad9b561fe499a4da3c6ef98971aa3468"><div class="ttname"><a href="class_intelli_raster_image.html#aad9b561fe499a4da3c6ef98971aa3468">IntelliRasterImage::IntelliRasterImage</a></div><div class="ttdeci">IntelliRasterImage(int weight, int height)</div><div class="ttdoc">The Construcor of the IntelliRasterImage. Given the Image dimensions.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_raster_image_8cpp_source.html#l00006">IntelliRasterImage.cpp:6</a></div></div>
<div class="ttc" id="aclass_intelli_raster_image_html"><div class="ttname"><a href="class_intelli_raster_image.html">IntelliRasterImage</a></div><div class="ttdoc">The IntelliRasterImage manages a Rasterimage.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_raster_image_8h_source.html#l00009">IntelliRasterImage.h:9</a></div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_fdbdd9841f9a730f284bb666ff3d8cfe.html">Image</a></li><li class="navelem"><a class="el" href="_intelli_raster_image_8h.html">IntelliRasterImage.h</a></li>
<li class="navelem"><a class="el" href="dir_8db5f55022e7670536cbc9a6a1d6f01c.html">intelliphoto</a></li><li class="navelem"><a class="el" href="dir_83a4347d11f2ba6343d546ab133722d2.html">src</a></li><li class="navelem"><a class="el" href="dir_544f9dcb748f922e4bb3be2540380bf2.html">Image</a></li><li class="navelem"><a class="el" href="_intelli_raster_image_8h.html">IntelliRasterImage.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li>