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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUI::Animation Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a> </li>
<li class="navelem"><a class="el" href="classCEGUI_1_1Animation.html">Animation</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::Animation Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::Animation" -->
<p>Defines an 'animation' class.
<a href="classCEGUI_1_1Animation.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Collaboration diagram for CEGUI::Animation:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1Animation__coll__graph.gif" border="0" usemap="#CEGUI_1_1Animation_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1Animation_coll__map" id="CEGUI_1_1Animation_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="17,5,124,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1Animation-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#a555d95af529eeaf41ee643ace11e4ab8">ReplayMode</a> { <a class="el" href="classCEGUI_1_1Animation.html#a555d95af529eeaf41ee643ace11e4ab8adb37a6867f72e86848c50e9886c47e9f">RM_Once</a>,
<a class="el" href="classCEGUI_1_1Animation.html#a555d95af529eeaf41ee643ace11e4ab8ab52801e810c9d4b657c718899e0211f9">RM_Loop</a>,
<a class="el" href="classCEGUI_1_1Animation.html#a555d95af529eeaf41ee643ace11e4ab8abf06939a6441e758b7f8d595a1a472d2">RM_Bounce</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">enumerates possible replay modes <a href="classCEGUI_1_1Animation.html#a555d95af529eeaf41ee643ace11e4ab8">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#a02d16ec065672ef951ba66e9ddcc0fd2">Animation</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a464f70149c2b9855371d992a2502f6cf"></a><!-- doxytag: member="CEGUI::Animation::~Animation" ref="a464f70149c2b9855371d992a2502f6cf" args="(void)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#a464f70149c2b9855371d992a2502f6cf">~Animation</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">destructor, this destroys all affectors defined inside this animation <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f99018693d9651f7deb34742aa0aa93"></a><!-- doxytag: member="CEGUI::Animation::getName" ref="a7f99018693d9651f7deb34742aa0aa93" args="() const " -->
const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#a7f99018693d9651f7deb34742aa0aa93">getName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves name of this <a class="el" href="classCEGUI_1_1Animation.html" title="Defines an 'animation' class.">Animation</a> definition. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9af339e7edb6bacf0c17fc08b2efd981"></a><!-- doxytag: member="CEGUI::Animation::setReplayMode" ref="a9af339e7edb6bacf0c17fc08b2efd981" args="(ReplayMode mode)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#a9af339e7edb6bacf0c17fc08b2efd981">setReplayMode</a> (<a class="el" href="classCEGUI_1_1Animation.html#a555d95af529eeaf41ee643ace11e4ab8">ReplayMode</a> mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the replay mode of this animation. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05ad0ef5b89c625b78ccf131f5adde11"></a><!-- doxytag: member="CEGUI::Animation::getReplayMode" ref="a05ad0ef5b89c625b78ccf131f5adde11" args="() const " -->
<a class="el" href="classCEGUI_1_1Animation.html#a555d95af529eeaf41ee643ace11e4ab8">ReplayMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#a05ad0ef5b89c625b78ccf131f5adde11">getReplayMode</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the replay mode of this animation. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af91cac7ae397ecde5213c232aeac4b50"></a><!-- doxytag: member="CEGUI::Animation::setDuration" ref="af91cac7ae397ecde5213c232aeac4b50" args="(float duration)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#af91cac7ae397ecde5213c232aeac4b50">setDuration</a> (float duration)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the duration of this animation. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a295fd1fb8e9a2baed644b3e57e43c615"></a><!-- doxytag: member="CEGUI::Animation::getDuration" ref="a295fd1fb8e9a2baed644b3e57e43c615" args="() const " -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#a295fd1fb8e9a2baed644b3e57e43c615">getDuration</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the duration of this animation. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#aa5e4c041c3f042ce54fad18a1657287a">setAutoStart</a> (bool autoStart)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether this animation auto starts or not. <a href="#aa5e4c041c3f042ce54fad18a1657287a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#a3b40803cc10e56a1a391bcc070ed9816">getAutoStart</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves auto start. <a href="#a3b40803cc10e56a1a391bcc070ed9816"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Affector.html">Affector</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#a411b7ed50ed9c1d6544db9298f0e4a64">createAffector</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classCEGUI_1_1Affector.html" title="Defines an 'affector' class.">Affector</a>. <a href="#a411b7ed50ed9c1d6544db9298f0e4a64"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Affector.html">Affector</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#a4d9bcccc63b027d2a0626a186464d847">createAffector</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &targetProperty, const <a class="el" href="classCEGUI_1_1String.html">String</a> &interpolator)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classCEGUI_1_1Affector.html" title="Defines an 'affector' class.">Affector</a>. <a href="#a4d9bcccc63b027d2a0626a186464d847"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1b332ba5e063ef2b8f1e6469b65a995b"></a><!-- doxytag: member="CEGUI::Animation::destroyAffector" ref="a1b332ba5e063ef2b8f1e6469b65a995b" args="(Affector *affector)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#a1b332ba5e063ef2b8f1e6469b65a995b">destroyAffector</a> (<a class="el" href="classCEGUI_1_1Affector.html">Affector</a> *affector)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys given <a class="el" href="classCEGUI_1_1Affector.html" title="Defines an 'affector' class.">Affector</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a895c7b590461db6668ccf093fc06b1ce"></a><!-- doxytag: member="CEGUI::Animation::getAffectorAtIdx" ref="a895c7b590461db6668ccf093fc06b1ce" args="(size_t index) const " -->
<a class="el" href="classCEGUI_1_1Affector.html">Affector</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#a895c7b590461db6668ccf093fc06b1ce">getAffectorAtIdx</a> (size_t index) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the <a class="el" href="classCEGUI_1_1Affector.html" title="Defines an 'affector' class.">Affector</a> at given index. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad27426b8f108b2c91a986587ba07b93f"></a><!-- doxytag: member="CEGUI::Animation::getNumAffectors" ref="ad27426b8f108b2c91a986587ba07b93f" args="(void) const " -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#ad27426b8f108b2c91a986587ba07b93f">getNumAffectors</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves number of Affectors defined in this <a class="el" href="classCEGUI_1_1Animation.html" title="Defines an 'animation' class.">Animation</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#a066db84b652c4fa062c08ee7504d8446">defineAutoSubscription</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &eventName, const <a class="el" href="classCEGUI_1_1String.html">String</a> &action)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This defined a new auto subscription. <a href="#a066db84b652c4fa062c08ee7504d8446"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#aaccc5dcd3767b471c766f9b923caa383">undefineAutoSubscription</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &eventName, const <a class="el" href="classCEGUI_1_1String.html">String</a> &action)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This undefines previously defined auto subscription. <a href="#aaccc5dcd3767b471c766f9b923caa383"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#a583730578ada8daecfe76a5ed4a1f9b7">undefineAllAutoSubscriptions</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This undefines all previously defined auto subscriptions. <a href="#a583730578ada8daecfe76a5ed4a1f9b7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#acd7a66b57d70e07fb0e20d0850aacaab">autoSubscribe</a> (<a class="el" href="classCEGUI_1_1AnimationInstance.html">AnimationInstance</a> *instance)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribes all auto subscriptions with information from given animation instance. <a href="#acd7a66b57d70e07fb0e20d0850aacaab"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#a6afd13c192cb64ae99673d97fc6fa8fb">autoUnsubscribe</a> (<a class="el" href="classCEGUI_1_1AnimationInstance.html">AnimationInstance</a> *instance)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unsubscribes all auto subscriptions with information from given animation instance. <a href="#a6afd13c192cb64ae99673d97fc6fa8fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#a798eeb82c626d1a5bdcc5ee2266c2821">savePropertyValues</a> (<a class="el" href="classCEGUI_1_1AnimationInstance.html">AnimationInstance</a> *instance)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal method, causes all properties that are used by this animation and it's affectors to be saved. <a href="#a798eeb82c626d1a5bdcc5ee2266c2821"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Animation.html#a03dfc0a1f572ee00e4b8acb145d7a12e">apply</a> (<a class="el" href="classCEGUI_1_1AnimationInstance.html">AnimationInstance</a> *instance)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Applies this <a class="el" href="classCEGUI_1_1Animation.html" title="Defines an 'animation' class.">Animation</a> definition using information from given <a class="el" href="classCEGUI_1_1AnimationInstance.html" title="Defines an 'animation instance' class.">AnimationInstance</a>. <a href="#a03dfc0a1f572ee00e4b8acb145d7a12e"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Defines an 'animation' class. </p>
<p>This is definition of <a class="el" href="classCEGUI_1_1Animation.html" title="Defines an 'animation' class.">Animation</a>. Can be reused multiple times via <a class="el" href="classCEGUI_1_1AnimationInstance.html" title="Defines an 'animation instance' class.">AnimationInstance</a> class. You can't step this class directly, you have to instantiate it via <a class="el" href="classCEGUI_1_1AnimationManager.html#ad157d5e9015e448ce6c20f635de70ec1" title="Instantiates given animation.">AnimationManager::instantiateAnimation</a>.</p>
<p><a class="el" href="classCEGUI_1_1AnimationInstance.html" title="Defines an 'animation instance' class.">AnimationInstance</a> provides means for stepping the animation and applying it to PropertySets.</p>
<dl class="user"><dt><b></b></dt><dd><a class="el" href="classCEGUI_1_1Animation.html" title="Defines an 'animation' class.">Animation</a> itself doesn't contain key frames. It is composed of Affector(s). Each <a class="el" href="classCEGUI_1_1Affector.html" title="Defines an 'affector' class.">Affector</a> affects one <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a>. So one <a class="el" href="classCEGUI_1_1Animation.html" title="Defines an 'animation' class.">Animation</a> can affect multiple properties.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classCEGUI_1_1AnimationInstance.html" title="Defines an 'animation instance' class.">AnimationInstance</a>, <a class="el" href="classCEGUI_1_1Affector.html" title="Defines an 'affector' class.">Affector</a> </dd></dl>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a555d95af529eeaf41ee643ace11e4ab8"></a><!-- doxytag: member="CEGUI::Animation::ReplayMode" ref="a555d95af529eeaf41ee643ace11e4ab8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classCEGUI_1_1Animation.html#a555d95af529eeaf41ee643ace11e4ab8">CEGUI::Animation::ReplayMode</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>enumerates possible replay modes </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a555d95af529eeaf41ee643ace11e4ab8adb37a6867f72e86848c50e9886c47e9f"></a><!-- doxytag: member="RM_Once" ref="a555d95af529eeaf41ee643ace11e4ab8adb37a6867f72e86848c50e9886c47e9f" args="" -->RM_Once</em> </td><td>
<p>plays the animation just once, then stops </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a555d95af529eeaf41ee643ace11e4ab8ab52801e810c9d4b657c718899e0211f9"></a><!-- doxytag: member="RM_Loop" ref="a555d95af529eeaf41ee643ace11e4ab8ab52801e810c9d4b657c718899e0211f9" args="" -->RM_Loop</em> </td><td>
<p>loops the animation infinitely </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a555d95af529eeaf41ee643ace11e4ab8abf06939a6441e758b7f8d595a1a472d2"></a><!-- doxytag: member="RM_Bounce" ref="a555d95af529eeaf41ee643ace11e4ab8abf06939a6441e758b7f8d595a1a472d2" args="" -->RM_Bounce</em> </td><td>
<p>infinitely plays the animation forward, when it reaches the end, it plays it backwards, etc... </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a02d16ec065672ef951ba66e9ddcc0fd2"></a><!-- doxytag: member="CEGUI::Animation::Animation" ref="a02d16ec065672ef951ba66e9ddcc0fd2" args="(const String &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEGUI::Animation::Animation </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>internal constructor, please only construct animations via <a class="el" href="classCEGUI_1_1AnimationManager.html#ae12d15454c1ea9cb91f14ea3d68b6b40" title="Creates a new Animation definition.">AnimationManager::createAnimation</a> method </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a03dfc0a1f572ee00e4b8acb145d7a12e"></a><!-- doxytag: member="CEGUI::Animation::apply" ref="a03dfc0a1f572ee00e4b8acb145d7a12e" args="(AnimationInstance *instance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Animation::apply </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1AnimationInstance.html">AnimationInstance</a> * </td>
<td class="paramname"><em>instance</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Applies this <a class="el" href="classCEGUI_1_1Animation.html" title="Defines an 'animation' class.">Animation</a> definition using information from given <a class="el" href="classCEGUI_1_1AnimationInstance.html" title="Defines an 'animation instance' class.">AnimationInstance</a>. </p>
<dl class="user"><dt><b></b></dt><dd>This is internal method, only use if you know what you're doing! </dd></dl>
</div>
</div>
<a class="anchor" id="acd7a66b57d70e07fb0e20d0850aacaab"></a><!-- doxytag: member="CEGUI::Animation::autoSubscribe" ref="acd7a66b57d70e07fb0e20d0850aacaab" args="(AnimationInstance *instance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Animation::autoSubscribe </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1AnimationInstance.html">AnimationInstance</a> * </td>
<td class="paramname"><em>instance</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subscribes all auto subscriptions with information from given animation instance. </p>
<dl class="user"><dt><b></b></dt><dd>This is internal method! Only use if you know what you're doing! </dd></dl>
</div>
</div>
<a class="anchor" id="a6afd13c192cb64ae99673d97fc6fa8fb"></a><!-- doxytag: member="CEGUI::Animation::autoUnsubscribe" ref="a6afd13c192cb64ae99673d97fc6fa8fb" args="(AnimationInstance *instance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Animation::autoUnsubscribe </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1AnimationInstance.html">AnimationInstance</a> * </td>
<td class="paramname"><em>instance</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unsubscribes all auto subscriptions with information from given animation instance. </p>
<dl class="user"><dt><b></b></dt><dd>This is internal method! Only use if you know what you're doing! </dd></dl>
</div>
</div>
<a class="anchor" id="a4d9bcccc63b027d2a0626a186464d847"></a><!-- doxytag: member="CEGUI::Animation::createAffector" ref="a4d9bcccc63b027d2a0626a186464d847" args="(const String &targetProperty, const String &interpolator)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Affector.html">Affector</a>* CEGUI::Animation::createAffector </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>targetProperty</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>interpolator</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new <a class="el" href="classCEGUI_1_1Affector.html" title="Defines an 'affector' class.">Affector</a>. </p>
<dl class="user"><dt><b></b></dt><dd>This is just a helper, finger saving method. </dd></dl>
</div>
</div>
<a class="anchor" id="a411b7ed50ed9c1d6544db9298f0e4a64"></a><!-- doxytag: member="CEGUI::Animation::createAffector" ref="a411b7ed50ed9c1d6544db9298f0e4a64" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Affector.html">Affector</a>* CEGUI::Animation::createAffector </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new <a class="el" href="classCEGUI_1_1Affector.html" title="Defines an 'affector' class.">Affector</a>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classCEGUI_1_1Affector.html" title="Defines an 'affector' class.">Affector</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a066db84b652c4fa062c08ee7504d8446"></a><!-- doxytag: member="CEGUI::Animation::defineAutoSubscription" ref="a066db84b652c4fa062c08ee7504d8446" args="(const String &eventName, const String &action)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Animation::defineAutoSubscription </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>eventName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>action</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This defined a new auto subscription. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">eventName</td><td>the name of the event we want to subscribe to, CEGUI::Window::EventClicked for example</td></tr>
<tr><td class="paramname">action</td><td>is the action that will be invoked on the animation instance if this event is fired</td></tr>
</table>
</dd>
</dl>
<dl class="user"><dt><b></b></dt><dd>Auto Subscription does subscribe to event sender (usually target window) of <a class="el" href="classCEGUI_1_1Animation.html" title="Defines an 'animation' class.">Animation</a> Instance when the event source is set.</dd></dl>
<p>Usable action strings:</p>
<ul>
<li>Start</li>
<li>Stop</li>
<li>Pause</li>
<li>Unpause</li>
<li>TogglePause</li>
</ul>
<p>eventName is the name of the event we want to subscribe to </p>
</div>
</div>
<a class="anchor" id="a3b40803cc10e56a1a391bcc070ed9816"></a><!-- doxytag: member="CEGUI::Animation::getAutoStart" ref="a3b40803cc10e56a1a391bcc070ed9816" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::Animation::getAutoStart </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves auto start. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classCEGUI_1_1Animation.html#aa5e4c041c3f042ce54fad18a1657287a" title="Sets whether this animation auto starts or not.">Animation::setAutoStart</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a798eeb82c626d1a5bdcc5ee2266c2821"></a><!-- doxytag: member="CEGUI::Animation::savePropertyValues" ref="a798eeb82c626d1a5bdcc5ee2266c2821" args="(AnimationInstance *instance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Animation::savePropertyValues </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1AnimationInstance.html">AnimationInstance</a> * </td>
<td class="paramname"><em>instance</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Internal method, causes all properties that are used by this animation and it's affectors to be saved. </p>
<dl class="user"><dt><b></b></dt><dd>So their values are still known after they've been affected. </dd></dl>
</div>
</div>
<a class="anchor" id="aa5e4c041c3f042ce54fad18a1657287a"></a><!-- doxytag: member="CEGUI::Animation::setAutoStart" ref="aa5e4c041c3f042ce54fad18a1657287a" args="(bool autoStart)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Animation::setAutoStart </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>autoStart</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets whether this animation auto starts or not. </p>
<dl class="user"><dt><b></b></dt><dd>Auto start means that the animation instances of this definition call Start on themselves once their target is set. </dd></dl>
</div>
</div>
<a class="anchor" id="a583730578ada8daecfe76a5ed4a1f9b7"></a><!-- doxytag: member="CEGUI::Animation::undefineAllAutoSubscriptions" ref="a583730578ada8daecfe76a5ed4a1f9b7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Animation::undefineAllAutoSubscriptions </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This undefines all previously defined auto subscriptions. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classCEGUI_1_1Animation.html#a066db84b652c4fa062c08ee7504d8446" title="This defined a new auto subscription.">Animation::defineAutoSubscription</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aaccc5dcd3767b471c766f9b923caa383"></a><!-- doxytag: member="CEGUI::Animation::undefineAutoSubscription" ref="aaccc5dcd3767b471c766f9b923caa383" args="(const String &eventName, const String &action)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Animation::undefineAutoSubscription </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>eventName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>action</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This undefines previously defined auto subscription. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classCEGUI_1_1Animation.html#a066db84b652c4fa062c08ee7504d8446" title="This defined a new auto subscription.">Animation::defineAutoSubscription</a> </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:40 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
