doc/reference/clutter/html/ClutterAnimatable.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>ClutterAnimatable</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="ch09.html" title="Base classes">
   9 <link rel="prev" href="ClutterTransition.html" title="ClutterTransition">
  10 <link rel="next" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition">
  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="ClutterTransition.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch09.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="ClutterPropertyTransition.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="#ClutterAnimatable.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterAnimatable.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterAnimatable.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterAnimatable.prerequisites" class="shortcut">Prerequisites</a>
  31                    |
  32                   <a href="#ClutterAnimatable.implementations" class="shortcut">Known Implementations</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="ClutterAnimatable"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="ClutterAnimatable.top_of_page"></a>ClutterAnimatable</span></h2>
  40 <p>ClutterAnimatable — Interface for animatable classes</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="ClutterAnimatable.synopsis"></a><h2>Synopsis</h2>
  46 <pre class="synopsis">                    <a class="link" href="ClutterAnimatable.html#ClutterAnimatable-struct" title="ClutterAnimatable">ClutterAnimatable</a>;
  47 struct              <a class="link" href="ClutterAnimatable.html#ClutterAnimatableIface" title="struct ClutterAnimatableIface">ClutterAnimatableIface</a>;
  48 <span class="returnvalue">gboolean</span>            <a class="link" href="ClutterAnimatable.html#clutter-animatable-animate-property" title="clutter_animatable_animate_property ()">clutter_animatable_animate_property</a> (<em class="parameter"><code><a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> *animatable</code></em>,
  49                                                          <em class="parameter"><code><a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a> *animation</code></em>,
  50                                                          <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>,
  51                                                          <em class="parameter"><code>const <span class="type">GValue</span> *initial_value</code></em>,
  52                                                          <em class="parameter"><code>const <span class="type">GValue</span> *final_value</code></em>,
  53                                                          <em class="parameter"><code><span class="type">gdouble</span> progress</code></em>,
  54                                                          <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);
  55 <span class="returnvalue">GParamSpec</span> *        <a class="link" href="ClutterAnimatable.html#clutter-animatable-find-property" title="clutter_animatable_find_property ()">clutter_animatable_find_property</a>    (<em class="parameter"><code><a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> *animatable</code></em>,
  56                                                          <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);
  57 <span class="returnvalue">void</span>                <a class="link" href="ClutterAnimatable.html#clutter-animatable-get-initial-state" title="clutter_animatable_get_initial_state ()">clutter_animatable_get_initial_state</a>
  58                                                         (<em class="parameter"><code><a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> *animatable</code></em>,
  59                                                          <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>,
  60                                                          <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);
  61 <span class="returnvalue">void</span>                <a class="link" href="ClutterAnimatable.html#clutter-animatable-set-final-state" title="clutter_animatable_set_final_state ()">clutter_animatable_set_final_state</a>  (<em class="parameter"><code><a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> *animatable</code></em>,
  62                                                          <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>,
  63                                                          <em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);
  64 <span class="returnvalue">gboolean</span>            <a class="link" href="ClutterAnimatable.html#clutter-animatable-interpolate-value" title="clutter_animatable_interpolate_value ()">clutter_animatable_interpolate_value</a>
  65                                                         (<em class="parameter"><code><a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> *animatable</code></em>,
  66                                                          <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>,
  67                                                          <em class="parameter"><code><a class="link" href="clutter-Value-intervals.html#ClutterInterval"><span class="type">ClutterInterval</span></a> *interval</code></em>,
  68                                                          <em class="parameter"><code><span class="type">gdouble</span> progress</code></em>,
  69                                                          <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);
  70 </pre>
  71 </div>
  72 <div class="refsect1">
  73 <a name="ClutterAnimatable.object-hierarchy"></a><h2>Object Hierarchy</h2>
  74 <pre class="synopsis">
  75   GInterface
  76    +----ClutterAnimatable
  77 </pre>
  78 </div>
  79 <div class="refsect1">
  80 <a name="ClutterAnimatable.prerequisites"></a><h2>Prerequisites</h2>
  81 <p>
  82 ClutterAnimatable requires
  83  GObject.</p>
  84 </div>
  85 <div class="refsect1">
  86 <a name="ClutterAnimatable.implementations"></a><h2>Known Implementations</h2>
  87 <p>
  88 ClutterAnimatable is implemented by
  89  <a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>,  <a class="link" href="ClutterBox.html" title="ClutterBox">ClutterBox</a>,  <a class="link" href="ClutterCairoTexture.html" title="ClutterCairoTexture">ClutterCairoTexture</a>,  <a class="link" href="ClutterClone.html" title="ClutterClone">ClutterClone</a>,  <a class="link" href="ClutterGroup.html" title="ClutterGroup">ClutterGroup</a>,  <a class="link" href="ClutterRectangle.html" title="ClutterRectangle">ClutterRectangle</a>,  <a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a>,  <a class="link" href="ClutterText.html" title="ClutterText">ClutterText</a> and  <a class="link" href="ClutterTexture.html" title="ClutterTexture">ClutterTexture</a>.</p>
  90 </div>
  91 <div class="refsect1">
  92 <a name="ClutterAnimatable.description"></a><h2>Description</h2>
  93 <p>
  94 <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> is an interface that allows a <span class="type">GObject</span> class
  95 to control how a <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a> will animate a property.
  96 </p>
  97 <p>
  98 Each <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> should implement the
  99 <code class="function">animate_property</code> virtual function of the interface
 100 to compute the animation state between two values of an interval depending
 101 on a progress factor, expressed as a floating point value.
 102 </p>
 103 <p>
 104 If a <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> is animated by a <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a>
 105 instance, the <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a> will call
 106 <a class="link" href="ClutterAnimatable.html#clutter-animatable-animate-property" title="clutter_animatable_animate_property ()"><code class="function">clutter_animatable_animate_property()</code></a> passing the name of the
 107 currently animated property; the initial and final values of
 108 the animation interval; the progress factor. The <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a>
 109 implementation should return the computed value for the animated
 110 property.
 111 </p>
 112 <p>
 113 <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> is available since Clutter 1.0
 114 </p>
 115 </div>
 116 <div class="refsect1">
 117 <a name="ClutterAnimatable.details"></a><h2>Details</h2>
 118 <div class="refsect2">
 119 <a name="ClutterAnimatable-struct"></a><h3>ClutterAnimatable</h3>
 120 <pre class="programlisting">typedef struct _ClutterAnimatable ClutterAnimatable;</pre>
 121 <p>
 122 <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> is an opaque structure whose members cannot be directly
 123 accessed
 124 </p>
 125 <p class="since">Since 1.0</p>
 126 </div>
 127 <hr>
 128 <div class="refsect2">
 129 <a name="ClutterAnimatableIface"></a><h3>struct ClutterAnimatableIface</h3>
 130 <pre class="programlisting">struct ClutterAnimatableIface {
 131   gboolean    (* animate_property)  (ClutterAnimatable *animatable,
 132                                      ClutterAnimation  *animation,
 133                                      const gchar       *property_name,
 134                                      const GValue      *initial_value,
 135                                      const GValue      *final_value,
 136                                      gdouble            progress,
 137                                      GValue            *value);
 138   GParamSpec *(* find_property)     (ClutterAnimatable *animatable,
 139                                      const gchar       *property_name);
 140   void        (* get_initial_state) (ClutterAnimatable *animatable,
 141                                      const gchar       *property_name,
 142                                      GValue            *value);
 143   void        (* set_final_state)   (ClutterAnimatable *animatable,
 144                                      const gchar       *property_name,
 145                                      const GValue      *value);
 146   gboolean    (* interpolate_value) (ClutterAnimatable *animatable,
 147                                      const gchar       *property_name,
 148                                      ClutterInterval   *interval,
 149                                      gdouble            progress,
 150                                      GValue            *value);
 151 };
 152 </pre>
 153 <p>
 154 Base interface for <span class="type">GObject</span>s that can be animated by a
 155 a <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a>.
 156 </p>
 157 <div class="variablelist"><table border="0">
 158 <col align="left" valign="top">
 159 <tbody>
 160 <tr>
 161 <td><p><span class="term"><em class="structfield"><code><a name="ClutterAnimatableIface.animate-property"></a>animate_property</code></em> ()</span></p></td>
 162 <td>virtual function for custom interpolation of a
 163 property. This virtual function is deprecated</td>
 164 </tr>
 165 <tr>
 166 <td><p><span class="term"><em class="structfield"><code><a name="ClutterAnimatableIface.find-property"></a>find_property</code></em> ()</span></p></td>
 167 <td>virtual function for retrieving the <span class="type">GParamSpec</span> of
 168 an animatable property</td>
 169 </tr>
 170 <tr>
 171 <td><p><span class="term"><em class="structfield"><code><a name="ClutterAnimatableIface.get-initial-state"></a>get_initial_state</code></em> ()</span></p></td>
 172 <td>virtual function for retrieving the initial
 173 state of an animatable property</td>
 174 </tr>
 175 <tr>
 176 <td><p><span class="term"><em class="structfield"><code><a name="ClutterAnimatableIface.set-final-state"></a>set_final_state</code></em> ()</span></p></td>
 177 <td>virtual function for setting the state of an
 178 animatable property</td>
 179 </tr>
 180 <tr>
 181 <td><p><span class="term"><em class="structfield"><code><a name="ClutterAnimatableIface.interpolate-value"></a>interpolate_value</code></em> ()</span></p></td>
 182 <td>virtual function for interpolating the progress
 183 of a property</td>
 184 </tr>
 185 </tbody>
 186 </table></div>
 187 <p class="since">Since 1.0</p>
 188 </div>
 189 <hr>
 190 <div class="refsect2">
 191 <a name="clutter-animatable-animate-property"></a><h3>clutter_animatable_animate_property ()</h3>
 192 <pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_animatable_animate_property (<em class="parameter"><code><a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> *animatable</code></em>,
 193                                                          <em class="parameter"><code><a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a> *animation</code></em>,
 194                                                          <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>,
 195                                                          <em class="parameter"><code>const <span class="type">GValue</span> *initial_value</code></em>,
 196                                                          <em class="parameter"><code>const <span class="type">GValue</span> *final_value</code></em>,
 197                                                          <em class="parameter"><code><span class="type">gdouble</span> progress</code></em>,
 198                                                          <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
 199 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 200 <h3 class="title">Warning</h3>
 201 <p><code class="literal">clutter_animatable_animate_property</code> has been deprecated since version 1.8 and should not be used in newly-written code. Use <a class="link" href="ClutterAnimatable.html#clutter-animatable-interpolate-value" title="clutter_animatable_interpolate_value ()"><code class="function">clutter_animatable_interpolate_value()</code></a>
 202   instead</p>
 203 </div>
 204 <p>
 205 Calls the <code class="function">animate_property()</code> virtual function for <em class="parameter"><code>animatable</code></em>.
 206 </p>
 207 <p>
 208 The <em class="parameter"><code>initial_value</code></em> and <em class="parameter"><code>final_value</code></em> <span class="type">GValue</span>s must contain
 209 the same type; <em class="parameter"><code>value</code></em> must have been initialized to the same
 210 type of <em class="parameter"><code>initial_value</code></em> and <em class="parameter"><code>final_value</code></em>.
 211 </p>
 212 <p>
 213 All implementation of the <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> interface must
 214 implement this function.
 215 </p>
 216 <div class="variablelist"><table border="0">
 217 <col align="left" valign="top">
 218 <tbody>
 219 <tr>
 220 <td><p><span class="term"><em class="parameter"><code>animatable</code></em> :</span></p></td>
 221 <td>a <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a>
 222 </td>
 223 </tr>
 224 <tr>
 225 <td><p><span class="term"><em class="parameter"><code>animation</code></em> :</span></p></td>
 226 <td>a <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a>
 227 </td>
 228 </tr>
 229 <tr>
 230 <td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
 231 <td>the name of the animated property</td>
 232 </tr>
 233 <tr>
 234 <td><p><span class="term"><em class="parameter"><code>initial_value</code></em> :</span></p></td>
 235 <td>the initial value of the animation interval</td>
 236 </tr>
 237 <tr>
 238 <td><p><span class="term"><em class="parameter"><code>final_value</code></em> :</span></p></td>
 239 <td>the final value of the animation interval</td>
 240 </tr>
 241 <tr>
 242 <td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
 243 <td>the progress factor</td>
 244 </tr>
 245 <tr>
 246 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 247 <td>return location for the animation value</td>
 248 </tr>
 249 <tr>
 250 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 251 <td>
 252 <code class="literal">TRUE</code> if the value has been validated and can
 253 be applied to the <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a>, and <code class="literal">FALSE</code> otherwise</td>
 254 </tr>
 255 </tbody>
 256 </table></div>
 257 <p class="since">Since 1.0</p>
 258 </div>
 259 <hr>
 260 <div class="refsect2">
 261 <a name="clutter-animatable-find-property"></a><h3>clutter_animatable_find_property ()</h3>
 262 <pre class="programlisting"><span class="returnvalue">GParamSpec</span> *        clutter_animatable_find_property    (<em class="parameter"><code><a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> *animatable</code></em>,
 263                                                          <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);</pre>
 264 <p>
 265 Finds the <span class="type">GParamSpec</span> for <em class="parameter"><code>property_name</code></em>
 266 </p>
 267 <div class="variablelist"><table border="0">
 268 <col align="left" valign="top">
 269 <tbody>
 270 <tr>
 271 <td><p><span class="term"><em class="parameter"><code>animatable</code></em> :</span></p></td>
 272 <td>a <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a>
 273 </td>
 274 </tr>
 275 <tr>
 276 <td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
 277 <td>the name of the animatable property to find</td>
 278 </tr>
 279 <tr>
 280 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 281 <td>The <span class="type">GParamSpec</span> for the given property
 282 or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 283 </td>
 284 </tr>
 285 </tbody>
 286 </table></div>
 287 <p class="since">Since 1.4</p>
 288 </div>
 289 <hr>
 290 <div class="refsect2">
 291 <a name="clutter-animatable-get-initial-state"></a><h3>clutter_animatable_get_initial_state ()</h3>
 292 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_animatable_get_initial_state
 293                                                         (<em class="parameter"><code><a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> *animatable</code></em>,
 294                                                          <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>,
 295                                                          <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
 296 <p>
 297 Retrieves the current state of <em class="parameter"><code>property_name</code></em> and sets <em class="parameter"><code>value</code></em> with it
 298 </p>
 299 <div class="variablelist"><table border="0">
 300 <col align="left" valign="top">
 301 <tbody>
 302 <tr>
 303 <td><p><span class="term"><em class="parameter"><code>animatable</code></em> :</span></p></td>
 304 <td>a <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a>
 305 </td>
 306 </tr>
 307 <tr>
 308 <td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
 309 <td>the name of the animatable property to retrieve</td>
 310 </tr>
 311 <tr>
 312 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 313 <td>a <span class="type">GValue</span> initialized to the type of the property to retrieve</td>
 314 </tr>
 315 </tbody>
 316 </table></div>
 317 <p class="since">Since 1.4</p>
 318 </div>
 319 <hr>
 320 <div class="refsect2">
 321 <a name="clutter-animatable-set-final-state"></a><h3>clutter_animatable_set_final_state ()</h3>
 322 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_animatable_set_final_state  (<em class="parameter"><code><a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> *animatable</code></em>,
 323                                                          <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>,
 324                                                          <em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);</pre>
 325 <p>
 326 Sets the current state of <em class="parameter"><code>property_name</code></em> to <em class="parameter"><code>value</code></em>
 327 </p>
 328 <div class="variablelist"><table border="0">
 329 <col align="left" valign="top">
 330 <tbody>
 331 <tr>
 332 <td><p><span class="term"><em class="parameter"><code>animatable</code></em> :</span></p></td>
 333 <td>a <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a>
 334 </td>
 335 </tr>
 336 <tr>
 337 <td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
 338 <td>the name of the animatable property to set</td>
 339 </tr>
 340 <tr>
 341 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 342 <td>the value of the animatable property to set</td>
 343 </tr>
 344 </tbody>
 345 </table></div>
 346 <p class="since">Since 1.4</p>
 347 </div>
 348 <hr>
 349 <div class="refsect2">
 350 <a name="clutter-animatable-interpolate-value"></a><h3>clutter_animatable_interpolate_value ()</h3>
 351 <pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_animatable_interpolate_value
 352                                                         (<em class="parameter"><code><a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> *animatable</code></em>,
 353                                                          <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>,
 354                                                          <em class="parameter"><code><a class="link" href="clutter-Value-intervals.html#ClutterInterval"><span class="type">ClutterInterval</span></a> *interval</code></em>,
 355                                                          <em class="parameter"><code><span class="type">gdouble</span> progress</code></em>,
 356                                                          <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
 357 <p>
 358 Asks a <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> implementation to interpolate a
 359 a named property between the initial and final values of
 360 a <a class="link" href="clutter-Value-intervals.html#ClutterInterval"><span class="type">ClutterInterval</span></a>, using <em class="parameter"><code>progress</code></em> as the interpolation
 361 value, and store the result inside <em class="parameter"><code>value</code></em>.
 362 </p>
 363 <p>
 364 This function should be used for every property animation
 365 involving <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a>s.
 366 </p>
 367 <p>
 368 This function replaces <a class="link" href="ClutterAnimatable.html#clutter-animatable-animate-property" title="clutter_animatable_animate_property ()"><code class="function">clutter_animatable_animate_property()</code></a>.
 369 </p>
 370 <div class="variablelist"><table border="0">
 371 <col align="left" valign="top">
 372 <tbody>
 373 <tr>
 374 <td><p><span class="term"><em class="parameter"><code>animatable</code></em> :</span></p></td>
 375 <td>a <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a>
 376 </td>
 377 </tr>
 378 <tr>
 379 <td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
 380 <td>the name of the property to interpolate</td>
 381 </tr>
 382 <tr>
 383 <td><p><span class="term"><em class="parameter"><code>interval</code></em> :</span></p></td>
 384 <td>a <a class="link" href="clutter-Value-intervals.html#ClutterInterval"><span class="type">ClutterInterval</span></a> with the animation range</td>
 385 </tr>
 386 <tr>
 387 <td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
 388 <td>the progress to use to interpolate between the
 389 initial and final values of the <em class="parameter"><code>interval</code></em>
 390 </td>
 391 </tr>
 392 <tr>
 393 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 394 <td>return location for an initialized <span class="type">GValue</span>
 395 using the same type of the <em class="parameter"><code>interval</code></em>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 396 </td>
 397 </tr>
 398 <tr>
 399 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 400 <td>
 401 <code class="literal">TRUE</code> if the interpolation was successful,
 402 and <code class="literal">FALSE</code> otherwise</td>
 403 </tr>
 404 </tbody>
 405 </table></div>
 406 <p class="since">Since 1.8</p>
 407 </div>
 408 </div>
 409 </div>
 410 <div class="footer">
 411 <hr>
 412           Generated by GTK-Doc V1.18.1</div>
 413 </body>
 414 </html>