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/IntelliImage.cpp Source File</title>
<title>IntelliPhoto: intelliphoto/src/Image/IntelliImage.cpp 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>
@@ -144,36 +144,52 @@ $(document).ready(function(){initNavTree('_intelli_image_8cpp_source.html','');}
<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#af8eddbd9aa54c8d37590d1d4bf8dce31"> 55</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="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="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; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="comment">// Draw a line from the last registered point to the current</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; painter.drawLine(p1, p2);</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"> 65</span>&#160;}</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="class_intelli_image.html#a6be622810dc2bc756054bb5769becb06"> 67</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="l00068"></a><span class="lineno"> 68</span>&#160; <a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a>.fill(color);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</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="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="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="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"> 76</span>&#160; </div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="class_intelli_image.html#a6be622810dc2bc756054bb5769becb06"> 77</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="l00078"></a><span class="lineno"> 78</span>&#160; <a class="code" href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">imageData</a>.fill(color);</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"> 80</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="class_intelli_image.html#a4576ebb6d863321c816293d7b7f9fd3f"> 81</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="l00082"></a><span class="lineno"> 82</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="l00083"></a><span class="lineno"> 83</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclass_intelli_image_html_af8eddbd9aa54c8d37590d1d4bf8dce31"><div class="ttname"><a href="class_intelli_image.html#af8eddbd9aa54c8d37590d1d4bf8dce31">IntelliImage::drawLine</a></div><div class="ttdeci">virtual void drawLine(const QPoint &amp;p1, const QPoint &amp;p2, const QColor &amp;color, const int &amp;penWidth)</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8cpp_source.html#l00055">IntelliImage.cpp:55</a></div></div>
<div class="ttc" id="aclass_intelli_image_html_af8eddbd9aa54c8d37590d1d4bf8dce31"><div class="ttname"><a href="class_intelli_image.html#af8eddbd9aa54c8d37590d1d4bf8dce31">IntelliImage::drawLine</a></div><div class="ttdeci">virtual void drawLine(const QPoint &amp;p1, const QPoint &amp;p2, const QColor &amp;color, const int &amp;penWidth)</div><div class="ttdoc">A function that draws A Line between two given Points in a given color.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8cpp_source.html#l00065">IntelliImage.cpp:65</a></div></div>
<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_image_html_ac398bfa9ddd3185508a1e36ee15d80cc"><div class="ttname"><a href="class_intelli_image.html#ac398bfa9ddd3185508a1e36ee15d80cc">IntelliImage::~IntelliImage</a></div><div class="ttdeci">virtual ~IntelliImage()=0</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8cpp_source.html#l00010">IntelliImage.cpp:10</a></div></div>
<div class="ttc" id="aclass_intelli_image_html_af3c859f5c409e37051edfd9e9fbca056"><div class="ttname"><a href="class_intelli_image.html#af3c859f5c409e37051edfd9e9fbca056">IntelliImage::drawPixel</a></div><div class="ttdeci">virtual void drawPixel(const QPoint &amp;p1, const QColor &amp;color)</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8cpp_source.html#l00044">IntelliImage.cpp:44</a></div></div>
<div class="ttc" id="aclass_intelli_image_html_aec0e9c8184d89dee33fd9adefbd2f8aa"><div class="ttname"><a href="class_intelli_image.html#aec0e9c8184d89dee33fd9adefbd2f8aa">IntelliImage::loadImage</a></div><div class="ttdeci">virtual bool loadImage(const QString &amp;fileName)</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8cpp_source.html#l00014">IntelliImage.cpp:14</a></div></div>
<div class="ttc" id="aclass_intelli_image_html_a47084f1cb668ea0242ab95162cf9e902"><div class="ttname"><a href="class_intelli_image.html#a47084f1cb668ea0242ab95162cf9e902">IntelliImage::IntelliImage</a></div><div class="ttdeci">IntelliImage(int weight, int height)</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8cpp_source.html#l00005">IntelliImage.cpp:5</a></div></div>
<div class="ttc" id="aclass_intelli_image_html_ac398bfa9ddd3185508a1e36ee15d80cc"><div class="ttname"><a href="class_intelli_image.html#ac398bfa9ddd3185508a1e36ee15d80cc">IntelliImage::~IntelliImage</a></div><div class="ttdeci">virtual ~IntelliImage()=0</div><div class="ttdoc">An Abstract Destructor.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8cpp_source.html#l00010">IntelliImage.cpp:10</a></div></div>
<div class="ttc" id="aclass_intelli_image_html_af3c859f5c409e37051edfd9e9fbca056"><div class="ttname"><a href="class_intelli_image.html#af3c859f5c409e37051edfd9e9fbca056">IntelliImage::drawPixel</a></div><div class="ttdeci">virtual void drawPixel(const QPoint &amp;p1, const QColor &amp;color)</div><div class="ttdoc">A funtcion used to draw a pixel on the Image with the given Color.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8cpp_source.html#l00044">IntelliImage.cpp:44</a></div></div>
<div class="ttc" id="aclass_intelli_image_html_aec0e9c8184d89dee33fd9adefbd2f8aa"><div class="ttname"><a href="class_intelli_image.html#aec0e9c8184d89dee33fd9adefbd2f8aa">IntelliImage::loadImage</a></div><div class="ttdeci">virtual bool loadImage(const QString &amp;fileName)</div><div class="ttdoc">A function that loads and sclaes an image to the fitting dimensions.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8cpp_source.html#l00014">IntelliImage.cpp:14</a></div></div>
<div class="ttc" id="aclass_intelli_image_html_a2e787f1b333b59401643936ebb3dcfe1"><div class="ttname"><a href="class_intelli_image.html#a2e787f1b333b59401643936ebb3dcfe1">IntelliImage::drawPoint</a></div><div class="ttdeci">virtual void drawPoint(const QPoint &amp;p1, const QColor &amp;color, const int &amp;penWidth)</div><div class="ttdoc">A.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8cpp_source.html#l00055">IntelliImage.cpp:55</a></div></div>
<div class="ttc" id="aclass_intelli_image_html_a47084f1cb668ea0242ab95162cf9e902"><div class="ttname"><a href="class_intelli_image.html#a47084f1cb668ea0242ab95162cf9e902">IntelliImage::IntelliImage</a></div><div class="ttdeci">IntelliImage(int weight, int height)</div><div class="ttdoc">The Construcor of the IntelliImage. Given the Image dimensions.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8cpp_source.html#l00005">IntelliImage.cpp:5</a></div></div>
<div class="ttc" id="aclass_intelli_image_html_a177403ab9585d4ba31984a644c54d310"><div class="ttname"><a href="class_intelli_image.html#a177403ab9585d4ba31984a644c54d310">IntelliImage::resizeImage</a></div><div class="ttdeci">void resizeImage(QImage *image, const QSize &amp;newSize)</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8cpp_source.html#l00029">IntelliImage.cpp:29</a></div></div>
<div class="ttc" id="aclass_intelli_image_html_a2431be82e9e85dd34b62a7f7cba053c2"><div class="ttname"><a href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">IntelliImage::imageData</a></div><div class="ttdeci">QImage imageData</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8h_source.html#l00023">IntelliImage.h:23</a></div></div>
<div class="ttc" id="aclass_intelli_image_html_a6be622810dc2bc756054bb5769becb06"><div class="ttname"><a href="class_intelli_image.html#a6be622810dc2bc756054bb5769becb06">IntelliImage::drawPlain</a></div><div class="ttdeci">virtual void drawPlain(const QColor &amp;color)</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8cpp_source.html#l00067">IntelliImage.cpp:67</a></div></div>
<div class="ttc" id="aclass_intelli_image_html_a4576ebb6d863321c816293d7b7f9fd3f"><div class="ttname"><a href="class_intelli_image.html#a4576ebb6d863321c816293d7b7f9fd3f">IntelliImage::getPixelColor</a></div><div class="ttdeci">virtual QColor getPixelColor(QPoint &amp;point)</div><div class="ttdoc">A function that returns the pixelcolor at a certain point.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8cpp_source.html#l00081">IntelliImage.cpp:81</a></div></div>
<div class="ttc" id="aclass_intelli_image_html_a2431be82e9e85dd34b62a7f7cba053c2"><div class="ttname"><a href="class_intelli_image.html#a2431be82e9e85dd34b62a7f7cba053c2">IntelliImage::imageData</a></div><div class="ttdeci">QImage imageData</div><div class="ttdoc">The underlying image data.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8h_source.html#l00032">IntelliImage.h:32</a></div></div>
<div class="ttc" id="aclass_intelli_image_html_a6be622810dc2bc756054bb5769becb06"><div class="ttname"><a href="class_intelli_image.html#a6be622810dc2bc756054bb5769becb06">IntelliImage::drawPlain</a></div><div class="ttdeci">virtual void drawPlain(const QColor &amp;color)</div><div class="ttdoc">A function that clears the whole image in a given Color.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_image_8cpp_source.html#l00077">IntelliImage.cpp:77</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_image_8cpp.html">IntelliImage.cpp</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_image_8cpp.html">IntelliImage.cpp</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>