libclutter-1.0-doc 1.16.4-0ubuntu2 / usr / share / gtk-doc / html / clutter / ClutterAnimatable.html

This file is indexed.

/usr/share/gtk-doc/html/clutter/ClutterAnimatable.html is in libclutter-1.0-doc 1.16.4-0ubuntu2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Clutter Reference Manual: ClutterAnimatable</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Clutter Reference Manual">
<link rel="up" href="ch09.html" title="Base classes">
<link rel="prev" href="clutter-Value-intervals.html" title="Value intervals">
<link rel="next" href="ClutterTransition.html" title="ClutterTransition">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
                  <a href="#ClutterAnimatable.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#ClutterAnimatable.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span> 
                  <a href="#ClutterAnimatable.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations"> <span class="dim">|</span> 
                  <a href="#ClutterAnimatable.implementations" class="shortcut">Known Implementations</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch09.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="clutter-Value-intervals.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterTransition.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterAnimatable"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterAnimatable.top_of_page"></a>ClutterAnimatable</span></h2>
<p>ClutterAnimatable — Interface for animatable classes</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterAnimatable.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterAnimatable.html#clutter-animatable-animate-property" title="clutter_animatable_animate_property ()">clutter_animatable_animate_property</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GParamSpec</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterAnimatable.html#clutter-animatable-find-property" title="clutter_animatable_find_property ()">clutter_animatable_find_property</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterAnimatable.html#clutter-animatable-get-initial-state" title="clutter_animatable_get_initial_state ()">clutter_animatable_get_initial_state</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterAnimatable.html#clutter-animatable-set-final-state" title="clutter_animatable_set_final_state ()">clutter_animatable_set_final_state</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterAnimatable.html#clutter-animatable-interpolate-value" title="clutter_animatable_interpolate_value ()">clutter_animatable_interpolate_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterAnimatable.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="ClutterAnimatable.html#ClutterAnimatable-struct" title="ClutterAnimatable">ClutterAnimatable</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterAnimatable.html#ClutterAnimatableIface" title="struct ClutterAnimatableIface">ClutterAnimatableIface</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterAnimatable.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GInterface
    <span class="lineart">╰──</span> ClutterAnimatable
</pre>
</div>
<div class="refsect1">
<a name="ClutterAnimatable.prerequisites"></a><h2>Prerequisites</h2>
<p>
ClutterAnimatable requires
 GObject.</p>
</div>
<div class="refsect1">
<a name="ClutterAnimatable.implementations"></a><h2>Known Implementations</h2>
<p>
ClutterAnimatable is implemented by
 <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="ClutterScrollActor.html" title="ClutterScrollActor">ClutterScrollActor</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>
</div>
<div class="refsect1">
<a name="ClutterAnimatable.description"></a><h2>Description</h2>
<p><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
to control how a <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a> will animate a property.</p>
<p>Each <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> should implement the
<code class="function">ClutterAnimatableIface.interpolate_property()</code> virtual function of the
interface to compute the animation state between two values of an interval
depending on a progress factor, expressed as a floating point value.</p>
<p>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>
instance, the <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a> will call
<code class="function">clutter_animatable_interpolate_property()</code> passing the name of the
currently animated property; the values interval; and the progress factor.
The <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> implementation should return the computed value for
the animated
property.</p>
<p><a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> is available since Clutter 1.0</p>
</div>
<div class="refsect1">
<a name="ClutterAnimatable.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-animatable-animate-property"></a><h3>clutter_animatable_animate_property ()</h3>
<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>,
                                     <em class="parameter"><code><a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a> *animation</code></em>,
                                     <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>,
                                     <em class="parameter"><code>const <span class="type">GValue</span> *initial_value</code></em>,
                                     <em class="parameter"><code>const <span class="type">GValue</span> *final_value</code></em>,
                                     <em class="parameter"><code><span class="type">gdouble</span> progress</code></em>,
                                     <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
<div class="warning">
<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.</p>
<p>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>
  instead</p>
</div>
<p>Calls the <code class="function">animate_property()</code> virtual function for <em class="parameter"><code>animatable</code></em>
.</p>
<p>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
the same type; <em class="parameter"><code>value</code></em>
 must have been initialized to the same
type of <em class="parameter"><code>initial_value</code></em>
 and <em class="parameter"><code>final_value</code></em>
.</p>
<p>All implementation of the <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> interface must
implement this function.</p>
<div class="refsect3">
<a name="id-1.6.3.4.9.2.9"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>animatable</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>animation</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property_name</p></td>
<td class="parameter_description"><p>the name of the animated property</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>initial_value</p></td>
<td class="parameter_description"><p>the initial value of the animation interval</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>final_value</p></td>
<td class="parameter_description"><p>the final value of the animation interval</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>progress</p></td>
<td class="parameter_description"><p>the progress factor</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>return location for the animation value</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.3.4.9.2.10"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the value has been validated and can
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</p>
<p></p>
</div>
<p class="since">Since 1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-animatable-find-property"></a><h3>clutter_animatable_find_property ()</h3>
<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>,
                                  <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);</pre>
<p>Finds the <span class="type">GParamSpec</span> for <em class="parameter"><code>property_name</code></em>
</p>
<div class="refsect3">
<a name="id-1.6.3.4.9.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>animatable</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property_name</p></td>
<td class="parameter_description"><p>the name of the animatable property to find</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.3.4.9.3.6"></a><h4>Returns</h4>
<p> The <span class="type">GParamSpec</span> for the given property
or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-animatable-get-initial-state"></a><h3>clutter_animatable_get_initial_state ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_animatable_get_initial_state (<em class="parameter"><code><a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> *animatable</code></em>,
                                      <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>,
                                      <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
<p>Retrieves the current state of <em class="parameter"><code>property_name</code></em>
 and sets <em class="parameter"><code>value</code></em>
 with it</p>
<div class="refsect3">
<a name="id-1.6.3.4.9.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>animatable</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property_name</p></td>
<td class="parameter_description"><p>the name of the animatable property to retrieve</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>a <span class="type">GValue</span> initialized to the type of the property to retrieve</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-animatable-set-final-state"></a><h3>clutter_animatable_set_final_state ()</h3>
<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>,
                                    <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>,
                                    <em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);</pre>
<p>Sets the current state of <em class="parameter"><code>property_name</code></em>
 to <em class="parameter"><code>value</code></em>
</p>
<div class="refsect3">
<a name="id-1.6.3.4.9.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>animatable</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property_name</p></td>
<td class="parameter_description"><p>the name of the animatable property to set</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the value of the animatable property to set</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-animatable-interpolate-value"></a><h3>clutter_animatable_interpolate_value ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_animatable_interpolate_value (<em class="parameter"><code><a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> *animatable</code></em>,
                                      <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>,
                                      <em class="parameter"><code><a class="link" href="clutter-Value-intervals.html#ClutterInterval"><span class="type">ClutterInterval</span></a> *interval</code></em>,
                                      <em class="parameter"><code><span class="type">gdouble</span> progress</code></em>,
                                      <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
<p>Asks a <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> implementation to interpolate a
a named property between the initial and final values of
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
value, and store the result inside <em class="parameter"><code>value</code></em>
.</p>
<p>This function should be used for every property animation
involving <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a>s.</p>
<p>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>.</p>
<div class="refsect3">
<a name="id-1.6.3.4.9.6.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>animatable</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property_name</p></td>
<td class="parameter_description"><p>the name of the property to interpolate</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>interval</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-Value-intervals.html#ClutterInterval"><span class="type">ClutterInterval</span></a> with the animation range</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>progress</p></td>
<td class="parameter_description"><p>the progress to use to interpolate between the
initial and final values of the <em class="parameter"><code>interval</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p> return location for an initialized <span class="type">GValue</span>
using the same type of the <em class="parameter"><code>interval</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.3.4.9.6.8"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the interpolation was successful,
and <code class="literal">FALSE</code> otherwise</p>
<p></p>
</div>
<p class="since">Since 1.8</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterAnimatable.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterAnimatable-struct"></a><h3>ClutterAnimatable</h3>
<pre class="programlisting">typedef struct _ClutterAnimatable ClutterAnimatable;</pre>
<p><a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> is an opaque structure whose members cannot be directly
accessed</p>
<p class="since">Since 1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterAnimatableIface"></a><h3>struct ClutterAnimatableIface</h3>
<pre class="programlisting">struct ClutterAnimatableIface {
  gboolean    (* animate_property)  (ClutterAnimatable *animatable,
                                     ClutterAnimation  *animation,
                                     const gchar       *property_name,
                                     const GValue      *initial_value,
                                     const GValue      *final_value,
                                     gdouble            progress,
                                     GValue            *value);
  GParamSpec *(* find_property)     (ClutterAnimatable *animatable,
                                     const gchar       *property_name);
  void        (* get_initial_state) (ClutterAnimatable *animatable,
                                     const gchar       *property_name,
                                     GValue            *value);
  void        (* set_final_state)   (ClutterAnimatable *animatable,
                                     const gchar       *property_name,
                                     const GValue      *value);
  gboolean    (* interpolate_value) (ClutterAnimatable *animatable,
                                     const gchar       *property_name,
                                     ClutterInterval   *interval,
                                     gdouble            progress,
                                     GValue            *value);
};
</pre>
<p>Base interface for <span class="type">GObject</span>s that can be animated by a
a <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a>.</p>
<div class="refsect3">
<a name="id-1.6.3.4.10.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterAnimatableIface.animate-property"></a>animate_property</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual function for custom interpolation of a
property. This virtual function is deprecated</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterAnimatableIface.find-property"></a>find_property</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual function for retrieving the <span class="type">GParamSpec</span> of
an animatable property</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterAnimatableIface.get-initial-state"></a>get_initial_state</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual function for retrieving the initial
state of an animatable property</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterAnimatableIface.set-final-state"></a>set_final_state</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual function for setting the state of an
animatable property</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterAnimatableIface.interpolate-value"></a>interpolate_value</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual function for interpolating the progress
of a property</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.