summaryrefslogtreecommitdiff
path: root/docs/class_tg_bot_1_1_mask_position.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/class_tg_bot_1_1_mask_position.html')
-rw-r--r--docs/class_tg_bot_1_1_mask_position.html25
1 files changed, 18 insertions, 7 deletions
diff --git a/docs/class_tg_bot_1_1_mask_position.html b/docs/class_tg_bot_1_1_mask_position.html
index 266e9ab..109cf7a 100644
--- a/docs/class_tg_bot_1_1_mask_position.html
+++ b/docs/class_tg_bot_1_1_mask_position.html
@@ -88,6 +88,9 @@ $(document).ready(function(){initNavTree('class_tg_bot_1_1_mask_position.html','
</div><!--header-->
<div class="contents">
+<p>This object describes the position on faces where a mask should be placed by default.
+ <a href="class_tg_bot_1_1_mask_position.html#details">More...</a></p>
+
<p><code>#include &lt;<a class="el" href="_mask_position_8h_source.html">MaskPosition.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
@@ -98,18 +101,22 @@ Public Types</h2></td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a8c22f087cecfcc16c6c563a6df6c9d7e"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_mask_position.html#a8c22f087cecfcc16c6c563a6df6c9d7e">point</a></td></tr>
+<tr class="memdesc:a8c22f087cecfcc16c6c563a6df6c9d7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”. <a href="#a8c22f087cecfcc16c6c563a6df6c9d7e">More...</a><br /></td></tr>
<tr class="separator:a8c22f087cecfcc16c6c563a6df6c9d7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4e73bf83077bce72be0ee031f2f5d83"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_mask_position.html#ac4e73bf83077bce72be0ee031f2f5d83">xShift</a></td></tr>
+<tr class="memdesc:ac4e73bf83077bce72be0ee031f2f5d83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position. <a href="#ac4e73bf83077bce72be0ee031f2f5d83">More...</a><br /></td></tr>
<tr class="separator:ac4e73bf83077bce72be0ee031f2f5d83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56700f4f5ce4902c978df680cfd6a424"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_mask_position.html#a56700f4f5ce4902c978df680cfd6a424">yShift</a></td></tr>
+<tr class="memdesc:a56700f4f5ce4902c978df680cfd6a424"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position. <a href="#a56700f4f5ce4902c978df680cfd6a424">More...</a><br /></td></tr>
<tr class="separator:a56700f4f5ce4902c978df680cfd6a424"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f78e6dcdb37975c435cfd0d9a923963"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_mask_position.html#a8f78e6dcdb37975c435cfd0d9a923963">scale</a></td></tr>
+<tr class="memdesc:a8f78e6dcdb37975c435cfd0d9a923963"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mask scaling coefficient. For example, 2.0 means double size. <a href="#a8f78e6dcdb37975c435cfd0d9a923963">More...</a><br /></td></tr>
<tr class="separator:a8f78e6dcdb37975c435cfd0d9a923963"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This object describes the position on faces where a mask should be placed by default. </p>
-<p class="definition">Definition at line <a class="el" href="_mask_position_8h_source.html#l00036">36</a> of file <a class="el" href="_mask_position_8h_source.html">MaskPosition.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_mask_position_8h_source.html#l00037">37</a> of file <a class="el" href="_mask_position_8h_source.html">MaskPosition.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a37edf3eefbf231ee8ab94a29425b3fe1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37edf3eefbf231ee8ab94a29425b3fe1">&#9670;&nbsp;</a></span>Ptr</h2>
@@ -123,7 +130,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
-<p class="definition">Definition at line <a class="el" href="_mask_position_8h_source.html#l00038">38</a> of file <a class="el" href="_mask_position_8h_source.html">MaskPosition.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_mask_position_8h_source.html#l00039">39</a> of file <a class="el" href="_mask_position_8h_source.html">MaskPosition.h</a>.</p>
</div>
</div>
@@ -139,9 +146,10 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
+
<p>The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”. </p>
-<p class="definition">Definition at line <a class="el" href="_mask_position_8h_source.html#l00043">43</a> of file <a class="el" href="_mask_position_8h_source.html">MaskPosition.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_mask_position_8h_source.html#l00044">44</a> of file <a class="el" href="_mask_position_8h_source.html">MaskPosition.h</a>.</p>
</div>
</div>
@@ -156,9 +164,10 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
+
<p>Mask scaling coefficient. For example, 2.0 means double size. </p>
-<p class="definition">Definition at line <a class="el" href="_mask_position_8h_source.html#l00058">58</a> of file <a class="el" href="_mask_position_8h_source.html">MaskPosition.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_mask_position_8h_source.html#l00059">59</a> of file <a class="el" href="_mask_position_8h_source.html">MaskPosition.h</a>.</p>
</div>
</div>
@@ -173,9 +182,10 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
+
<p>Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position. </p>
-<p class="definition">Definition at line <a class="el" href="_mask_position_8h_source.html#l00048">48</a> of file <a class="el" href="_mask_position_8h_source.html">MaskPosition.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_mask_position_8h_source.html#l00049">49</a> of file <a class="el" href="_mask_position_8h_source.html">MaskPosition.h</a>.</p>
</div>
</div>
@@ -190,9 +200,10 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
+
<p>Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position. </p>
-<p class="definition">Definition at line <a class="el" href="_mask_position_8h_source.html#l00053">53</a> of file <a class="el" href="_mask_position_8h_source.html">MaskPosition.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_mask_position_8h_source.html#l00054">54</a> of file <a class="el" href="_mask_position_8h_source.html">MaskPosition.h</a>.</p>
</div>
</div>
@@ -205,7 +216,7 @@ Public Attributes</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespace_tg_bot.html">TgBot</a></li><li class="navelem"><a class="el" href="class_tg_bot_1_1_mask_position.html">MaskPosition</a></li>
- <li class="footer">Generated on Mon May 28 2018 13:57:33 for tgbot-cpp by
+ <li class="footer">Generated on Tue Jun 5 2018 19:07:15 for tgbot-cpp by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>