doc/reference/clutter/html/ClutterPageTurnEffect.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>ClutterPageTurnEffect</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="Clutter Reference Manual">
   8 <link rel="up" href="ch06.html" title="Effects">
   9 <link rel="prev" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect">
  10 <link rel="next" href="ch07.html" title="Content">
  11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="ClutterDesaturateEffect.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">Clutter Reference Manual</th>
  21 <td><a accesskey="n" href="ch07.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#ClutterPageTurnEffect.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterPageTurnEffect.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterPageTurnEffect.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterPageTurnEffect.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="ClutterPageTurnEffect"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="ClutterPageTurnEffect.top_of_page"></a>ClutterPageTurnEffect</span></h2>
  38 <p>ClutterPageTurnEffect — A page turning effect</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="ClutterPageTurnEffect.synopsis"></a><h2>Synopsis</h2>
  44 <pre class="synopsis">                    <a class="link" href="ClutterPageTurnEffect.html#ClutterPageTurnEffect-struct" title="ClutterPageTurnEffect">ClutterPageTurnEffect</a>;
  45 <a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="returnvalue">ClutterEffect</span></a> *     <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-new" title="clutter_page_turn_effect_new ()">clutter_page_turn_effect_new</a>        (<em class="parameter"><code><span class="type">gdouble</span> period</code></em>,
  46                                                          <em class="parameter"><code><span class="type">gdouble</span> angle</code></em>,
  47                                                          <em class="parameter"><code><span class="type">gfloat</span> radius</code></em>);
  48 <span class="returnvalue">void</span>                <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-set-period" title="clutter_page_turn_effect_set_period ()">clutter_page_turn_effect_set_period</a> (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>,
  49                                                          <em class="parameter"><code><span class="type">gdouble</span> period</code></em>);
  50 <span class="returnvalue">gdouble</span>             <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-get-period" title="clutter_page_turn_effect_get_period ()">clutter_page_turn_effect_get_period</a> (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>);
  51 <span class="returnvalue">void</span>                <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-set-angle" title="clutter_page_turn_effect_set_angle ()">clutter_page_turn_effect_set_angle</a>  (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>,
  52                                                          <em class="parameter"><code><span class="type">gdouble</span> angle</code></em>);
  53 <span class="returnvalue">gdouble</span>             <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-get-angle" title="clutter_page_turn_effect_get_angle ()">clutter_page_turn_effect_get_angle</a>  (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>);
  54 <span class="returnvalue">void</span>                <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-set-radius" title="clutter_page_turn_effect_set_radius ()">clutter_page_turn_effect_set_radius</a> (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>,
  55                                                          <em class="parameter"><code><span class="type">gfloat</span> radius</code></em>);
  56 <span class="returnvalue">gfloat</span>              <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-get-radius" title="clutter_page_turn_effect_get_radius ()">clutter_page_turn_effect_get_radius</a> (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>);
  57 </pre>
  58 </div>
  59 <div class="refsect1">
  60 <a name="ClutterPageTurnEffect.object-hierarchy"></a><h2>Object Hierarchy</h2>
  61 <pre class="synopsis">
  62   GObject
  63    +----GInitiallyUnowned
  64          +----<a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta">ClutterActorMeta</a>
  65                +----<a class="link" href="ClutterEffect.html" title="ClutterEffect">ClutterEffect</a>
  66                      +----<a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect">ClutterOffscreenEffect</a>
  67                            +----<a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect">ClutterDeformEffect</a>
  68                                  +----ClutterPageTurnEffect
  69 </pre>
  70 </div>
  71 <div class="refsect1">
  72 <a name="ClutterPageTurnEffect.properties"></a><h2>Properties</h2>
  73 <pre class="synopsis">
  74   "<a class="link" href="ClutterPageTurnEffect.html#ClutterPageTurnEffect--angle" title='The "angle" property'>angle</a>"                    <span class="type">gdouble</span>               : Read / Write
  75   "<a class="link" href="ClutterPageTurnEffect.html#ClutterPageTurnEffect--period" title='The "period" property'>period</a>"                   <span class="type">gdouble</span>               : Read / Write
  76   "<a class="link" href="ClutterPageTurnEffect.html#ClutterPageTurnEffect--radius" title='The "radius" property'>radius</a>"                   <span class="type">gfloat</span>                : Read / Write
  77 </pre>
  78 </div>
  79 <div class="refsect1">
  80 <a name="ClutterPageTurnEffect.description"></a><h2>Description</h2>
  81 <p>
  82 A simple page turning effect
  83 </p>
  84 <p>
  85 <a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> is available since Clutter 1.4
  86 </p>
  87 </div>
  88 <div class="refsect1">
  89 <a name="ClutterPageTurnEffect.details"></a><h2>Details</h2>
  90 <div class="refsect2">
  91 <a name="ClutterPageTurnEffect-struct"></a><h3>ClutterPageTurnEffect</h3>
  92 <pre class="programlisting">typedef struct _ClutterPageTurnEffect ClutterPageTurnEffect;</pre>
  93 <p>
  94 <span class="structname">ClutterPageTurnEffect</span> is an opaque structure
  95 whose members can only be accessed using the provided API
  96 </p>
  97 <p class="since">Since 1.4</p>
  98 </div>
  99 <hr>
 100 <div class="refsect2">
 101 <a name="clutter-page-turn-effect-new"></a><h3>clutter_page_turn_effect_new ()</h3>
 102 <pre class="programlisting"><a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="returnvalue">ClutterEffect</span></a> *     clutter_page_turn_effect_new        (<em class="parameter"><code><span class="type">gdouble</span> period</code></em>,
 103                                                          <em class="parameter"><code><span class="type">gdouble</span> angle</code></em>,
 104                                                          <em class="parameter"><code><span class="type">gfloat</span> radius</code></em>);</pre>
 105 <p>
 106 Creates a new <a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> instance with the given parameters
 107 </p>
 108 <div class="variablelist"><table border="0">
 109 <col align="left" valign="top">
 110 <tbody>
 111 <tr>
 112 <td><p><span class="term"><em class="parameter"><code>period</code></em> :</span></p></td>
 113 <td>the period of the page curl, between 0.0 and 1.0</td>
 114 </tr>
 115 <tr>
 116 <td><p><span class="term"><em class="parameter"><code>angle</code></em> :</span></p></td>
 117 <td>the angle of the page curl, between 0.0 and 360.0</td>
 118 </tr>
 119 <tr>
 120 <td><p><span class="term"><em class="parameter"><code>radius</code></em> :</span></p></td>
 121 <td>the radius of the page curl, in pixels</td>
 122 </tr>
 123 <tr>
 124 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 125 <td>the newly created <a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a>
 126 </td>
 127 </tr>
 128 </tbody>
 129 </table></div>
 130 <p class="since">Since 1.4</p>
 131 </div>
 132 <hr>
 133 <div class="refsect2">
 134 <a name="clutter-page-turn-effect-set-period"></a><h3>clutter_page_turn_effect_set_period ()</h3>
 135 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_page_turn_effect_set_period (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>,
 136                                                          <em class="parameter"><code><span class="type">gdouble</span> period</code></em>);</pre>
 137 <p>
 138 Sets the period of the page curling, between 0.0 (no curling)
 139 and 1.0 (fully curled)
 140 </p>
 141 <div class="variablelist"><table border="0">
 142 <col align="left" valign="top">
 143 <tbody>
 144 <tr>
 145 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
 146 <td>a <a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a>
 147 </td>
 148 </tr>
 149 <tr>
 150 <td><p><span class="term"><em class="parameter"><code>period</code></em> :</span></p></td>
 151 <td>the period of the page curl, between 0.0 and 1.0</td>
 152 </tr>
 153 </tbody>
 154 </table></div>
 155 <p class="since">Since 1.4</p>
 156 </div>
 157 <hr>
 158 <div class="refsect2">
 159 <a name="clutter-page-turn-effect-get-period"></a><h3>clutter_page_turn_effect_get_period ()</h3>
 160 <pre class="programlisting"><span class="returnvalue">gdouble</span>             clutter_page_turn_effect_get_period (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>);</pre>
 161 <p>
 162 Retrieves the value set using <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-get-period" title="clutter_page_turn_effect_get_period ()"><code class="function">clutter_page_turn_effect_get_period()</code></a>
 163 </p>
 164 <div class="variablelist"><table border="0">
 165 <col align="left" valign="top">
 166 <tbody>
 167 <tr>
 168 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
 169 <td>a <a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a>
 170 </td>
 171 </tr>
 172 <tr>
 173 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 174 <td>the period of the page curling</td>
 175 </tr>
 176 </tbody>
 177 </table></div>
 178 <p class="since">Since 1.4</p>
 179 </div>
 180 <hr>
 181 <div class="refsect2">
 182 <a name="clutter-page-turn-effect-set-angle"></a><h3>clutter_page_turn_effect_set_angle ()</h3>
 183 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_page_turn_effect_set_angle  (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>,
 184                                                          <em class="parameter"><code><span class="type">gdouble</span> angle</code></em>);</pre>
 185 <p>
 186 Sets the angle of the page curling, in degrees
 187 </p>
 188 <div class="variablelist"><table border="0">
 189 <col align="left" valign="top">
 190 <tbody>
 191 <tr>
 192 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
 193 <td><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a></td>
 194 </tr>
 195 <tr>
 196 <td><p><span class="term"><em class="parameter"><code>angle</code></em> :</span></p></td>
 197 <td>the angle of the page curl, in degrees</td>
 198 </tr>
 199 </tbody>
 200 </table></div>
 201 <p class="since">Since 1.4</p>
 202 </div>
 203 <hr>
 204 <div class="refsect2">
 205 <a name="clutter-page-turn-effect-get-angle"></a><h3>clutter_page_turn_effect_get_angle ()</h3>
 206 <pre class="programlisting"><span class="returnvalue">gdouble</span>             clutter_page_turn_effect_get_angle  (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>);</pre>
 207 <p>
 208 Retrieves the value set using <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-get-angle" title="clutter_page_turn_effect_get_angle ()"><code class="function">clutter_page_turn_effect_get_angle()</code></a>
 209 </p>
 210 <div class="variablelist"><table border="0">
 211 <col align="left" valign="top">
 212 <tbody>
 213 <tr>
 214 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
 215 <td>a <a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a>:</td>
 216 </tr>
 217 <tr>
 218 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 219 <td>the angle of the page curling</td>
 220 </tr>
 221 </tbody>
 222 </table></div>
 223 <p class="since">Since 1.4</p>
 224 </div>
 225 <hr>
 226 <div class="refsect2">
 227 <a name="clutter-page-turn-effect-set-radius"></a><h3>clutter_page_turn_effect_set_radius ()</h3>
 228 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_page_turn_effect_set_radius (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>,
 229                                                          <em class="parameter"><code><span class="type">gfloat</span> radius</code></em>);</pre>
 230 <p>
 231 Sets the radius of the page curling
 232 </p>
 233 <div class="variablelist"><table border="0">
 234 <col align="left" valign="top">
 235 <tbody>
 236 <tr>
 237 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
 238 <td>a <a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a>:</td>
 239 </tr>
 240 <tr>
 241 <td><p><span class="term"><em class="parameter"><code>radius</code></em> :</span></p></td>
 242 <td>the radius of the page curling, in pixels</td>
 243 </tr>
 244 </tbody>
 245 </table></div>
 246 <p class="since">Since 1.4</p>
 247 </div>
 248 <hr>
 249 <div class="refsect2">
 250 <a name="clutter-page-turn-effect-get-radius"></a><h3>clutter_page_turn_effect_get_radius ()</h3>
 251 <pre class="programlisting"><span class="returnvalue">gfloat</span>              clutter_page_turn_effect_get_radius (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>);</pre>
 252 <p>
 253 Retrieves the value set using <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-set-radius" title="clutter_page_turn_effect_set_radius ()"><code class="function">clutter_page_turn_effect_set_radius()</code></a>
 254 </p>
 255 <div class="variablelist"><table border="0">
 256 <col align="left" valign="top">
 257 <tbody>
 258 <tr>
 259 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
 260 <td>a <a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a>
 261 </td>
 262 </tr>
 263 <tr>
 264 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 265 <td>the radius of the page curling</td>
 266 </tr>
 267 </tbody>
 268 </table></div>
 269 <p class="since">Since 1.4</p>
 270 </div>
 271 </div>
 272 <div class="refsect1">
 273 <a name="ClutterPageTurnEffect.property-details"></a><h2>Property Details</h2>
 274 <div class="refsect2">
 275 <a name="ClutterPageTurnEffect--angle"></a><h3>The <code class="literal">"angle"</code> property</h3>
 276 <pre class="programlisting">  "angle"                    <span class="type">gdouble</span>               : Read / Write</pre>
 277 <p>
 278 The angle of the page rotation, in degrees, between 0.0 and 360.0
 279 </p>
 280 <p>Allowed values: [0,360]</p>
 281 <p>Default value: 0</p>
 282 <p class="since">Since 1.4</p>
 283 </div>
 284 <hr>
 285 <div class="refsect2">
 286 <a name="ClutterPageTurnEffect--period"></a><h3>The <code class="literal">"period"</code> property</h3>
 287 <pre class="programlisting">  "period"                   <span class="type">gdouble</span>               : Read / Write</pre>
 288 <p>
 289 The period of the page turn, between 0.0 (no curling) and
 290 1.0 (fully curled)
 291 </p>
 292 <p>Allowed values: [0,1]</p>
 293 <p>Default value: 0</p>
 294 <p class="since">Since 1.4</p>
 295 </div>
 296 <hr>
 297 <div class="refsect2">
 298 <a name="ClutterPageTurnEffect--radius"></a><h3>The <code class="literal">"radius"</code> property</h3>
 299 <pre class="programlisting">  "radius"                   <span class="type">gfloat</span>                : Read / Write</pre>
 300 <p>
 301 The radius of the page curl, in pixels
 302 </p>
 303 <p>Default value: 24</p>
 304 <p class="since">Since 1.4</p>
 305 </div>
 306 </div>
 307 </div>
 308 <div class="footer">
 309 <hr>
 310           Generated by GTK-Doc V1.18.1</div>
 311 </body>
 312 </html>