208 lines
16 KiB
HTML
208 lines
16 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.14"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>identiconpp: Identiconpp Class Reference</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>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">identiconpp
|
|
 <span id="projectnumber">0.3.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',false,false,'search.php','Search');
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classIdenticonpp-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Identiconpp Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Base class for identiconpp.
|
|
<a href="classIdenticonpp.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="identiconpp_8hpp_source.html">identiconpp.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a229201bc23b0fabbcca60f2fe0188fa9"><td class="memItemLeft" align="right" valign="top"><a id="a229201bc23b0fabbcca60f2fe0188fa9"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classIdenticonpp.html#a229201bc23b0fabbcca60f2fe0188fa9">algorithm</a> { <b>ltr_symmetric</b>,
|
|
<b>ltr_asymmetric</b>,
|
|
<b>sigil</b>
|
|
}</td></tr>
|
|
<tr class="memdesc:a229201bc23b0fabbcca60f2fe0188fa9"><td class="mdescLeft"> </td><td class="mdescRight">List of identicon algorithms. <br /></td></tr>
|
|
<tr class="separator:a229201bc23b0fabbcca60f2fe0188fa9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ad87f4b0b3ebb0e54fe862fb5d77f8a00"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIdenticonpp.html#ad87f4b0b3ebb0e54fe862fb5d77f8a00">Identiconpp</a> (const uint8_t columns, const uint8_t rows, <a class="el" href="classIdenticonpp.html#a229201bc23b0fabbcca60f2fe0188fa9">algorithm</a> type=algorithm::ltr_symmetric, const string &background="ffffffff", const vector< string > &foreground={ "000000ff" }, const array< const uint8_t, 2 > &padding={ 0, 0 })</td></tr>
|
|
<tr class="memdesc:ad87f4b0b3ebb0e54fe862fb5d77f8a00"><td class="mdescLeft"> </td><td class="mdescRight">Initialises an instance of <a class="el" href="classIdenticonpp.html" title="Base class for identiconpp. ">Identiconpp</a>. <a href="#ad87f4b0b3ebb0e54fe862fb5d77f8a00">More...</a><br /></td></tr>
|
|
<tr class="separator:ad87f4b0b3ebb0e54fe862fb5d77f8a00"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a82f624d713e2d32d5fdb26b9112b821a"><td class="memItemLeft" align="right" valign="top">Magick::Image </td><td class="memItemRight" valign="bottom"><a class="el" href="classIdenticonpp.html#a82f624d713e2d32d5fdb26b9112b821a">generate</a> (const string &digest, const uint16_t width=100)</td></tr>
|
|
<tr class="memdesc:a82f624d713e2d32d5fdb26b9112b821a"><td class="mdescLeft"> </td><td class="mdescRight">Generates identicon from digest. <a href="#a82f624d713e2d32d5fdb26b9112b821a">More...</a><br /></td></tr>
|
|
<tr class="separator:a82f624d713e2d32d5fdb26b9112b821a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Base class for identiconpp. </p>
|
|
<p>Use this class for all your identicons. Exceptions will be thrown on error. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="ad87f4b0b3ebb0e54fe862fb5d77f8a00"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad87f4b0b3ebb0e54fe862fb5d77f8a00">◆ </a></span>Identiconpp()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Identiconpp::Identiconpp </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t </td>
|
|
<td class="paramname"><em>columns</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint8_t </td>
|
|
<td class="paramname"><em>rows</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classIdenticonpp.html#a229201bc23b0fabbcca60f2fe0188fa9">algorithm</a> </td>
|
|
<td class="paramname"><em>type</em> = <code>algorithm::ltr_symmetric</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>background</em> = <code>"ffffffff"</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const vector< string > & </td>
|
|
<td class="paramname"><em>foreground</em> = <code>{ "000000ff" }</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const array< const uint8_t, 2 > & </td>
|
|
<td class="paramname"><em>padding</em> = <code>{ 0, 0 }</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialises an instance of <a class="el" href="classIdenticonpp.html" title="Base class for identiconpp. ">Identiconpp</a>. </p>
|
|
<p>The instance can be used for creating identicons with differing image formats and sizes. The colors must consist of exactly 8 digits.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">columns</td><td>Number of columns </td></tr>
|
|
<tr><td class="paramname">rows</td><td>Number of rows </td></tr>
|
|
<tr><td class="paramname">type</td><td>The algorithm to use </td></tr>
|
|
<tr><td class="paramname">background</td><td>Background color, hexadecimal, rrggbbaa </td></tr>
|
|
<tr><td class="paramname">foreground</td><td>vector of foreground colors </td></tr>
|
|
<tr><td class="paramname">padding</td><td>Padding in pixels { left & right, top & down } </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<div class="fragment"><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> : _rows(rows)</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> , _columns(columns)</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> , _type(type)</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> , _background(background)</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> , _foreground(foreground)</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> , _padding(padding)</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  check_color(background);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keywordtype">string</span> &color : foreground)</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  check_color(color);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  }</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a82f624d713e2d32d5fdb26b9112b821a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a82f624d713e2d32d5fdb26b9112b821a">◆ </a></span>generate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Magick::Image Identiconpp::generate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>digest</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint16_t </td>
|
|
<td class="paramname"><em>width</em> = <code>100</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates identicon from digest. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">digest</td><td>The pre-computed digest </td></tr>
|
|
<tr><td class="paramname">width</td><td>The width of the image in pixels</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The image as Magick::Image </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  ttdebug << <span class="stringliteral">"Using digest: "</span> << digest << <span class="charliteral">'\n'</span>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  check_entropy(digest, _type);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">const</span> uint16_t imgwidth = width - _padding[0] * 2;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">const</span> uint16_t imgheight = imgwidth / _columns * _rows;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  ttdebug << <span class="stringliteral">"width: "</span> << std::to_string(imgwidth + _padding[0] * 2)</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  << <span class="stringliteral">", height: "</span> << std::to_string(imgheight + _padding[1] * 2)</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  << <span class="stringliteral">"\n"</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  Magick::Image img;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">switch</span> (_type)</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">case</span> algorithm::ltr_symmetric:</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  img = generate_ltr_symmetric(digest);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  }</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">case</span> algorithm::ltr_asymmetric:</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  {</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  img = generate_ltr_asymmetric(digest);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  }</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">case</span> algorithm::sigil:</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  {</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  img = generate_sigil(digest);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  }</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  }</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  img.backgroundColor(Magick::Color(<span class="charliteral">'#'</span> + _background));</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  img.scale(Magick::Geometry(imgwidth, imgheight));</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  img.borderColor(Magick::Color(<span class="charliteral">'#'</span> + _background));</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  img.border(Magick::Geometry(_padding[0], _padding[1]));</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">return</span> img;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/<a class="el" href="identiconpp_8hpp_source.html">identiconpp.hpp</a></li>
|
|
<li>src/checks.cpp</li>
|
|
<li>src/identiconpp.cpp</li>
|
|
<li>src/ltr_asymmetric.cpp</li>
|
|
<li>src/ltr_symmetric.cpp</li>
|
|
<li>src/sigil.cpp</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.14
|
|
</small></address>
|
|
</body>
|
|
</html>
|