doc/reference/clutter/html/ClutterAnimator.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>ClutterAnimator</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="ch10.html" title="High Level API">
   9 <link rel="prev" href="clutter-Implicit-Animations.html" title="Implicit Animations">
  10 <link rel="next" href="ClutterState.html" title="ClutterState">
  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="clutter-Implicit-Animations.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch10.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="ClutterState.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="#ClutterAnimator.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterAnimator.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterAnimator.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterAnimator.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#ClutterAnimator.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="ClutterAnimator"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="ClutterAnimator.top_of_page"></a>ClutterAnimator</span></h2>
  40 <p>ClutterAnimator — Multi-actor tweener</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="ClutterAnimator.synopsis"></a><h2>Synopsis</h2>
  46 <pre class="synopsis">                    <a class="link" href="ClutterAnimator.html#ClutterAnimator-struct" title="ClutterAnimator">ClutterAnimator</a>;
  47 struct              <a class="link" href="ClutterAnimator.html#ClutterAnimatorClass" title="struct ClutterAnimatorClass">ClutterAnimatorClass</a>;
  48 <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="returnvalue">ClutterAnimator</span></a> *   <a class="link" href="ClutterAnimator.html#clutter-animator-new" title="clutter_animator_new ()">clutter_animator_new</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
  49 <span class="returnvalue">void</span>                <a class="link" href="ClutterAnimator.html#clutter-animator-set" title="clutter_animator_set ()">clutter_animator_set</a>                (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
  50                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> first_object</code></em>,
  51                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *first_property_name</code></em>,
  52                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> first_mode</code></em>,
  53                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> first_progress</code></em>,
  54                                                          <em class="parameter"><code>...</code></em>);
  55 <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="returnvalue">ClutterAnimator</span></a> *   <a class="link" href="ClutterAnimator.html#clutter-animator-set-key" title="clutter_animator_set_key ()">clutter_animator_set_key</a>            (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
  56                                                          <em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
  57                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>,
  58                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> mode</code></em>,
  59                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> progress</code></em>,
  60                                                          <em class="parameter"><code>const <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
  61 <span class="returnvalue">void</span>                <a class="link" href="ClutterAnimator.html#clutter-animator-remove-key" title="clutter_animator_remove_key ()">clutter_animator_remove_key</a>         (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
  62                                                          <em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
  63                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>,
  64                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> progress</code></em>);
  65 <a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="ClutterAnimator.html#clutter-animator-get-keys" title="clutter_animator_get_keys ()">clutter_animator_get_keys</a>           (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
  66                                                          <em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
  67                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>,
  68                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> progress</code></em>);
  69 <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *   <a class="link" href="ClutterAnimator.html#clutter-animator-start" title="clutter_animator_start ()">clutter_animator_start</a>              (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>);
  70 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterAnimator.html#clutter-animator-compute-value" title="clutter_animator_compute_value ()">clutter_animator_compute_value</a>      (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
  71                                                          <em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
  72                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>,
  73                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> progress</code></em>,
  74                                                          <em class="parameter"><code><a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
  75
  76 <span class="returnvalue">void</span>                <a class="link" href="ClutterAnimator.html#clutter-animator-set-timeline" title="clutter_animator_set_timeline ()">clutter_animator_set_timeline</a>       (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
  77                                                          <em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);
  78 <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *   <a class="link" href="ClutterAnimator.html#clutter-animator-get-timeline" title="clutter_animator_get_timeline ()">clutter_animator_get_timeline</a>       (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>);
  79 <span class="returnvalue">void</span>                <a class="link" href="ClutterAnimator.html#clutter-animator-set-duration" title="clutter_animator_set_duration ()">clutter_animator_set_duration</a>       (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
  80                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> duration</code></em>);
  81 <a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="ClutterAnimator.html#clutter-animator-get-duration" title="clutter_animator_get_duration ()">clutter_animator_get_duration</a>       (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>);
  82
  83 <span class="returnvalue">void</span>                <a class="link" href="ClutterAnimator.html#clutter-animator-property-set-ease-in" title="clutter_animator_property_set_ease_in ()">clutter_animator_property_set_ease_in</a>
  84                                                         (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
  85                                                          <em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
  86                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>,
  87                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> ease_in</code></em>);
  88 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterAnimator.html#clutter-animator-property-get-ease-in" title="clutter_animator_property_get_ease_in ()">clutter_animator_property_get_ease_in</a>
  89                                                         (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
  90                                                          <em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
  91                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>);
  92 enum                <a class="link" href="ClutterAnimator.html#ClutterInterpolation" title="enum ClutterInterpolation">ClutterInterpolation</a>;
  93 <span class="returnvalue">void</span>                <a class="link" href="ClutterAnimator.html#clutter-animator-property-set-interpolation" title="clutter_animator_property_set_interpolation ()">clutter_animator_property_set_interpolation</a>
  94                                                         (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
  95                                                          <em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
  96                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>,
  97                                                          <em class="parameter"><code><a class="link" href="ClutterAnimator.html#ClutterInterpolation" title="enum ClutterInterpolation"><span class="type">ClutterInterpolation</span></a> interpolation</code></em>);
  98 <a class="link" href="ClutterAnimator.html#ClutterInterpolation" title="enum ClutterInterpolation"><span class="returnvalue">ClutterInterpolation</span></a> <a class="link" href="ClutterAnimator.html#clutter-animator-property-get-interpolation" title="clutter_animator_property_get_interpolation ()">clutter_animator_property_get_interpolation</a>
  99                                                         (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
 100                                                          <em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
 101                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>);
 102
 103                     <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey">ClutterAnimatorKey</a>;
 104 <a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> *           <a class="link" href="ClutterAnimator.html#clutter-animator-key-get-object" title="clutter_animator_key_get_object ()">clutter_animator_key_get_object</a>     (<em class="parameter"><code>const <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a> *key</code></em>);
 105 const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="ClutterAnimator.html#clutter-animator-key-get-property-name" title="clutter_animator_key_get_property_name ()">clutter_animator_key_get_property_name</a>
 106                                                         (<em class="parameter"><code>const <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a> *key</code></em>);
 107 <a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               <a class="link" href="ClutterAnimator.html#clutter-animator-key-get-property-type" title="clutter_animator_key_get_property_type ()">clutter_animator_key_get_property_type</a>
 108                                                         (<em class="parameter"><code>const <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a> *key</code></em>);
 109 <a href="../glib/glib-Basic-Types.html#gulong"><span class="returnvalue">gulong</span></a>              <a class="link" href="ClutterAnimator.html#clutter-animator-key-get-mode" title="clutter_animator_key_get_mode ()">clutter_animator_key_get_mode</a>       (<em class="parameter"><code>const <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a> *key</code></em>);
 110 <a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <a class="link" href="ClutterAnimator.html#clutter-animator-key-get-progress" title="clutter_animator_key_get_progress ()">clutter_animator_key_get_progress</a>   (<em class="parameter"><code>const <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a> *key</code></em>);
 111 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterAnimator.html#clutter-animator-key-get-value" title="clutter_animator_key_get_value ()">clutter_animator_key_get_value</a>      (<em class="parameter"><code>const <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a> *key</code></em>,
 112                                                          <em class="parameter"><code><a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
 113 </pre>
 114 </div>
 115 <div class="refsect1">
 116 <a name="ClutterAnimator.object-hierarchy"></a><h2>Object Hierarchy</h2>
 117 <pre class="synopsis">
 118   <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 119    +----ClutterAnimator
 120 </pre>
 121 </div>
 122 <div class="refsect1">
 123 <a name="ClutterAnimator.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 124 <p>
 125 ClutterAnimator implements
 126  <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>.</p>
 127 </div>
 128 <div class="refsect1">
 129 <a name="ClutterAnimator.properties"></a><h2>Properties</h2>
 130 <pre class="synopsis">
 131   "<a class="link" href="ClutterAnimator.html#ClutterAnimator--duration" title='The "duration" property'>duration</a>"                 <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
 132   "<a class="link" href="ClutterAnimator.html#ClutterAnimator--timeline" title='The "timeline" property'>timeline</a>"                 <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>*      : Read / Write
 133 </pre>
 134 </div>
 135 <div class="refsect1">
 136 <a name="ClutterAnimator.description"></a><h2>Description</h2>
 137 <p>
 138 <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> is an object providing declarative animations for
 139 <a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> properties belonging to one or more <a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>s to
 140 <a href="clutter-Value-intervals.html#ClutterInterval"><span class="type">ClutterIntervals</span></a>.
 141 </p>
 142 <p>
 143 <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> is used to build and describe complex animations
 144 in terms of "key frames". <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> is meant to be used
 145 through the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> definition format, but it comes with a
 146 convenience C API.
 147 </p>
 148 <p>
 149 </p>
 150 <div class="refsect2">
 151 <a name="ClutterAnimator-key-frames"></a><h3>Key Frames</h3>
 152 <p>Every animation handled by a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> can be
 153   described in terms of "key frames". For each <a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> property
 154   there can be multiple key frames, each one defined by the end
 155   value for the property to be computed starting from the current
 156   value to a specific point in time, using a given easing
 157   mode.</p>
 158 <p>The point in time is defined using a value representing
 159   the progress in the normalized interval of [ 0, 1 ]. This maps
 160   the value returned by <a class="link" href="ClutterTimeline.html#clutter-timeline-get-duration" title="clutter_timeline_get_duration ()"><code class="function">clutter_timeline_get_duration()</code></a>.</p>
 161 <div class="figure">
 162 <a name="easing-modes"></a><p class="title"><b>Figure 9. Key Frames</b></p>
 163 <div class="figure-contents"><div><img src="animator-key-frames.png" alt="Key Frames"></div></div>
 164 </div>
 165 <br class="figure-break"><p>In the image above the duration of the animation is
 166   represented by the blue line. Each key frame is the white dot,
 167   along with its progress. The red line represents the computed
 168   function of time given the easing mode.</p>
 169 </div>
 170 <p>
 171 </p>
 172 <p>
 173 </p>
 174 <div class="refsect2">
 175 <a name="ClutterAnimator-script"></a><h3>ClutterAnimator description for <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
 176 </h3>
 177 <p><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> defines a custom "properties" property
 178   which allows describing the key frames for objects.</p>
 179 <p>The "properties" property has the following syntax:</p>
 180 <div class="informalexample">
 181   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 182     <tbody>
 183       <tr>
 184         <td class="listing_lines" align="right"><pre>1
 185 2
 186 3
 187 4
 188 5
 189 6
 190 7
 191 8
 192 9
 193 10
 194 11
 195 12</pre></td>
 196         <td class="listing_code"><pre class="programlisting"><span class="cbracket">{</span>
 197 <span class="normal">  </span><span class="string">"properties"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="symbol">[</span>
 198 <span class="normal">    </span><span class="cbracket">{</span>
 199 <span class="normal">      </span><span class="string">"object"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">lt</span><span class="symbol">;</span><span class="normal">id of </span><span class="usertype">an</span><span class="normal"> object</span><span class="symbol">&amp;</span><span class="normal">gt</span><span class="symbol">;,</span>
 200 <span class="normal">      </span><span class="string">"name"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">lt</span><span class="symbol">;</span><span class="normal">name of </span><span class="usertype">the</span><span class="normal"> property</span><span class="symbol">&amp;</span><span class="normal">gt</span><span class="symbol">;,</span>
 201 <span class="normal">      </span><span class="string">"ease-in"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">lt</span><span class="symbol">;</span><span class="normal">boolean</span><span class="symbol">&amp;</span><span class="normal">gt</span><span class="symbol">;,</span>
 202 <span class="normal">      </span><span class="string">"interpolation"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">lt</span><span class="symbol">;</span><span class="normal">#</span><span class="usertype">ClutterInterpolation</span><span class="normal"> value</span><span class="symbol">&amp;</span><span class="normal">gt</span><span class="symbol">;,</span>
 203 <span class="normal">      </span><span class="string">"keys"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="symbol">[</span>
 204 <span class="normal">        </span><span class="symbol">[</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">lt</span><span class="symbol">;</span><span class="normal">progress</span><span class="symbol">&amp;</span><span class="normal">gt</span><span class="symbol">;,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">lt</span><span class="symbol">;</span><span class="usertype">easing</span><span class="normal"> mode</span><span class="symbol">&amp;</span><span class="normal">gt</span><span class="symbol">;,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">lt</span><span class="symbol">;</span><span class="usertype">final</span><span class="normal"> value</span><span class="symbol">&amp;</span><span class="normal">gt</span><span class="symbol">;</span><span class="normal"> </span><span class="symbol">]</span>
 205 <span class="normal">      </span><span class="symbol">]</span>
 206 <span class="normal">  </span><span class="symbol">]</span>
 207 <span class="cbracket">}</span></pre></td>
 208       </tr>
 209     </tbody>
 210   </table>
 211 </div>
 212
 213 <div class="example">
 214 <a name="ClutterAnimator-script-example"></a><p class="title"><b>Example 12. ClutterAnimator definition</b></p>
 215 <div class="example-contents">
 216 <p>The following JSON fragment defines a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>
 217     with the duration of 1 second and operating on the x and y
 218     properties of a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> named "rect-01", with two frames
 219     for each property. The first frame will linearly move the actor
 220     from its current position to the 100, 100 position in 20 percent
 221     of the duration of the animation; the second will using a cubic
 222     easing to move the actor to the 200, 200 coordinates.</p>
 223 <pre class="programlisting">
 224  {
 225    "type" : "ClutterAnimator",
 226    "duration" : 1000,
 227    "properties" : [
 228      {
 229        "object" : "rect-01",
 230        "name" : "x",
 231        "ease-in" : true,
 232        "keys" : [
 233          [ 0.2, "linear",       100.0 ],
 234          [ 1.0, "easeOutCubic", 200.0 ]
 235        ]
 236      },
 237      {
 238        "object" : "rect-01",
 239        "name" : "y",
 240        "ease-in" : true,
 241        "keys" : [
 242          [ 0.2, "linear",       100.0 ],
 243          [ 1.0, "easeOutCubic", 200.0 ]
 244        ]
 245      }
 246    ]
 247  }
 248     </pre>
 249 </div>
 250 </div>
 251 <br class="example-break">
 252 </div>
 253 <p>
 254 </p>
 255 <p>
 256 <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> is available since Clutter 1.2
 257 </p>
 258 </div>
 259 <div class="refsect1">
 260 <a name="ClutterAnimator.details"></a><h2>Details</h2>
 261 <div class="refsect2">
 262 <a name="ClutterAnimator-struct"></a><h3>ClutterAnimator</h3>
 263 <pre class="programlisting">typedef struct _ClutterAnimator ClutterAnimator;</pre>
 264 <p>
 265 The <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> structure contains only private data and
 266 should be accessed using the provided API
 267 </p>
 268 <p class="since">Since 1.2</p>
 269 </div>
 270 <hr>
 271 <div class="refsect2">
 272 <a name="ClutterAnimatorClass"></a><h3>struct ClutterAnimatorClass</h3>
 273 <pre class="programlisting">struct ClutterAnimatorClass {
 274 };
 275 </pre>
 276 <p>
 277 The <a class="link" href="ClutterAnimator.html#ClutterAnimatorClass" title="struct ClutterAnimatorClass"><span class="type">ClutterAnimatorClass</span></a> structure contains only private data
 278 </p>
 279 <p class="since">Since 1.2</p>
 280 </div>
 281 <hr>
 282 <div class="refsect2">
 283 <a name="clutter-animator-new"></a><h3>clutter_animator_new ()</h3>
 284 <pre class="programlisting"><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="returnvalue">ClutterAnimator</span></a> *   clutter_animator_new                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 285 <p>
 286 Creates a new <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> instance
 287 </p>
 288 <div class="variablelist"><table border="0">
 289 <col align="left" valign="top">
 290 <tbody><tr>
 291 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 292 <td>a new <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>.</td>
 293 </tr></tbody>
 294 </table></div>
 295 <p class="since">Since 1.2</p>
 296 </div>
 297 <hr>
 298 <div class="refsect2">
 299 <a name="clutter-animator-set"></a><h3>clutter_animator_set ()</h3>
 300 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_animator_set                (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
 301                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> first_object</code></em>,
 302                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *first_property_name</code></em>,
 303                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> first_mode</code></em>,
 304                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> first_progress</code></em>,
 305                                                          <em class="parameter"><code>...</code></em>);</pre>
 306 <p>
 307 Adds multiple keys to a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>, specifying the value a given
 308 property should have at a given progress of the animation. The mode
 309 specified is the mode used when going to this key from the previous key of
 310 the <em class="parameter"><code>property_name</code></em>
 311 </p>
 312 <p>
 313 If a given (object, property, progress) tuple already exist the mode and
 314 value will be replaced with the new values.
 315 </p>
 316 <div class="variablelist"><table border="0">
 317 <col align="left" valign="top">
 318 <tbody>
 319 <tr>
 320 <td><p><span class="term"><em class="parameter"><code>animator</code></em> :</span></p></td>
 321 <td>a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>
 322 </td>
 323 </tr>
 324 <tr>
 325 <td><p><span class="term"><em class="parameter"><code>first_object</code></em> :</span></p></td>
 326 <td>a <a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>
 327 </td>
 328 </tr>
 329 <tr>
 330 <td><p><span class="term"><em class="parameter"><code>first_property_name</code></em> :</span></p></td>
 331 <td>the property to specify a key for</td>
 332 </tr>
 333 <tr>
 334 <td><p><span class="term"><em class="parameter"><code>first_mode</code></em> :</span></p></td>
 335 <td>the id of the alpha function to use</td>
 336 </tr>
 337 <tr>
 338 <td><p><span class="term"><em class="parameter"><code>first_progress</code></em> :</span></p></td>
 339 <td>at which stage of the animation this value applies; the
 340 range is a normalized floating point value between 0 and 1</td>
 341 </tr>
 342 <tr>
 343 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 344 <td>the value first_property_name should have for first_object
 345 at first_progress, followed by more (object, property_name, mode,
 346 progress, value) tuples, followed by <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 347 </td>
 348 </tr>
 349 </tbody>
 350 </table></div>
 351 <p class="since">Since 1.2</p>
 352 </div>
 353 <hr>
 354 <div class="refsect2">
 355 <a name="clutter-animator-set-key"></a><h3>clutter_animator_set_key ()</h3>
 356 <pre class="programlisting"><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="returnvalue">ClutterAnimator</span></a> *   clutter_animator_set_key            (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
 357                                                          <em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
 358                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>,
 359                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> mode</code></em>,
 360                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> progress</code></em>,
 361                                                          <em class="parameter"><code>const <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
 362 <p>
 363 Sets a single key in the <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> for the <em class="parameter"><code>property_name</code></em> of
 364 <em class="parameter"><code>object</code></em> at <em class="parameter"><code>progress</code></em>.
 365 </p>
 366 <p>
 367 See also: <a class="link" href="ClutterAnimator.html#clutter-animator-set" title="clutter_animator_set ()"><code class="function">clutter_animator_set()</code></a>
 368 </p>
 369 <div class="variablelist"><table border="0">
 370 <col align="left" valign="top">
 371 <tbody>
 372 <tr>
 373 <td><p><span class="term"><em class="parameter"><code>animator</code></em> :</span></p></td>
 374 <td>a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>
 375 </td>
 376 </tr>
 377 <tr>
 378 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 379 <td>a <a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>
 380 </td>
 381 </tr>
 382 <tr>
 383 <td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
 384 <td>the property to specify a key for</td>
 385 </tr>
 386 <tr>
 387 <td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
 388 <td>the id of the alpha function to use</td>
 389 </tr>
 390 <tr>
 391 <td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
 392 <td>the normalized range at which stage of the animation this
 393 value applies</td>
 394 </tr>
 395 <tr>
 396 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 397 <td>the value property_name should have at progress.</td>
 398 </tr>
 399 <tr>
 400 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 401 <td>The animator instance. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 402 </td>
 403 </tr>
 404 </tbody>
 405 </table></div>
 406 <p class="since">Since 1.2</p>
 407 </div>
 408 <hr>
 409 <div class="refsect2">
 410 <a name="clutter-animator-remove-key"></a><h3>clutter_animator_remove_key ()</h3>
 411 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_animator_remove_key         (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
 412                                                          <em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
 413                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>,
 414                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> progress</code></em>);</pre>
 415 <p>
 416 Removes all keys matching the conditions specificed in the arguments.
 417 </p>
 418 <div class="variablelist"><table border="0">
 419 <col align="left" valign="top">
 420 <tbody>
 421 <tr>
 422 <td><p><span class="term"><em class="parameter"><code>animator</code></em> :</span></p></td>
 423 <td>a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>
 424 </td>
 425 </tr>
 426 <tr>
 427 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 428 <td>a <a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> to search for, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> for all. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 429 </td>
 430 </tr>
 431 <tr>
 432 <td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
 433 <td>a specific property name to query for,
 434 or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> for all. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 435 </td>
 436 </tr>
 437 <tr>
 438 <td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
 439 <td>a specific progress to search for or a negative value
 440 for all</td>
 441 </tr>
 442 </tbody>
 443 </table></div>
 444 <p class="since">Since 1.2</p>
 445 </div>
 446 <hr>
 447 <div class="refsect2">
 448 <a name="clutter-animator-get-keys"></a><h3>clutter_animator_get_keys ()</h3>
 449 <pre class="programlisting"><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             clutter_animator_get_keys           (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
 450                                                          <em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
 451                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>,
 452                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> progress</code></em>);</pre>
 453 <p>
 454 Returns a list of pointers to opaque structures with accessor functions
 455 that describe the keys added to an animator.
 456 </p>
 457 <div class="variablelist"><table border="0">
 458 <col align="left" valign="top">
 459 <tbody>
 460 <tr>
 461 <td><p><span class="term"><em class="parameter"><code>animator</code></em> :</span></p></td>
 462 <td>a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> instance</td>
 463 </tr>
 464 <tr>
 465 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 466 <td>a <a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> to search for, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> for all objects. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 467 </td>
 468 </tr>
 469 <tr>
 470 <td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
 471 <td>a specific property name to query for,
 472 or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> for all properties. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 473 </td>
 474 </tr>
 475 <tr>
 476 <td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
 477 <td>a specific progress to search for, or a negative value for all
 478 progresses</td>
 479 </tr>
 480 <tr>
 481 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 482 <td>a
 483 list of <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a>s; the contents of the list are owned
 484 by the <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>, but you should free the returned list when done,
 485 using <a href="../glib/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>. <span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Clutter.AnimatorKey]</span>
 486 </td>
 487 </tr>
 488 </tbody>
 489 </table></div>
 490 <p class="since">Since 1.2</p>
 491 </div>
 492 <hr>
 493 <div class="refsect2">
 494 <a name="clutter-animator-start"></a><h3>clutter_animator_start ()</h3>
 495 <pre class="programlisting"><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *   clutter_animator_start              (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>);</pre>
 496 <p>
 497 Start the ClutterAnimator, this is a thin wrapper that rewinds
 498 and starts the animators current timeline.
 499 </p>
 500 <div class="variablelist"><table border="0">
 501 <col align="left" valign="top">
 502 <tbody>
 503 <tr>
 504 <td><p><span class="term"><em class="parameter"><code>animator</code></em> :</span></p></td>
 505 <td>a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>
 506 </td>
 507 </tr>
 508 <tr>
 509 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 510 <td>the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> that drives
 511 the animator. The returned timeline is owned by the <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>
 512 and it should not be unreferenced. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 513 </td>
 514 </tr>
 515 </tbody>
 516 </table></div>
 517 <p class="since">Since 1.2</p>
 518 </div>
 519 <hr>
 520 <div class="refsect2">
 521 <a name="clutter-animator-compute-value"></a><h3>clutter_animator_compute_value ()</h3>
 522 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_animator_compute_value      (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
 523                                                          <em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
 524                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>,
 525                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> progress</code></em>,
 526                                                          <em class="parameter"><code><a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
 527 <p>
 528 Compute the value for a managed property at a given progress.
 529 </p>
 530 <p>
 531 If the property is an ease-in property, the current value of the property
 532 on the object will be used as the starting point for computation.
 533 </p>
 534 <div class="variablelist"><table border="0">
 535 <col align="left" valign="top">
 536 <tbody>
 537 <tr>
 538 <td><p><span class="term"><em class="parameter"><code>animator</code></em> :</span></p></td>
 539 <td>a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>
 540 </td>
 541 </tr>
 542 <tr>
 543 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 544 <td>a <a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>
 545 </td>
 546 </tr>
 547 <tr>
 548 <td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
 549 <td>the name of the property on object to check</td>
 550 </tr>
 551 <tr>
 552 <td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
 553 <td>a value between 0.0 and 1.0</td>
 554 </tr>
 555 <tr>
 556 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 557 <td>an initialized value to store the computed result</td>
 558 </tr>
 559 <tr>
 560 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 561 <td>
 562 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the computation yields has a value, otherwise (when
 563 an error occurs or the progress is before any of the keys) <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is
 564 returned and the <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> is left untouched</td>
 565 </tr>
 566 </tbody>
 567 </table></div>
 568 <p class="since">Since 1.2</p>
 569 </div>
 570 <hr>
 571 <div class="refsect2">
 572 <a name="clutter-animator-set-timeline"></a><h3>clutter_animator_set_timeline ()</h3>
 573 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_animator_set_timeline       (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
 574                                                          <em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
 575 <p>
 576 Sets an external timeline that will be used for driving the animation
 577 </p>
 578 <div class="variablelist"><table border="0">
 579 <col align="left" valign="top">
 580 <tbody>
 581 <tr>
 582 <td><p><span class="term"><em class="parameter"><code>animator</code></em> :</span></p></td>
 583 <td>a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>
 584 </td>
 585 </tr>
 586 <tr>
 587 <td><p><span class="term"><em class="parameter"><code>timeline</code></em> :</span></p></td>
 588 <td>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
 589 </td>
 590 </tr>
 591 </tbody>
 592 </table></div>
 593 <p class="since">Since 1.2</p>
 594 </div>
 595 <hr>
 596 <div class="refsect2">
 597 <a name="clutter-animator-get-timeline"></a><h3>clutter_animator_get_timeline ()</h3>
 598 <pre class="programlisting"><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *   clutter_animator_get_timeline       (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>);</pre>
 599 <p>
 600 Get the timeline hooked up for driving the <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>
 601 </p>
 602 <div class="variablelist"><table border="0">
 603 <col align="left" valign="top">
 604 <tbody>
 605 <tr>
 606 <td><p><span class="term"><em class="parameter"><code>animator</code></em> :</span></p></td>
 607 <td>a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>
 608 </td>
 609 </tr>
 610 <tr>
 611 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 612 <td>the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> that drives the animator. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 613 </td>
 614 </tr>
 615 </tbody>
 616 </table></div>
 617 <p class="since">Since 1.2</p>
 618 </div>
 619 <hr>
 620 <div class="refsect2">
 621 <a name="clutter-animator-set-duration"></a><h3>clutter_animator_set_duration ()</h3>
 622 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_animator_set_duration       (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
 623                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> duration</code></em>);</pre>
 624 <p>
 625 Runs the timeline of the <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> with a duration in msecs
 626 as specified.
 627 </p>
 628 <div class="variablelist"><table border="0">
 629 <col align="left" valign="top">
 630 <tbody>
 631 <tr>
 632 <td><p><span class="term"><em class="parameter"><code>animator</code></em> :</span></p></td>
 633 <td>a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>
 634 </td>
 635 </tr>
 636 <tr>
 637 <td><p><span class="term"><em class="parameter"><code>duration</code></em> :</span></p></td>
 638 <td>milliseconds a run of the animator should last.</td>
 639 </tr>
 640 </tbody>
 641 </table></div>
 642 <p class="since">Since 1.2</p>
 643 </div>
 644 <hr>
 645 <div class="refsect2">
 646 <a name="clutter-animator-get-duration"></a><h3>clutter_animator_get_duration ()</h3>
 647 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               clutter_animator_get_duration       (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>);</pre>
 648 <p>
 649 Retrieves the current duration of an animator
 650 </p>
 651 <div class="variablelist"><table border="0">
 652 <col align="left" valign="top">
 653 <tbody>
 654 <tr>
 655 <td><p><span class="term"><em class="parameter"><code>animator</code></em> :</span></p></td>
 656 <td>a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>
 657 </td>
 658 </tr>
 659 <tr>
 660 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 661 <td>the duration of the animation, in milliseconds</td>
 662 </tr>
 663 </tbody>
 664 </table></div>
 665 <p class="since">Since 1.2</p>
 666 </div>
 667 <hr>
 668 <div class="refsect2">
 669 <a name="clutter-animator-property-set-ease-in"></a><h3>clutter_animator_property_set_ease_in ()</h3>
 670 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_animator_property_set_ease_in
 671                                                         (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
 672                                                          <em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
 673                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>,
 674                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> ease_in</code></em>);</pre>
 675 <p>
 676 Sets whether a property value is to be eased into the animation.
 677 </p>
 678 <div class="variablelist"><table border="0">
 679 <col align="left" valign="top">
 680 <tbody>
 681 <tr>
 682 <td><p><span class="term"><em class="parameter"><code>animator</code></em> :</span></p></td>
 683 <td>a <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a>
 684 </td>
 685 </tr>
 686 <tr>
 687 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 688 <td>a <a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>
 689 </td>
 690 </tr>
 691 <tr>
 692 <td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
 693 <td>the name of a property on object</td>
 694 </tr>
 695 <tr>
 696 <td><p><span class="term"><em class="parameter"><code>ease_in</code></em> :</span></p></td>
 697 <td>we are going to be easing in this property</td>
 698 </tr>
 699 </tbody>
 700 </table></div>
 701 <p class="since">Since 1.2</p>
 702 </div>
 703 <hr>
 704 <div class="refsect2">
 705 <a name="clutter-animator-property-get-ease-in"></a><h3>clutter_animator_property_get_ease_in ()</h3>
 706 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_animator_property_get_ease_in
 707                                                         (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
 708                                                          <em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
 709                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>);</pre>
 710 <p>
 711 Checks if a property value is to be eased into the animation.
 712 </p>
 713 <div class="variablelist"><table border="0">
 714 <col align="left" valign="top">
 715 <tbody>
 716 <tr>
 717 <td><p><span class="term"><em class="parameter"><code>animator</code></em> :</span></p></td>
 718 <td>a <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a>
 719 </td>
 720 </tr>
 721 <tr>
 722 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 723 <td>a <a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>
 724 </td>
 725 </tr>
 726 <tr>
 727 <td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
 728 <td>the name of a property on object</td>
 729 </tr>
 730 <tr>
 731 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 732 <td>
 733 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the property is eased in</td>
 734 </tr>
 735 </tbody>
 736 </table></div>
 737 <p class="since">Since 1.2</p>
 738 </div>
 739 <hr>
 740 <div class="refsect2">
 741 <a name="ClutterInterpolation"></a><h3>enum ClutterInterpolation</h3>
 742 <pre class="programlisting">typedef enum {
 743   CLUTTER_INTERPOLATION_LINEAR,
 744   CLUTTER_INTERPOLATION_CUBIC
 745 } ClutterInterpolation;
 746 </pre>
 747 <p>
 748 The mode of interpolation between key frames
 749 </p>
 750 <div class="variablelist"><table border="0">
 751 <col align="left" valign="top">
 752 <tbody>
 753 <tr>
 754 <td><p><a name="CLUTTER-INTERPOLATION-LINEAR:CAPS"></a><span class="term"><code class="literal">CLUTTER_INTERPOLATION_LINEAR</code></span></p></td>
 755 <td>linear interpolation
 756 </td>
 757 </tr>
 758 <tr>
 759 <td><p><a name="CLUTTER-INTERPOLATION-CUBIC:CAPS"></a><span class="term"><code class="literal">CLUTTER_INTERPOLATION_CUBIC</code></span></p></td>
 760 <td>cubic interpolation
 761 </td>
 762 </tr>
 763 </tbody>
 764 </table></div>
 765 <p class="since">Since 1.2</p>
 766 </div>
 767 <hr>
 768 <div class="refsect2">
 769 <a name="clutter-animator-property-set-interpolation"></a><h3>clutter_animator_property_set_interpolation ()</h3>
 770 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_animator_property_set_interpolation
 771                                                         (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
 772                                                          <em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
 773                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>,
 774                                                          <em class="parameter"><code><a class="link" href="ClutterAnimator.html#ClutterInterpolation" title="enum ClutterInterpolation"><span class="type">ClutterInterpolation</span></a> interpolation</code></em>);</pre>
 775 <p>
 776 Set the interpolation method to use, <a class="link" href="ClutterAnimator.html#CLUTTER-INTERPOLATION-LINEAR:CAPS"><code class="literal">CLUTTER_INTERPOLATION_LINEAR</code></a> causes
 777 the values to linearly change between the values, and
 778 <a class="link" href="ClutterAnimator.html#CLUTTER-INTERPOLATION-CUBIC:CAPS"><code class="literal">CLUTTER_INTERPOLATION_CUBIC</code></a> causes the values to smoothly change between
 779 the values.
 780 </p>
 781 <div class="variablelist"><table border="0">
 782 <col align="left" valign="top">
 783 <tbody>
 784 <tr>
 785 <td><p><span class="term"><em class="parameter"><code>animator</code></em> :</span></p></td>
 786 <td>a <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a>
 787 </td>
 788 </tr>
 789 <tr>
 790 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 791 <td>a <a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>
 792 </td>
 793 </tr>
 794 <tr>
 795 <td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
 796 <td>the name of a property on object</td>
 797 </tr>
 798 <tr>
 799 <td><p><span class="term"><em class="parameter"><code>interpolation</code></em> :</span></p></td>
 800 <td>the <a class="link" href="ClutterAnimator.html#ClutterInterpolation" title="enum ClutterInterpolation"><span class="type">ClutterInterpolation</span></a> to use</td>
 801 </tr>
 802 </tbody>
 803 </table></div>
 804 <p class="since">Since 1.2</p>
 805 </div>
 806 <hr>
 807 <div class="refsect2">
 808 <a name="clutter-animator-property-get-interpolation"></a><h3>clutter_animator_property_get_interpolation ()</h3>
 809 <pre class="programlisting"><a class="link" href="ClutterAnimator.html#ClutterInterpolation" title="enum ClutterInterpolation"><span class="returnvalue">ClutterInterpolation</span></a> clutter_animator_property_get_interpolation
 810                                                         (<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>,
 811                                                          <em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
 812                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>);</pre>
 813 <p>
 814 Get the interpolation used by animator for a property on a particular
 815 object.
 816 </p>
 817 <div class="variablelist"><table border="0">
 818 <col align="left" valign="top">
 819 <tbody>
 820 <tr>
 821 <td><p><span class="term"><em class="parameter"><code>animator</code></em> :</span></p></td>
 822 <td>a <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a>
 823 </td>
 824 </tr>
 825 <tr>
 826 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 827 <td>a <a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>
 828 </td>
 829 </tr>
 830 <tr>
 831 <td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
 832 <td>the name of a property on object</td>
 833 </tr>
 834 <tr>
 835 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 836 <td>a ClutterInterpolation value.</td>
 837 </tr>
 838 </tbody>
 839 </table></div>
 840 <p class="since">Since 1.2</p>
 841 </div>
 842 <hr>
 843 <div class="refsect2">
 844 <a name="ClutterAnimatorKey"></a><h3>ClutterAnimatorKey</h3>
 845 <pre class="programlisting">typedef struct _ClutterAnimatorKey ClutterAnimatorKey;</pre>
 846 <p>
 847 A key frame inside a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>
 848 </p>
 849 <p class="since">Since 1.2</p>
 850 </div>
 851 <hr>
 852 <div class="refsect2">
 853 <a name="clutter-animator-key-get-object"></a><h3>clutter_animator_key_get_object ()</h3>
 854 <pre class="programlisting"><a href="../gobject/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> *           clutter_animator_key_get_object     (<em class="parameter"><code>const <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a> *key</code></em>);</pre>
 855 <p>
 856 Retrieves the object a key applies to.
 857 </p>
 858 <div class="variablelist"><table border="0">
 859 <col align="left" valign="top">
 860 <tbody>
 861 <tr>
 862 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 863 <td>a <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a>
 864 </td>
 865 </tr>
 866 <tr>
 867 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 868 <td>the object an animator_key exist for. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 869 </td>
 870 </tr>
 871 </tbody>
 872 </table></div>
 873 <p class="since">Since 1.2</p>
 874 </div>
 875 <hr>
 876 <div class="refsect2">
 877 <a name="clutter-animator-key-get-property-name"></a><h3>clutter_animator_key_get_property_name ()</h3>
 878 <pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       clutter_animator_key_get_property_name
 879                                                         (<em class="parameter"><code>const <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a> *key</code></em>);</pre>
 880 <p>
 881 Retrieves the name of the property a key applies to.
 882 </p>
 883 <div class="variablelist"><table border="0">
 884 <col align="left" valign="top">
 885 <tbody>
 886 <tr>
 887 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 888 <td>a <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a>
 889 </td>
 890 </tr>
 891 <tr>
 892 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 893 <td>the name of the property an animator_key exist for.</td>
 894 </tr>
 895 </tbody>
 896 </table></div>
 897 <p class="since">Since 1.2</p>
 898 </div>
 899 <hr>
 900 <div class="refsect2">
 901 <a name="clutter-animator-key-get-property-type"></a><h3>clutter_animator_key_get_property_type ()</h3>
 902 <pre class="programlisting"><a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               clutter_animator_key_get_property_type
 903                                                         (<em class="parameter"><code>const <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a> *key</code></em>);</pre>
 904 <p>
 905 Retrieves the <a href="../gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the property a key applies to
 906 </p>
 907 <p>
 908 You can use this type to initialize the <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> to pass to
 909 <a class="link" href="ClutterAnimator.html#clutter-animator-key-get-value" title="clutter_animator_key_get_value ()"><code class="function">clutter_animator_key_get_value()</code></a>
 910 </p>
 911 <div class="variablelist"><table border="0">
 912 <col align="left" valign="top">
 913 <tbody>
 914 <tr>
 915 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 916 <td>a <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a>
 917 </td>
 918 </tr>
 919 <tr>
 920 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 921 <td>the <a href="../gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the property</td>
 922 </tr>
 923 </tbody>
 924 </table></div>
 925 <p class="since">Since 1.2</p>
 926 </div>
 927 <hr>
 928 <div class="refsect2">
 929 <a name="clutter-animator-key-get-mode"></a><h3>clutter_animator_key_get_mode ()</h3>
 930 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gulong"><span class="returnvalue">gulong</span></a>              clutter_animator_key_get_mode       (<em class="parameter"><code>const <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a> *key</code></em>);</pre>
 931 <p>
 932 Retrieves the mode of a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> key, for the first key of a
 933 property for an object this represents the whether the animation is
 934 open ended and or curved for the remainding keys for the property it
 935 represents the easing mode.
 936 </p>
 937 <div class="variablelist"><table border="0">
 938 <col align="left" valign="top">
 939 <tbody>
 940 <tr>
 941 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 942 <td>a <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a>
 943 </td>
 944 </tr>
 945 <tr>
 946 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 947 <td>the mode of a <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a>
 948 </td>
 949 </tr>
 950 </tbody>
 951 </table></div>
 952 <p class="since">Since 1.2</p>
 953 </div>
 954 <hr>
 955 <div class="refsect2">
 956 <a name="clutter-animator-key-get-progress"></a><h3>clutter_animator_key_get_progress ()</h3>
 957 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             clutter_animator_key_get_progress   (<em class="parameter"><code>const <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a> *key</code></em>);</pre>
 958 <p>
 959 Retrieves the progress of an clutter_animator_key
 960 </p>
 961 <div class="variablelist"><table border="0">
 962 <col align="left" valign="top">
 963 <tbody>
 964 <tr>
 965 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 966 <td>a <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a>
 967 </td>
 968 </tr>
 969 <tr>
 970 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 971 <td>the progress defined for a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> key.</td>
 972 </tr>
 973 </tbody>
 974 </table></div>
 975 <p class="since">Since 1.2</p>
 976 </div>
 977 <hr>
 978 <div class="refsect2">
 979 <a name="clutter-animator-key-get-value"></a><h3>clutter_animator_key_get_value ()</h3>
 980 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_animator_key_get_value      (<em class="parameter"><code>const <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a> *key</code></em>,
 981                                                          <em class="parameter"><code><a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
 982 <p>
 983 Retrieves a copy of the value for a <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a>.
 984 </p>
 985 <p>
 986 The passed in <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> needs to be already initialized for the value
 987 type of the key or to a type that allow transformation from the value
 988 type of the key.
 989 </p>
 990 <p>
 991 Use <a href="../gobject/gobject-Generic-values.html#g-value-unset"><code class="function">g_value_unset()</code></a> when done.
 992 </p>
 993 <div class="variablelist"><table border="0">
 994 <col align="left" valign="top">
 995 <tbody>
 996 <tr>
 997 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 998 <td>a <a class="link" href="ClutterAnimator.html#ClutterAnimatorKey" title="ClutterAnimatorKey"><span class="type">ClutterAnimatorKey</span></a>
 999 </td>
1000 </tr>
1001 <tr>
1002 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
1003 <td>a <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> initialized with the correct type for the animator key</td>
1004 </tr>
1005 <tr>
1006 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1007 <td>
1008 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the passed <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> was successfully set, and
1009 <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
1010 </tr>
1011 </tbody>
1012 </table></div>
1013 <p class="since">Since 1.2</p>
1014 </div>
1015 </div>
1016 <div class="refsect1">
1017 <a name="ClutterAnimator.property-details"></a><h2>Property Details</h2>
1018 <div class="refsect2">
1019 <a name="ClutterAnimator--duration"></a><h3>The <code class="literal">"duration"</code> property</h3>
1020 <pre class="programlisting">  "duration"                 <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
1021 <p>
1022 The duration of the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> used by the <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>
1023 to drive the animation
1024 </p>
1025 <p>Default value: 2000</p>
1026 <p class="since">Since 1.2</p>
1027 </div>
1028 <hr>
1029 <div class="refsect2">
1030 <a name="ClutterAnimator--timeline"></a><h3>The <code class="literal">"timeline"</code> property</h3>
1031 <pre class="programlisting">  "timeline"                 <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>*      : Read / Write</pre>
1032 <p>
1033 The <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> used by the <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> to drive the
1034 animation
1035 </p>
1036 <p class="since">Since 1.2</p>
1037 </div>
1038 </div>
1039 <div class="refsect1">
1040 <a name="ClutterAnimator.see-also"></a><h2>See Also</h2>
1041 <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a>, <a class="link" href="clutter-Value-intervals.html#ClutterInterval"><span class="type">ClutterInterval</span></a>, <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a>,
1042   <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
1043 </div>
1044 </div>
1045 <div class="footer">
1046 <hr>
1047           Generated by GTK-Doc V1.18.1</div>
1048 </body>
1049 </html>