3f2732194e21a7f94ec2ed9c9df067029c6dc0f3
[platform/core/graphics/tizenvg.git] / docs / html / classtvg_1_1Paint.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>ThorVG: Paint</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="resize.js"></script>
14 <script type="text/javascript" src="navtreedata.js"></script>
15 <script type="text/javascript" src="navtree.js"></script>
16 <script type="text/javascript">
17   $(document).ready(initResizable);
18 </script>
19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
20 <script type="text/javascript" src="search/searchdata.js"></script>
21 <script type="text/javascript" src="search/search.js"></script>
22 <link href="doxygen.css" rel="stylesheet" type="text/css" />
23 <link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
24 </head>
25 <body>
26 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
27 <div id="titlearea">
28 <table cellspacing="0" cellpadding="0">
29  <tbody>
30  <tr style="height: 56px;">
31   <td id="projectlogo"><img alt="Logo" src="docs_logo.svg"/></td>
32   <td id="projectalign" style="padding-left: 0.5em;">
33    <div id="projectname">ThorVG
34    &#160;<span id="projectnumber">v0.1</span>
35    </div>
36    <div id="projectbrief">ThorVG is a platform-independent portable library for drawing vector-based scene and animation. It&#39;s an open-source software that is freely used by a variety of software platforms and applications. ThorVG provides neat and easy APIs, its library has no dependencies and keeps cheap and super compact size. It serves as the vector graphics engine for Tizen OS that powers many products.</div>
37   </td>
38  </tr>
39  </tbody>
40 </table>
41 </div>
42 <!-- end header part -->
43 <!-- Generated by Doxygen 1.8.13 -->
44 <script type="text/javascript">
45 var searchBox = new SearchBox("searchBox", "search",false,'Search');
46 </script>
47 <script type="text/javascript" src="menudata.js"></script>
48 <script type="text/javascript" src="menu.js"></script>
49 <script type="text/javascript">
50 $(function() {
51   initMenu('',true,false,'search.php','Search');
52   $(document).ready(function() { init_search(); });
53 });
54 </script>
55 <div id="main-nav"></div>
56 </div><!-- top -->
57 <div id="side-nav" class="ui-resizable side-nav-resizable">
58   <div id="nav-tree">
59     <div id="nav-tree-contents">
60       <div id="nav-sync" class="sync"></div>
61     </div>
62   </div>
63   <div id="splitbar" style="-moz-user-select:none;" 
64        class="ui-resizable-handle">
65   </div>
66 </div>
67 <script type="text/javascript">
68 $(document).ready(function(){initNavTree('classtvg_1_1Paint.html','');});
69 </script>
70 <div id="doc-content">
71 <!-- window showing the filter options -->
72 <div id="MSearchSelectWindow"
73      onmouseover="return searchBox.OnSearchSelectShow()"
74      onmouseout="return searchBox.OnSearchSelectHide()"
75      onkeydown="return searchBox.OnSearchSelectKey(event)">
76 </div>
77
78 <!-- iframe showing the search results (closed by default) -->
79 <div id="MSearchResultsWindow">
80 <iframe src="javascript:void(0)" frameborder="0" 
81         name="MSearchResults" id="MSearchResults">
82 </iframe>
83 </div>
84
85 <div class="header">
86   <div class="summary">
87 <a href="#pub-methods">Public Member Functions</a> &#124;
88 <a href="classtvg_1_1Paint-members.html">List of all members</a>  </div>
89   <div class="headertitle">
90 <div class="title">Paint<div class="ingroups"><a class="el" href="group__ThorVG.html">ThorVG</a></div></div>  </div>
91 </div><!--header-->
92 <div class="contents">
93
94 <p>An abstract class for managing graphical elements.  
95  <a href="classtvg_1_1Paint.html#details">More...</a></p>
96 <div class="dynheader">
97 Inheritance diagram for Paint:</div>
98 <div class="dyncontent">
99 <div class="center"><img src="classtvg_1_1Paint__inherit__graph.png" border="0" usemap="#Paint_inherit__map" alt="Inheritance graph"/></div>
100 <map name="Paint_inherit__map" id="Paint_inherit__map">
101 <area shape="rect" id="node2" href="classtvg_1_1Picture.html" title="A class representing an image read in one of the supported formats: raw, svg, png and etc..." alt="" coords="5,80,68,107"/>
102 <area shape="rect" id="node3" href="classtvg_1_1Scene.html" title="A class to composite children paints. " alt="" coords="93,80,151,107"/>
103 <area shape="rect" id="node4" href="classtvg_1_1Shape.html" title="A class representing two&#45;dimensional figures and their properties. " alt="" coords="175,80,234,107"/>
104 </map>
105 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
106 <table class="memberdecls">
107 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
108 Public Member Functions</h2></td></tr>
109 <tr class="memitem:a7841fa0c14643e09735d48042ead68f3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Paint.html#a7841fa0c14643e09735d48042ead68f3">rotate</a> (float degree) noexcept</td></tr>
110 <tr class="memdesc:a7841fa0c14643e09735d48042ead68f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the angle by which the object is rotated.  <a href="#a7841fa0c14643e09735d48042ead68f3">More...</a><br /></td></tr>
111 <tr class="separator:a7841fa0c14643e09735d48042ead68f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
112 <tr class="memitem:a5c057876185525c5723215f95a3984f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Paint.html#a5c057876185525c5723215f95a3984f2">scale</a> (float factor) noexcept</td></tr>
113 <tr class="memdesc:a5c057876185525c5723215f95a3984f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the scale value of the object.  <a href="#a5c057876185525c5723215f95a3984f2">More...</a><br /></td></tr>
114 <tr class="separator:a5c057876185525c5723215f95a3984f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
115 <tr class="memitem:ae896f56bfa51c98a50eee3f2bb62e41e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Paint.html#ae896f56bfa51c98a50eee3f2bb62e41e">translate</a> (float x, float y) noexcept</td></tr>
116 <tr class="memdesc:ae896f56bfa51c98a50eee3f2bb62e41e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the values by which the object is moved in a two-dimensional space.  <a href="#ae896f56bfa51c98a50eee3f2bb62e41e">More...</a><br /></td></tr>
117 <tr class="separator:ae896f56bfa51c98a50eee3f2bb62e41e"><td class="memSeparator" colspan="2">&#160;</td></tr>
118 <tr class="memitem:ac9f6ba428afe884bcc2861de0a2a96f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Paint.html#ac9f6ba428afe884bcc2861de0a2a96f4">transform</a> (const <a class="el" href="structtvg_1_1Matrix.html">Matrix</a> &amp;m) noexcept</td></tr>
119 <tr class="memdesc:ac9f6ba428afe884bcc2861de0a2a96f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the matrix of the affine transformation for the object.  <a href="#ac9f6ba428afe884bcc2861de0a2a96f4">More...</a><br /></td></tr>
120 <tr class="separator:ac9f6ba428afe884bcc2861de0a2a96f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
121 <tr class="memitem:a2f25b71fed3ae390eb8051c7ea65aebf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Paint.html#a2f25b71fed3ae390eb8051c7ea65aebf">opacity</a> (uint8_t o) noexcept</td></tr>
122 <tr class="memdesc:a2f25b71fed3ae390eb8051c7ea65aebf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the opacity of the object.  <a href="#a2f25b71fed3ae390eb8051c7ea65aebf">More...</a><br /></td></tr>
123 <tr class="separator:a2f25b71fed3ae390eb8051c7ea65aebf"><td class="memSeparator" colspan="2">&#160;</td></tr>
124 <tr class="memitem:aab93150647927b8f2006b5ae45b7b093"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Paint.html#aab93150647927b8f2006b5ae45b7b093">composite</a> (std::unique_ptr&lt; <a class="el" href="classtvg_1_1Paint.html">Paint</a> &gt; target, <a class="el" href="group__ThorVG.html#gaabdf94ada64e69d06deabc5aa6576f87">CompositeMethod</a> method) const noexcept</td></tr>
125 <tr class="memdesc:aab93150647927b8f2006b5ae45b7b093"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the composition target object and the composition method.  <a href="#aab93150647927b8f2006b5ae45b7b093">More...</a><br /></td></tr>
126 <tr class="separator:aab93150647927b8f2006b5ae45b7b093"><td class="memSeparator" colspan="2">&#160;</td></tr>
127 <tr class="memitem:a6d4e91eeca737b135064caadab4b4dff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Paint.html#a6d4e91eeca737b135064caadab4b4dff">bounds</a> (float *x, float *y, float *w, float *h) const noexcept</td></tr>
128 <tr class="memdesc:a6d4e91eeca737b135064caadab4b4dff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the bounding box of the paint object before any transformation.  <a href="#a6d4e91eeca737b135064caadab4b4dff">More...</a><br /></td></tr>
129 <tr class="separator:a6d4e91eeca737b135064caadab4b4dff"><td class="memSeparator" colspan="2">&#160;</td></tr>
130 <tr class="memitem:a71afac69fe1e7c352460be5878812635"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classtvg_1_1Paint.html">Paint</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Paint.html#a71afac69fe1e7c352460be5878812635">duplicate</a> () const noexcept</td></tr>
131 <tr class="memdesc:a71afac69fe1e7c352460be5878812635"><td class="mdescLeft">&#160;</td><td class="mdescRight">Duplicates the object.  <a href="#a71afac69fe1e7c352460be5878812635">More...</a><br /></td></tr>
132 <tr class="separator:a71afac69fe1e7c352460be5878812635"><td class="memSeparator" colspan="2">&#160;</td></tr>
133 <tr class="memitem:a2ee7517b8bfad47e0f999ba3450e0e3e"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Paint.html#a2ee7517b8bfad47e0f999ba3450e0e3e">opacity</a> () const noexcept</td></tr>
134 <tr class="memdesc:a2ee7517b8bfad47e0f999ba3450e0e3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the opacity value of the object.  <a href="#a2ee7517b8bfad47e0f999ba3450e0e3e">More...</a><br /></td></tr>
135 <tr class="separator:a2ee7517b8bfad47e0f999ba3450e0e3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
136 </table>
137 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
138 <div class="textblock"><p>An abstract class for managing graphical elements. </p>
139 <p>A graphical element in TVG is any object composed into a <a class="el" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements. ">Canvas</a>. <a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements. ">Paint</a> represents such a graphical object and its behaviors such as duplication, transformation and composition. TVG recommends the user to regard a paint as a set of volatile commands. They can prepare a <a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements. ">Paint</a> and then request a <a class="el" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements. ">Canvas</a> to run them. </p>
140 </div><h2 class="groupheader">Member Function Documentation</h2>
141 <a id="a6d4e91eeca737b135064caadab4b4dff"></a>
142 <h2 class="memtitle"><span class="permalink"><a href="#a6d4e91eeca737b135064caadab4b4dff">&#9670;&nbsp;</a></span>bounds()</h2>
143
144 <div class="memitem">
145 <div class="memproto">
146 <table class="mlabels">
147   <tr>
148   <td class="mlabels-left">
149       <table class="memname">
150         <tr>
151           <td class="memname"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> bounds </td>
152           <td>(</td>
153           <td class="paramtype">float *&#160;</td>
154           <td class="paramname"><em>x</em>, </td>
155         </tr>
156         <tr>
157           <td class="paramkey"></td>
158           <td></td>
159           <td class="paramtype">float *&#160;</td>
160           <td class="paramname"><em>y</em>, </td>
161         </tr>
162         <tr>
163           <td class="paramkey"></td>
164           <td></td>
165           <td class="paramtype">float *&#160;</td>
166           <td class="paramname"><em>w</em>, </td>
167         </tr>
168         <tr>
169           <td class="paramkey"></td>
170           <td></td>
171           <td class="paramtype">float *&#160;</td>
172           <td class="paramname"><em>h</em>&#160;</td>
173         </tr>
174         <tr>
175           <td></td>
176           <td>)</td>
177           <td></td><td> const</td>
178         </tr>
179       </table>
180   </td>
181   <td class="mlabels-right">
182 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
183   </tr>
184 </table>
185 </div><div class="memdoc">
186
187 <p>Gets the bounding box of the paint object before any transformation. </p>
188 <dl class="params"><dt>Parameters</dt><dd>
189   <table class="params">
190     <tr><td class="paramdir">[out]</td><td class="paramname">x</td><td>The x coordinate of the upper left corner of the object. </td></tr>
191     <tr><td class="paramdir">[out]</td><td class="paramname">y</td><td>The y coordinate of the upper left corner of the object. </td></tr>
192     <tr><td class="paramdir">[out]</td><td class="paramname">w</td><td>The width of the object. </td></tr>
193     <tr><td class="paramdir">[out]</td><td class="paramname">h</td><td>The height of the object.</td></tr>
194   </table>
195   </dd>
196 </dl>
197 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38" title="The value returned in case of a correct request execution. ">Result::Success</a> when succeed, <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a119732ff568bf103d744e930ae2404f1" title="The value returned in case the request cannot be processed - e.g. asking for properties of an object...">Result::InsufficientCondition</a> otherwise.</dd></dl>
198 <dl class="section note"><dt>Note</dt><dd>The bounding box doesn't indicate the final rendered region. It's the smallest rectangle that encloses the object. </dd></dl>
199
200 </div>
201 </div>
202 <a id="aab93150647927b8f2006b5ae45b7b093"></a>
203 <h2 class="memtitle"><span class="permalink"><a href="#aab93150647927b8f2006b5ae45b7b093">&#9670;&nbsp;</a></span>composite()</h2>
204
205 <div class="memitem">
206 <div class="memproto">
207 <table class="mlabels">
208   <tr>
209   <td class="mlabels-left">
210       <table class="memname">
211         <tr>
212           <td class="memname"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> composite </td>
213           <td>(</td>
214           <td class="paramtype">std::unique_ptr&lt; <a class="el" href="classtvg_1_1Paint.html">Paint</a> &gt;&#160;</td>
215           <td class="paramname"><em>target</em>, </td>
216         </tr>
217         <tr>
218           <td class="paramkey"></td>
219           <td></td>
220           <td class="paramtype"><a class="el" href="group__ThorVG.html#gaabdf94ada64e69d06deabc5aa6576f87">CompositeMethod</a>&#160;</td>
221           <td class="paramname"><em>method</em>&#160;</td>
222         </tr>
223         <tr>
224           <td></td>
225           <td>)</td>
226           <td></td><td> const</td>
227         </tr>
228       </table>
229   </td>
230   <td class="mlabels-right">
231 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
232   </tr>
233 </table>
234 </div><div class="memdoc">
235
236 <p>Sets the composition target object and the composition method. </p>
237 <dl class="params"><dt>Parameters</dt><dd>
238   <table class="params">
239     <tr><td class="paramdir">[in]</td><td class="paramname">target</td><td>The paint of the target object. </td></tr>
240     <tr><td class="paramdir">[in]</td><td class="paramname">method</td><td>The method used to composite the source object with the target.</td></tr>
241   </table>
242   </dd>
243 </dl>
244 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38" title="The value returned in case of a correct request execution. ">Result::Success</a> when succeed, <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066ae73a2e92f1c87086c838b442552a4775" title="The value returned in the event of a problem with the arguments given to the API - e...">Result::InvalidArguments</a> otherwise. </dd></dl>
245
246 </div>
247 </div>
248 <a id="a71afac69fe1e7c352460be5878812635"></a>
249 <h2 class="memtitle"><span class="permalink"><a href="#a71afac69fe1e7c352460be5878812635">&#9670;&nbsp;</a></span>duplicate()</h2>
250
251 <div class="memitem">
252 <div class="memproto">
253 <table class="mlabels">
254   <tr>
255   <td class="mlabels-left">
256       <table class="memname">
257         <tr>
258           <td class="memname"><a class="el" href="classtvg_1_1Paint.html">Paint</a>* duplicate </td>
259           <td>(</td>
260           <td class="paramname"></td><td>)</td>
261           <td> const</td>
262         </tr>
263       </table>
264   </td>
265   <td class="mlabels-right">
266 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
267   </tr>
268 </table>
269 </div><div class="memdoc">
270
271 <p>Duplicates the object. </p>
272 <p>Creates a new object and sets its all properties as in the original object.</p>
273 <dl class="section return"><dt>Returns</dt><dd>The created object when succeed, <code>nullptr</code> otherwise. </dd></dl>
274
275 </div>
276 </div>
277 <a id="a2f25b71fed3ae390eb8051c7ea65aebf"></a>
278 <h2 class="memtitle"><span class="permalink"><a href="#a2f25b71fed3ae390eb8051c7ea65aebf">&#9670;&nbsp;</a></span>opacity() <span class="overload">[1/2]</span></h2>
279
280 <div class="memitem">
281 <div class="memproto">
282 <table class="mlabels">
283   <tr>
284   <td class="mlabels-left">
285       <table class="memname">
286         <tr>
287           <td class="memname"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> opacity </td>
288           <td>(</td>
289           <td class="paramtype">uint8_t&#160;</td>
290           <td class="paramname"><em>o</em></td><td>)</td>
291           <td></td>
292         </tr>
293       </table>
294   </td>
295   <td class="mlabels-right">
296 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
297   </tr>
298 </table>
299 </div><div class="memdoc">
300
301 <p>Sets the opacity of the object. </p>
302 <dl class="params"><dt>Parameters</dt><dd>
303   <table class="params">
304     <tr><td class="paramdir">[in]</td><td class="paramname">o</td><td>The opacity value in the range [0 ~ 255], where 0 is completely transparent and 255 is opaque.</td></tr>
305   </table>
306   </dd>
307 </dl>
308 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38" title="The value returned in case of a correct request execution. ">Result::Success</a> when succeed.</dd></dl>
309 <dl class="section note"><dt>Note</dt><dd>Setting the opacity with this API may require multiple render pass for composition. It is recommended to avoid changing the opacity if possible. </dd></dl>
310
311 </div>
312 </div>
313 <a id="a2ee7517b8bfad47e0f999ba3450e0e3e"></a>
314 <h2 class="memtitle"><span class="permalink"><a href="#a2ee7517b8bfad47e0f999ba3450e0e3e">&#9670;&nbsp;</a></span>opacity() <span class="overload">[2/2]</span></h2>
315
316 <div class="memitem">
317 <div class="memproto">
318 <table class="mlabels">
319   <tr>
320   <td class="mlabels-left">
321       <table class="memname">
322         <tr>
323           <td class="memname">uint8_t opacity </td>
324           <td>(</td>
325           <td class="paramname"></td><td>)</td>
326           <td> const</td>
327         </tr>
328       </table>
329   </td>
330   <td class="mlabels-right">
331 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
332   </tr>
333 </table>
334 </div><div class="memdoc">
335
336 <p>Gets the opacity value of the object. </p>
337 <dl class="section return"><dt>Returns</dt><dd>The opacity value in the range [0 ~ 255], where 0 is completely transparent and 255 is opaque. </dd></dl>
338
339 </div>
340 </div>
341 <a id="a7841fa0c14643e09735d48042ead68f3"></a>
342 <h2 class="memtitle"><span class="permalink"><a href="#a7841fa0c14643e09735d48042ead68f3">&#9670;&nbsp;</a></span>rotate()</h2>
343
344 <div class="memitem">
345 <div class="memproto">
346 <table class="mlabels">
347   <tr>
348   <td class="mlabels-left">
349       <table class="memname">
350         <tr>
351           <td class="memname"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> rotate </td>
352           <td>(</td>
353           <td class="paramtype">float&#160;</td>
354           <td class="paramname"><em>degree</em></td><td>)</td>
355           <td></td>
356         </tr>
357       </table>
358   </td>
359   <td class="mlabels-right">
360 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
361   </tr>
362 </table>
363 </div><div class="memdoc">
364
365 <p>Sets the angle by which the object is rotated. </p>
366 <p>The angle in measured clockwise from the horizontal axis. The rotational axis passes through the point on the object with zero coordinates.</p>
367 <dl class="params"><dt>Parameters</dt><dd>
368   <table class="params">
369     <tr><td class="paramdir">[in]</td><td class="paramname">degree</td><td>The value of the angle in degrees.</td></tr>
370   </table>
371   </dd>
372 </dl>
373 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38" title="The value returned in case of a correct request execution. ">Result::Success</a> when succeed, <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066abc2b4181e818f2e9b52b2bc54dd55907" title="The value returned in case of unsuccessful memory allocation. ">Result::FailedAllocation</a> otherwise. </dd></dl>
374
375 </div>
376 </div>
377 <a id="a5c057876185525c5723215f95a3984f2"></a>
378 <h2 class="memtitle"><span class="permalink"><a href="#a5c057876185525c5723215f95a3984f2">&#9670;&nbsp;</a></span>scale()</h2>
379
380 <div class="memitem">
381 <div class="memproto">
382 <table class="mlabels">
383   <tr>
384   <td class="mlabels-left">
385       <table class="memname">
386         <tr>
387           <td class="memname"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> scale </td>
388           <td>(</td>
389           <td class="paramtype">float&#160;</td>
390           <td class="paramname"><em>factor</em></td><td>)</td>
391           <td></td>
392         </tr>
393       </table>
394   </td>
395   <td class="mlabels-right">
396 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
397   </tr>
398 </table>
399 </div><div class="memdoc">
400
401 <p>Sets the scale value of the object. </p>
402 <dl class="params"><dt>Parameters</dt><dd>
403   <table class="params">
404     <tr><td class="paramdir">[in]</td><td class="paramname">factor</td><td>The value of the scaling factor. The default value is 1.</td></tr>
405   </table>
406   </dd>
407 </dl>
408 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38" title="The value returned in case of a correct request execution. ">Result::Success</a> when succeed, <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066abc2b4181e818f2e9b52b2bc54dd55907" title="The value returned in case of unsuccessful memory allocation. ">Result::FailedAllocation</a> otherwise. </dd></dl>
409
410 </div>
411 </div>
412 <a id="ac9f6ba428afe884bcc2861de0a2a96f4"></a>
413 <h2 class="memtitle"><span class="permalink"><a href="#ac9f6ba428afe884bcc2861de0a2a96f4">&#9670;&nbsp;</a></span>transform()</h2>
414
415 <div class="memitem">
416 <div class="memproto">
417 <table class="mlabels">
418   <tr>
419   <td class="mlabels-left">
420       <table class="memname">
421         <tr>
422           <td class="memname"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> transform </td>
423           <td>(</td>
424           <td class="paramtype">const <a class="el" href="structtvg_1_1Matrix.html">Matrix</a> &amp;&#160;</td>
425           <td class="paramname"><em>m</em></td><td>)</td>
426           <td></td>
427         </tr>
428       </table>
429   </td>
430   <td class="mlabels-right">
431 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
432   </tr>
433 </table>
434 </div><div class="memdoc">
435
436 <p>Sets the matrix of the affine transformation for the object. </p>
437 <p>The augmented matrix of the transformation is expected to be given.</p>
438 <dl class="params"><dt>Parameters</dt><dd>
439   <table class="params">
440     <tr><td class="paramdir">[in]</td><td class="paramname">m</td><td>The 3x3 augmented matrix.</td></tr>
441   </table>
442   </dd>
443 </dl>
444 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38" title="The value returned in case of a correct request execution. ">Result::Success</a> when succeed, <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066abc2b4181e818f2e9b52b2bc54dd55907" title="The value returned in case of unsuccessful memory allocation. ">Result::FailedAllocation</a> otherwise. </dd></dl>
445
446 </div>
447 </div>
448 <a id="ae896f56bfa51c98a50eee3f2bb62e41e"></a>
449 <h2 class="memtitle"><span class="permalink"><a href="#ae896f56bfa51c98a50eee3f2bb62e41e">&#9670;&nbsp;</a></span>translate()</h2>
450
451 <div class="memitem">
452 <div class="memproto">
453 <table class="mlabels">
454   <tr>
455   <td class="mlabels-left">
456       <table class="memname">
457         <tr>
458           <td class="memname"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> translate </td>
459           <td>(</td>
460           <td class="paramtype">float&#160;</td>
461           <td class="paramname"><em>x</em>, </td>
462         </tr>
463         <tr>
464           <td class="paramkey"></td>
465           <td></td>
466           <td class="paramtype">float&#160;</td>
467           <td class="paramname"><em>y</em>&#160;</td>
468         </tr>
469         <tr>
470           <td></td>
471           <td>)</td>
472           <td></td><td></td>
473         </tr>
474       </table>
475   </td>
476   <td class="mlabels-right">
477 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
478   </tr>
479 </table>
480 </div><div class="memdoc">
481
482 <p>Sets the values by which the object is moved in a two-dimensional space. </p>
483 <p>The origin of the coordinate system is in the upper left corner of the canvas. The horizontal and vertical axes point to the right and down, respectively.</p>
484 <dl class="params"><dt>Parameters</dt><dd>
485   <table class="params">
486     <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>The value of the horizontal shift. </td></tr>
487     <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>The value of the vertical shift.</td></tr>
488   </table>
489   </dd>
490 </dl>
491 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38" title="The value returned in case of a correct request execution. ">Result::Success</a> when succeed, <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066abc2b4181e818f2e9b52b2bc54dd55907" title="The value returned in case of unsuccessful memory allocation. ">Result::FailedAllocation</a> otherwise. </dd></dl>
492
493 </div>
494 </div>
495 </div><!-- contents -->
496 </div><!-- doc-content -->
497 <!-- start footer part -->
498 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
499   <ul>
500     <li class="navelem"><b>tvg</b></li><li class="navelem"><a class="el" href="classtvg_1_1Paint.html">Paint</a></li>
501     <li class="footer">Generated by
502     <a href="http://www.doxygen.org/index.html">
503     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
504   </ul>
505 </div>
506 </body>
507 </html>