Updated doxygen docs to latest changes

This commit is contained in:
2019-12-19 19:39:08 +01:00
parent 5073312f7a
commit 9c95059b93
239 changed files with 2996 additions and 2508 deletions

View File

@@ -30,7 +30,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">IntelliPhoto
&#160;<span id="projectnumber">0.4</span>
&#160;<span id="projectnumber">0.5</span>
</div>
</td>
</tr>
@@ -93,58 +93,60 @@ $(document).ready(function(){initNavTree('_intelli_image_8h_source.html','');});
<a href="_intelli_image_8h.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;<span class="preprocessor">#ifndef INTELLIIMAGE_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define INTELLIIMAGE_H</span></div>
<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&lt;QImage&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include&lt;QPoint&gt;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include&lt;QColor&gt;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include&lt;QSize&gt;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include&lt;QWidget&gt;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include&lt;vector&gt;</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;QImage&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;QPoint&gt;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &lt;QColor&gt;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;QSize&gt;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;QWidget&gt;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="_intelli_image_8h.html#a3154c405c975616503bac23f51b78fc0"> 14</a></span>&#160;<span class="keyword">enum class</span> <a class="code" href="_intelli_image_8h.html#a3154c405c975616503bac23f51b78fc0">ImageType</a>{</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <a class="code" href="_intelli_image_8h.html#a3154c405c975616503bac23f51b78fc0a80e1612d2117f2b25530317279ffe7b3">Raster_Image</a>,</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <a class="code" href="_intelli_image_8h.html#a3154c405c975616503bac23f51b78fc0ab7e2d2c1c171e5a0e0b6b548449df79d">Shaped_Image</a></div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="_intelli_image_8h.html#a3154c405c975616503bac23f51b78fc0"> 14</a></span>&#160;<span class="keyword">enum class</span> <a class="code" href="_intelli_image_8h.html#a3154c405c975616503bac23f51b78fc0">ImageType</a> {</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <a class="code" href="_intelli_image_8h.html#a3154c405c975616503bac23f51b78fc0a80e1612d2117f2b25530317279ffe7b3">Raster_Image</a>,</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <a class="code" href="_intelli_image_8h.html#a3154c405c975616503bac23f51b78fc0ab7e2d2c1c171e5a0e0b6b548449df79d">Shaped_Image</a></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; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">class </span><a class="code" href="class_intelli_tool.html">IntelliTool</a>;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="class_intelli_image.html"> 24</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_intelli_image.html">IntelliImage</a>{</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keyword">friend</span> <a class="code" href="class_intelli_tool.html">IntelliTool</a>;</div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="class_intelli_image.html"> 24</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_intelli_image.html">IntelliImage</a> {</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">friend</span> <a class="code" href="class_intelli_tool.html">IntelliTool</a>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#a177403ab9585d4ba31984a644c54d310">resizeImage</a>(QImage *image, <span class="keyword">const</span> QSize &amp;newSize);</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#a177403ab9585d4ba31984a644c54d310">resizeImage</a>(QImage*image, <span class="keyword">const</span> QSize &amp;newSize);</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2"> 32</a></span>&#160; QImage <a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2"> 32</a></span>&#160;QImage <a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="class_intelli_image.html#a47084f1cb668ea0242ab95162cf9e902">IntelliImage</a>(<span class="keywordtype">int</span> weight, <span class="keywordtype">int</span> height);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<a class="code" href="class_intelli_image.html#a47084f1cb668ea0242ab95162cf9e902">IntelliImage</a>(<span class="keywordtype">int</span> weight, <span class="keywordtype">int</span> height);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">virtual</span> <a class="code" href="class_intelli_image.html#ac398bfa9ddd3185508a1e36ee15d80cc">~IntelliImage</a>() = 0;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="keyword">virtual</span> <a class="code" href="class_intelli_image.html#ac398bfa9ddd3185508a1e36ee15d80cc">~IntelliImage</a>() = 0;</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; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#af3c859f5c409e37051edfd9e9fbca056">drawPixel</a>(<span class="keyword">const</span> QPoint &amp;p1, <span class="keyword">const</span> QColor&amp; color);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#af3c859f5c409e37051edfd9e9fbca056">drawPixel</a>(<span class="keyword">const</span> QPoint &amp;p1, <span class="keyword">const</span> QColor&amp; color);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#af8eddbd9aa54c8d37590d1d4bf8dce31">drawLine</a>(<span class="keyword">const</span> QPoint &amp;p1, <span class="keyword">const</span> QPoint&amp; p2, <span class="keyword">const</span> QColor&amp; color, <span class="keyword">const</span> <span class="keywordtype">int</span>&amp; penWidth);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#af8eddbd9aa54c8d37590d1d4bf8dce31">drawLine</a>(<span class="keyword">const</span> QPoint &amp;p1, <span class="keyword">const</span> QPoint&amp; p2, <span class="keyword">const</span> QColor&amp; color, <span class="keyword">const</span> <span class="keywordtype">int</span>&amp; penWidth);</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">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#a2e787f1b333b59401643936ebb3dcfe1">drawPoint</a>(<span class="keyword">const</span> QPoint &amp;p1, <span class="keyword">const</span> QColor&amp; color, <span class="keyword">const</span> <span class="keywordtype">int</span>&amp; penWidth);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#a2e787f1b333b59401643936ebb3dcfe1">drawPoint</a>(<span class="keyword">const</span> QPoint &amp;p1, <span class="keyword">const</span> QColor&amp; color, <span class="keyword">const</span> <span class="keywordtype">int</span>&amp; penWidth);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#a6be622810dc2bc756054bb5769becb06">drawPlain</a>(<span class="keyword">const</span> QColor&amp; color);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#a6be622810dc2bc756054bb5769becb06">drawPlain</a>(<span class="keyword">const</span> QColor&amp; color);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keyword">virtual</span> QImage <a class="code" href="class_intelli_image.html#a21c7e65b59a26db45aac3880133ef21d">getDisplayable</a>(<span class="keyword">const</span> QSize&amp; displaySize, <span class="keywordtype">int</span> alpha)=0;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="keyword">virtual</span> QImage <a class="code" href="class_intelli_image.html#a21c7e65b59a26db45aac3880133ef21d">getDisplayable</a>(<span class="keyword">const</span> QSize&amp; displaySize, <span class="keywordtype">int</span> alpha) = 0;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keyword">virtual</span> QImage <a class="code" href="class_intelli_image.html#a21c7e65b59a26db45aac3880133ef21d">getDisplayable</a>(<span class="keywordtype">int</span> alpha=255)=0;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="keyword">virtual</span> QImage <a class="code" href="class_intelli_image.html#a21c7e65b59a26db45aac3880133ef21d">getDisplayable</a>(<span class="keywordtype">int</span> alpha=255) = 0;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keyword">virtual</span> <a class="code" href="class_intelli_image.html">IntelliImage</a>* <a class="code" href="class_intelli_image.html#af6381067bdf565669f856bb589008ae9">getDeepCopy</a>()=0;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="keyword">virtual</span> <a class="code" href="class_intelli_image.html">IntelliImage</a>* <a class="code" href="class_intelli_image.html#af6381067bdf565669f856bb589008ae9">getDeepCopy</a>() = 0;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#aebbced93f4744fad81b7f141b21f4ab2">calculateVisiblity</a>()=0;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#aebbced93f4744fad81b7f141b21f4ab2">calculateVisiblity</a>() = 0;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#aa4b3f4631bd972456917275afb9fd309">setPolygon</a>(<span class="keyword">const</span> std::vector&lt;QPoint&gt;&amp; polygonData)=0;</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#aa4b3f4631bd972456917275afb9fd309">setPolygon</a>(<span class="keyword">const</span> std::vector&lt;QPoint&gt;&amp; polygonData) = 0;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; </div>
<div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="class_intelli_image.html#aaf9f3e8db8666850024bee9aad9966ba"> 113</a></span>&#160; <span class="keyword">virtual</span> std::vector&lt;QPoint&gt; <a class="code" href="class_intelli_image.html#aaf9f3e8db8666850024bee9aad9966ba">getPolygonData</a>(){ <span class="keywordflow">return</span> std::vector&lt;QPoint&gt;();}</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_intelli_image.html#aec0e9c8184d89dee33fd9adefbd2f8aa">loadImage</a>(<span class="keyword">const</span> QString &amp;fileName);</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; </div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keyword">virtual</span> QColor <a class="code" href="class_intelli_image.html#a4576ebb6d863321c816293d7b7f9fd3f">getPixelColor</a>(QPoint&amp; point);</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;};</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; </div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="class_intelli_image.html#aaf9f3e8db8666850024bee9aad9966ba"> 113</a></span>&#160;<span class="keyword">virtual</span> std::vector&lt;QPoint&gt; <a class="code" href="class_intelli_image.html#aaf9f3e8db8666850024bee9aad9966ba">getPolygonData</a>(){</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keywordflow">return</span> std::vector&lt;QPoint&gt;();</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;}</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; </div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_intelli_image.html#aec0e9c8184d89dee33fd9adefbd2f8aa">loadImage</a>(<span class="keyword">const</span> QString &amp;fileName);</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; </div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;<span class="keyword">virtual</span> QColor <a class="code" href="class_intelli_image.html#a4576ebb6d863321c816293d7b7f9fd3f">getPixelColor</a>(QPoint&amp; point);</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;};</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; </div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="a_intelli_image_8h_html_a3154c405c975616503bac23f51b78fc0"><div class="ttname"><a href="_intelli_image_8h.html#a3154c405c975616503bac23f51b78fc0">ImageType</a></div><div class="ttdeci">ImageType</div><div class="ttdoc">The Types, which an Image can be.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8h_source.html#l00014">IntelliImage.h:14</a></div></div>