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>
@@ -90,13 +90,13 @@ $(document).ready(function(){initNavTree('_intelli_image_8cpp_source.html','');}
<div class="title">IntelliImage.cpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="_intelli_image_8cpp.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">#include&quot;<a class="code" href="_intelli_image_8h.html">Image/IntelliImage.h</a>&quot;</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#include&lt;QSize&gt;</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include&lt;QPainter&gt;</span></div>
<a href="_intelli_image_8cpp.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">#include &quot;<a class="code" href="_intelli_image_8h.html">Image/IntelliImage.h</a>&quot;</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#include &lt;QSize&gt;</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &lt;QPainter&gt;</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno"><a class="line" href="class_intelli_image.html#a47084f1cb668ea0242ab95162cf9e902"> 5</a></span>&#160;<a class="code" href="class_intelli_image.html#a47084f1cb668ea0242ab95162cf9e902">IntelliImage::IntelliImage</a>(<span class="keywordtype">int</span> weight, <span class="keywordtype">int</span> height)</div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; :imageData(QSize(weight, height), QImage::Format_ARGB32){</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; <a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a>.fill(QColor(255,255,255,255));</div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; : imageData(QSize(weight, height), QImage::Format_ARGB32){</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; <a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a>.fill(QColor(255,255,255,255));</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;}</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="class_intelli_image.html#ac398bfa9ddd3185508a1e36ee15d80cc"> 10</a></span>&#160;<a class="code" href="class_intelli_image.html#ac398bfa9ddd3185508a1e36ee15d80cc">IntelliImage::~IntelliImage</a>(){</div>
@@ -104,73 +104,73 @@ $(document).ready(function(){initNavTree('_intelli_image_8cpp_source.html','');}
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;}</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"><a class="line" href="class_intelli_image.html#aec0e9c8184d89dee33fd9adefbd2f8aa"> 14</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="class_intelli_image.html#aec0e9c8184d89dee33fd9adefbd2f8aa">IntelliImage::loadImage</a>(<span class="keyword">const</span> QString &amp;fileName){</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="comment">// Holds the image</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; QImage loadedImage;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="comment">// Holds the image</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; QImage loadedImage;</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">// If the image wasn&#39;t loaded leave this function</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keywordflow">if</span> (!loadedImage.load(fileName))</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="comment">// If the image wasn&#39;t loaded leave this function</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keywordflow">if</span> (!loadedImage.load(fileName))</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="comment">// scaled Image to size of Layer</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; loadedImage = loadedImage.scaled(<a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a>.size(),Qt::IgnoreAspectRatio);</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="comment">// scaled Image to size of Layer</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; loadedImage = loadedImage.scaled(<a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a>.size(),Qt::IgnoreAspectRatio);</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; <a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a> = loadedImage.convertToFormat(QImage::Format_ARGB32);</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a> = loadedImage.convertToFormat(QImage::Format_ARGB32);</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;}</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="class_intelli_image.html#a177403ab9585d4ba31984a644c54d310"> 29</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#a177403ab9585d4ba31984a644c54d310">IntelliImage::resizeImage</a>(QImage *image, <span class="keyword">const</span> QSize &amp;newSize){</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="comment">// Check if we need to redraw the image</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordflow">if</span> (image-&gt;size() == newSize)</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="class_intelli_image.html#a177403ab9585d4ba31984a644c54d310"> 29</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#a177403ab9585d4ba31984a644c54d310">IntelliImage::resizeImage</a>(QImage*image, <span class="keyword">const</span> QSize &amp;newSize){</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="comment">// Check if we need to redraw the image</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordflow">if</span> (image-&gt;size() == newSize)</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="comment">// Create a new image to display and fill it with white</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; QImage newImage(newSize, QImage::Format_ARGB32);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; newImage.fill(qRgb(255, 255, 255));</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="comment">// Create a new image to display and fill it with white</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; QImage newImage(newSize, QImage::Format_ARGB32);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; newImage.fill(qRgb(255, 255, 255));</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="comment">// Draw the image</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; QPainter painter(&amp;newImage);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; painter.drawImage(QPoint(0, 0), *image);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; *image = newImage;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="comment">// Draw the image</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; QPainter painter(&amp;newImage);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; painter.drawImage(QPoint(0, 0), *image);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; *image = newImage;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;}</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"><a class="line" href="class_intelli_image.html#af3c859f5c409e37051edfd9e9fbca056"> 44</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#af3c859f5c409e37051edfd9e9fbca056">IntelliImage::drawPixel</a>(<span class="keyword">const</span> QPoint &amp;p1, <span class="keyword">const</span> QColor&amp; color){</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="comment">// Used to draw on the widget</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; QPainter painter(&amp;<a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a>);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="comment">// Used to draw on the widget</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; QPainter painter(&amp;<a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a>);</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="comment">// Set the current settings for the pen</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; painter.setPen(QPen(color, 1, Qt::SolidLine, Qt::RoundCap, Qt::RoundJoin));</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="comment">// Set the current settings for the pen</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; painter.setPen(QPen(color, 1, Qt::SolidLine, Qt::RoundCap, Qt::RoundJoin));</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="comment">// Draw a line from the last registered point to the current</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; painter.drawPoint(p1);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="comment">// Draw a line from the last registered point to the current</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; painter.drawPoint(p1);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;}</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="class_intelli_image.html#a2e787f1b333b59401643936ebb3dcfe1"> 55</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#a2e787f1b333b59401643936ebb3dcfe1">IntelliImage::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="l00056"></a><span class="lineno"> 56</span>&#160; <span class="comment">// Used to draw on the widget</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; QPainter painter(&amp;<a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a>);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="comment">// Used to draw on the widget</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; QPainter painter(&amp;<a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a>);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="comment">// Set the current settings for the pen</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; painter.setPen(QPen(color, penWidth, Qt::SolidLine, Qt::RoundCap, Qt::RoundJoin));</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="comment">// Draw a line from the last registered point to the current</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; painter.drawPoint(p1);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="comment">// Set the current settings for the pen</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; painter.setPen(QPen(color, penWidth, Qt::SolidLine, Qt::RoundCap, Qt::RoundJoin));</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="comment">// Draw a line from the last registered point to the current</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; painter.drawPoint(p1);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;}</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="class_intelli_image.html#af8eddbd9aa54c8d37590d1d4bf8dce31"> 65</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#af8eddbd9aa54c8d37590d1d4bf8dce31">IntelliImage::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="l00066"></a><span class="lineno"> 66</span>&#160; <span class="comment">// Used to draw on the widget</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; QPainter painter(&amp;<a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a>);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="comment">// Used to draw on the widget</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; QPainter painter(&amp;<a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a>);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="comment">// Set the current settings for the pen</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; painter.setPen(QPen(color, penWidth, Qt::SolidLine, Qt::RoundCap, Qt::RoundJoin));</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="comment">// Set the current settings for the pen</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; painter.setPen(QPen(color, penWidth, Qt::SolidLine, Qt::RoundCap, Qt::RoundJoin));</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="comment">// Draw a line from the last registered point to the current</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; painter.drawLine(p1, p2);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="comment">// Draw a line from the last registered point to the current</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; painter.drawLine(p1, p2);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;}</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="class_intelli_image.html#a6be622810dc2bc756054bb5769becb06"> 76</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="class_intelli_image.html#a6be622810dc2bc756054bb5769becb06">IntelliImage::drawPlain</a>(<span class="keyword">const</span> QColor&amp; color){</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a>.fill(color);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a>.fill(color);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;}</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="class_intelli_image.html#a4576ebb6d863321c816293d7b7f9fd3f"> 80</a></span>&#160;QColor <a class="code" href="class_intelli_image.html#a4576ebb6d863321c816293d7b7f9fd3f">IntelliImage::getPixelColor</a>(QPoint&amp; point){</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordflow">return</span> <a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a>.pixelColor(point);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordflow">return</span> <a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a>.pixelColor(point);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->