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
|
<!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::AnimationInstance 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_1AnimationInstance.html">AnimationInstance</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::AnimationInstance Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::AnimationInstance" -->
<p>Defines an 'animation instance' class.
<a href="classCEGUI_1_1AnimationInstance.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::AnimationInstance:</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_1AnimationInstance__coll__graph.gif" border="0" usemap="#CEGUI_1_1AnimationInstance_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1AnimationInstance_coll__map" id="CEGUI_1_1AnimationInstance_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects." alt="" coords="5,5,131,35"/><area shape="rect" id="node4" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects." alt="" coords="155,5,296,35"/><area shape="rect" id="node6" href="classCEGUI_1_1Animation.html" title="Defines an 'animation' class." alt="" coords="320,5,451,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1AnimationInstance-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6883297f5dc384269957ab9ac7c7fc33"></a><!-- doxytag: member="CEGUI::AnimationInstance::AnimationInstance" ref="a6883297f5dc384269957ab9ac7c7fc33" args="(Animation *definition)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a6883297f5dc384269957ab9ac7c7fc33">AnimationInstance</a> (<a class="el" href="classCEGUI_1_1Animation.html">Animation</a> *definition)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">internal constructor, please use <a class="el" href="classCEGUI_1_1AnimationManager.html#ad157d5e9015e448ce6c20f635de70ec1" title="Instantiates given animation.">AnimationManager::instantiateAnimation</a> <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a305f0c42411708f21ce1b5893bf837b1">~AnimationInstance</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03751ef1b6173c49109630cb74b45e6c"></a><!-- doxytag: member="CEGUI::AnimationInstance::getDefinition" ref="a03751ef1b6173c49109630cb74b45e6c" args="() const " -->
<a class="el" href="classCEGUI_1_1Animation.html">Animation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a03751ef1b6173c49109630cb74b45e6c">getDefinition</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the animation definition that is used in this instance. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e3446861121dc80a5f31207bbd62f6f"></a><!-- doxytag: member="CEGUI::AnimationInstance::setTarget" ref="a3e3446861121dc80a5f31207bbd62f6f" args="(PropertySet *target)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a3e3446861121dc80a5f31207bbd62f6f">setTarget</a> (<a class="el" href="classCEGUI_1_1PropertySet.html">PropertySet</a> *target)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the target property set - this class will get it's properties affected by the Affectors! <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a02713c5f140444f24b65a3aacd23f642"></a><!-- doxytag: member="CEGUI::AnimationInstance::getTarget" ref="a02713c5f140444f24b65a3aacd23f642" args="() const " -->
<a class="el" href="classCEGUI_1_1PropertySet.html">PropertySet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a02713c5f140444f24b65a3aacd23f642">getTarget</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the target property set. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acb05fe777cb5b04fb6af95245bc44de6"></a><!-- doxytag: member="CEGUI::AnimationInstance::setEventReceiver" ref="acb05fe777cb5b04fb6af95245bc44de6" args="(EventSet *receiver)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#acb05fe777cb5b04fb6af95245bc44de6">setEventReceiver</a> (<a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> *receiver)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets event receiver - this class will receive events when something happens to the playback of this animation - it starts, stops, pauses, unpauses, ends and loops. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a34f75eadeffe4b4dd51d51ca9989d8dc"></a><!-- doxytag: member="CEGUI::AnimationInstance::getEventReceiver" ref="a34f75eadeffe4b4dd51d51ca9989d8dc" args="() const " -->
<a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a34f75eadeffe4b4dd51d51ca9989d8dc">getEventReceiver</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the event receiver. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0020e1cc6c1e2bafa219c1fd3f269c6a"></a><!-- doxytag: member="CEGUI::AnimationInstance::setEventSender" ref="a0020e1cc6c1e2bafa219c1fd3f269c6a" args="(EventSet *sender)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a0020e1cc6c1e2bafa219c1fd3f269c6a">setEventSender</a> (<a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> *sender)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets event sender - this class will send events and can affect this animation instance if there are any auto subscriptions defined in the animation definition. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72f2ac923c7b55ceabb12d9e113740db"></a><!-- doxytag: member="CEGUI::AnimationInstance::getEventSender" ref="a72f2ac923c7b55ceabb12d9e113740db" args="() const " -->
<a class="el" href="classCEGUI_1_1EventSet.html">EventSet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a72f2ac923c7b55ceabb12d9e113740db">getEventSender</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the event sender. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae662bdea35368deab7b4a58d9b2225d1"></a><!-- doxytag: member="CEGUI::AnimationInstance::setTargetWindow" ref="ae662bdea35368deab7b4a58d9b2225d1" args="(Window *target)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#ae662bdea35368deab7b4a58d9b2225d1">setTargetWindow</a> (<a class="el" href="classCEGUI_1_1Window.html">Window</a> *target)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Helper method, sets given window as target property set, event receiver and event set. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27278ccddd551605069f508e3eeaf758"></a><!-- doxytag: member="CEGUI::AnimationInstance::setPosition" ref="a27278ccddd551605069f508e3eeaf758" args="(float position)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a27278ccddd551605069f508e3eeaf758">setPosition</a> (float position)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets playback position. Has to be higher or equal to 0.0 and lower or equal to <a class="el" href="classCEGUI_1_1Animation.html" title="Defines an 'animation' class.">Animation</a> definition's duration. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3a2866638b7f9ba665ad00a800be6ab"></a><!-- doxytag: member="CEGUI::AnimationInstance::getPosition" ref="aa3a2866638b7f9ba665ad00a800be6ab" args="() const " -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#aa3a2866638b7f9ba665ad00a800be6ab">getPosition</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves current playback position. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1328c7e681e64f2b8daa60a51003de75"></a><!-- doxytag: member="CEGUI::AnimationInstance::setSpeed" ref="a1328c7e681e64f2b8daa60a51003de75" args="(float speed)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a1328c7e681e64f2b8daa60a51003de75">setSpeed</a> (float speed)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets playback speed - you can speed up / slow down individual instances of the same animation. 1.0 means normal playback. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4fe173077a75073b7ddf7b79801d0c9a"></a><!-- doxytag: member="CEGUI::AnimationInstance::getSpeed" ref="a4fe173077a75073b7ddf7b79801d0c9a" args="() const " -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a4fe173077a75073b7ddf7b79801d0c9a">getSpeed</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves current playback speed. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aca59f5b0ec462ac15122f14f6ae5ee4a"></a><!-- doxytag: member="CEGUI::AnimationInstance::setSkipNextStep" ref="aca59f5b0ec462ac15122f14f6ae5ee4a" args="(bool skip)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#aca59f5b0ec462ac15122f14f6ae5ee4a">setSkipNextStep</a> (bool skip)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Controls whether the next time step is skipped. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a3278c3699c97a97c8f9c72ca85575280">getSkipNextStep</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the next step is *going* to be skipped. <a href="#a3278c3699c97a97c8f9c72ca85575280"></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_1AnimationInstance.html#acf9da6b6514aeebadc9908b66903202d">setMaxStepDeltaSkip</a> (float maxDelta)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the max delta before step skipping occurs. <a href="#acf9da6b6514aeebadc9908b66903202d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae847eca48decb778a4e079a423cedbf9"></a><!-- doxytag: member="CEGUI::AnimationInstance::getMaxStepDeltaSkip" ref="ae847eca48decb778a4e079a423cedbf9" args="() const " -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#ae847eca48decb778a4e079a423cedbf9">getMaxStepDeltaSkip</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the max delta before step skipping occurs. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a893605d677440c8d58b9b9a78af6c8eb">setMaxStepDeltaClamp</a> (float maxDelta)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the max delta before step clamping occurs. <a href="#a893605d677440c8d58b9b9a78af6c8eb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e1854c76a0128fdc2f6d13673a0c8fe"></a><!-- doxytag: member="CEGUI::AnimationInstance::getMaxStepDeltaClamp" ref="a3e1854c76a0128fdc2f6d13673a0c8fe" args="() const " -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a3e1854c76a0128fdc2f6d13673a0c8fe">getMaxStepDeltaClamp</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the max delta before step clamping occurs. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#ac16040faec42913eb2d9ff76331bd9c3">start</a> (bool skipNextStep=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts this animation instance - sets position to 0.0 and unpauses. <a href="#ac16040faec42913eb2d9ff76331bd9c3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ab912092e42207badd5cde3d88d7a84"></a><!-- doxytag: member="CEGUI::AnimationInstance::stop" ref="a1ab912092e42207badd5cde3d88d7a84" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a1ab912092e42207badd5cde3d88d7a84">stop</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stops this animation instance - sets position to 0.0 and pauses. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a51252b8968288d1232701ace70494bbb"></a><!-- doxytag: member="CEGUI::AnimationInstance::pause" ref="a51252b8968288d1232701ace70494bbb" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a51252b8968288d1232701ace70494bbb">pause</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pauses this animation instance - stops it from stepping forward. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#aba5a76b9f4440190a0be96ef9785da03">unpause</a> (bool skipNextStep=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unpauses this animation instance - allows it to step forward again. <a href="#aba5a76b9f4440190a0be96ef9785da03"></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_1AnimationInstance.html#a67161a2891e6a08a4cc34211a7a48440">togglePause</a> (bool skipNextStep=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pauses the animation if it's running and unpauses it if it isn't. <a href="#a67161a2891e6a08a4cc34211a7a48440"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf1384262eb3e2d23c265ee768f3f9bf"></a><!-- doxytag: member="CEGUI::AnimationInstance::isRunning" ref="abf1384262eb3e2d23c265ee768f3f9bf" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#abf1384262eb3e2d23c265ee768f3f9bf">isRunning</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this animation instance is currently unpaused, if it is stepping forward. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a916c47f87ba4e78ff75e451ad9cf49d6"></a><!-- doxytag: member="CEGUI::AnimationInstance::step" ref="a916c47f87ba4e78ff75e451ad9cf49d6" args="(float delta)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a916c47f87ba4e78ff75e451ad9cf49d6">step</a> (float delta)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal method, steps the animation forward by the given delta. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a038202fc1864069cef0435bc58ff02ed"></a><!-- doxytag: member="CEGUI::AnimationInstance::handleStart" ref="a038202fc1864069cef0435bc58ff02ed" args="(const CEGUI::EventArgs &e)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a038202fc1864069cef0435bc58ff02ed">handleStart</a> (const <a class="el" href="classCEGUI_1_1EventArgs.html">CEGUI::EventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">handler that starts the animation instance <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a49480997b8e6c563e91d7b7549e032ec"></a><!-- doxytag: member="CEGUI::AnimationInstance::handleStop" ref="a49480997b8e6c563e91d7b7549e032ec" args="(const CEGUI::EventArgs &e)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a49480997b8e6c563e91d7b7549e032ec">handleStop</a> (const <a class="el" href="classCEGUI_1_1EventArgs.html">CEGUI::EventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">handler that stops the animation instance <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a90f064e065f4437728584b7d888e8b5e"></a><!-- doxytag: member="CEGUI::AnimationInstance::handlePause" ref="a90f064e065f4437728584b7d888e8b5e" args="(const CEGUI::EventArgs &e)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a90f064e065f4437728584b7d888e8b5e">handlePause</a> (const <a class="el" href="classCEGUI_1_1EventArgs.html">CEGUI::EventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">handler that pauses the animation instance <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1a8943d81fcce85714550557cb2af70"></a><!-- doxytag: member="CEGUI::AnimationInstance::handleUnpause" ref="aa1a8943d81fcce85714550557cb2af70" args="(const CEGUI::EventArgs &e)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#aa1a8943d81fcce85714550557cb2af70">handleUnpause</a> (const <a class="el" href="classCEGUI_1_1EventArgs.html">CEGUI::EventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">handler that unpauses the animation instance <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f5fc4bc04f90c1e5ee15547bcc4d1ec"></a><!-- doxytag: member="CEGUI::AnimationInstance::handleTogglePause" ref="a4f5fc4bc04f90c1e5ee15547bcc4d1ec" args="(const CEGUI::EventArgs &e)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a4f5fc4bc04f90c1e5ee15547bcc4d1ec">handleTogglePause</a> (const <a class="el" href="classCEGUI_1_1EventArgs.html">CEGUI::EventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">handler that toggles pause on this animation instance <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4eeab47922f515345a620de16cf5c8b4"></a><!-- doxytag: member="CEGUI::AnimationInstance::savePropertyValue" ref="a4eeab47922f515345a620de16cf5c8b4" args="(const String &propertyName)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a4eeab47922f515345a620de16cf5c8b4">savePropertyValue</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &propertyName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal method, saves given property (called before it's affected) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#aeadf227bfa3d7c26ac8f5780e53af6e0">purgeSavedPropertyValues</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a1c7dfc6a92e934f6063f11c63a1b8a69">getSavedPropertyValue</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &propertyName)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#aeea6bfc45f1fd9eb4e43028c7257c036">addAutoConnection</a> (<a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> conn)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal method, adds reference to created auto connection. <a href="#aeea6bfc45f1fd9eb4e43028c7257c036"></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_1AnimationInstance.html#ad4d477fdeb44b17d24720c30b4cfff17">unsubscribeAutoConnections</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal method, unsubscribes auto connections. <a href="#ad4d477fdeb44b17d24720c30b4cfff17"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#ada34b7a0c20e56df7100ef11f44b0966">EventNamespace</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6fa75e86d3dac3372dcf7ef7e6a8645a"></a><!-- doxytag: member="CEGUI::AnimationInstance::EventAnimationStarted" ref="a6fa75e86d3dac3372dcf7ef7e6a8645a" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a6fa75e86d3dac3372dcf7ef7e6a8645a">EventAnimationStarted</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">fired when animation instance starts <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e7535006a1f6d419841b83e5d5bfc4f"></a><!-- doxytag: member="CEGUI::AnimationInstance::EventAnimationStopped" ref="a4e7535006a1f6d419841b83e5d5bfc4f" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a4e7535006a1f6d419841b83e5d5bfc4f">EventAnimationStopped</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">fired when animation instance stops <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b0ed6d75fe4d30f797a754145c5945f"></a><!-- doxytag: member="CEGUI::AnimationInstance::EventAnimationPaused" ref="a5b0ed6d75fe4d30f797a754145c5945f" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a5b0ed6d75fe4d30f797a754145c5945f">EventAnimationPaused</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">fired when animation instance pauses <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f057f367c94f4d58d80890b0625fc3a"></a><!-- doxytag: member="CEGUI::AnimationInstance::EventAnimationUnpaused" ref="a8f057f367c94f4d58d80890b0625fc3a" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#a8f057f367c94f4d58d80890b0625fc3a">EventAnimationUnpaused</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">fired when animation instance unpauses <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae84572bd4a20d10e0be7e7ea2900b251"></a><!-- doxytag: member="CEGUI::AnimationInstance::EventAnimationEnded" ref="ae84572bd4a20d10e0be7e7ea2900b251" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#ae84572bd4a20d10e0be7e7ea2900b251">EventAnimationEnded</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">fired when animation instance ends <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adee18e698612059e62ed86b5bad3b1f8"></a><!-- doxytag: member="CEGUI::AnimationInstance::EventAnimationLooped" ref="adee18e698612059e62ed86b5bad3b1f8" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1AnimationInstance.html#adee18e698612059e62ed86b5bad3b1f8">EventAnimationLooped</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">fired when animation instance loops <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Defines an 'animation instance' class. </p>
<p><a class="el" href="classCEGUI_1_1Animation.html" title="Defines an 'animation' class.">Animation</a> classes hold definition of the animation. Whilst this class holds data needed to use the animation definition - target <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">PropertySet</a>, event receiver, animation position, ...</p>
<p>You have to define animation first and then instantiate it via <a class="el" href="classCEGUI_1_1AnimationManager.html#ad157d5e9015e448ce6c20f635de70ec1" title="Instantiates given animation.">AnimationManager::instantiateAnimation</a></p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classCEGUI_1_1Animation.html" title="Defines an 'animation' class.">Animation</a> </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a305f0c42411708f21ce1b5893bf837b1"></a><!-- doxytag: member="CEGUI::AnimationInstance::~AnimationInstance" ref="a305f0c42411708f21ce1b5893bf837b1" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEGUI::AnimationInstance::~AnimationInstance </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>internal destructor, please use <a class="el" href="classCEGUI_1_1AnimationManager.html#a7558e9ba0094731a62281e237842e933" title="Destroys given animation instance.">AnimationManager::destroyAnimationInstance</a> </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aeea6bfc45f1fd9eb4e43028c7257c036"></a><!-- doxytag: member="CEGUI::AnimationInstance::addAutoConnection" ref="aeea6bfc45f1fd9eb4e43028c7257c036" args="(Event::Connection conn)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::AnimationInstance::addAutoConnection </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> </td>
<td class="paramname"><em>conn</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Internal method, adds reference to created auto connection. </p>
<dl class="user"><dt><b></b></dt><dd>DO NOT USE THIS DIRECTLY </dd></dl>
</div>
</div>
<a class="anchor" id="a1c7dfc6a92e934f6063f11c63a1b8a69"></a><!-- doxytag: member="CEGUI::AnimationInstance::getSavedPropertyValue" ref="a1c7dfc6a92e934f6063f11c63a1b8a69" args="(const String &propertyName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a>& CEGUI::AnimationInstance::getSavedPropertyValue </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>propertyName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>retrieves saved value, if it isn't cached already, it retrieves it fresh from the properties </p>
</div>
</div>
<a class="anchor" id="a3278c3699c97a97c8f9c72ca85575280"></a><!-- doxytag: member="CEGUI::AnimationInstance::getSkipNextStep" ref="a3278c3699c97a97c8f9c72ca85575280" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::AnimationInstance::getSkipNextStep </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the next step is *going* to be skipped. </p>
<dl class="user"><dt><b></b></dt><dd>If it was skipped already, this returns false as step resets it to false after it skips one step. </dd></dl>
</div>
</div>
<a class="anchor" id="aeadf227bfa3d7c26ac8f5780e53af6e0"></a><!-- doxytag: member="CEGUI::AnimationInstance::purgeSavedPropertyValues" ref="aeadf227bfa3d7c26ac8f5780e53af6e0" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::AnimationInstance::purgeSavedPropertyValues </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>this purges all saved values forcing this class to gather new ones fresh from the properties </p>
</div>
</div>
<a class="anchor" id="a893605d677440c8d58b9b9a78af6c8eb"></a><!-- doxytag: member="CEGUI::AnimationInstance::setMaxStepDeltaClamp" ref="a893605d677440c8d58b9b9a78af6c8eb" args="(float maxDelta)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::AnimationInstance::setMaxStepDeltaClamp </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>maxDelta</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the max delta before step clamping occurs. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">maxDelta</td><td>delta in seconds, if this value is reached, the step is clamped. (use -1.0f if you never want to clamp - this is the default)</td></tr>
</table>
</dd>
</dl>
<dl class="user"><dt><b></b></dt><dd>If you want to ensure the animation steps at most 1.0 / 60.0 seconds at a timem you should call setMaxStepDeltaClamp(1.0f / 60.0f). This essentially slows the animation down in case the FPS drops below 60. </dd></dl>
</div>
</div>
<a class="anchor" id="acf9da6b6514aeebadc9908b66903202d"></a><!-- doxytag: member="CEGUI::AnimationInstance::setMaxStepDeltaSkip" ref="acf9da6b6514aeebadc9908b66903202d" args="(float maxDelta)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::AnimationInstance::setMaxStepDeltaSkip </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>maxDelta</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the max delta before step skipping occurs. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">maxDelta</td><td>delta in seconds, if this value is reached, the step is skipped (use -1.0f if you never want to skip - this is the default)</td></tr>
</table>
</dd>
</dl>
<dl class="user"><dt><b></b></dt><dd>If you want to ensure your animation is not skipped entirely after layouts are loaded or other time consuming operations are done, use this method.</dd></dl>
<p>For example setMaxStepDeltaSkip(1.0f / 25.0f) ensures that if FPS drops below 25, the animation just stops progressing and waits till FPS raises. </p>
</div>
</div>
<a class="anchor" id="ac16040faec42913eb2d9ff76331bd9c3"></a><!-- doxytag: member="CEGUI::AnimationInstance::start" ref="ac16040faec42913eb2d9ff76331bd9c3" args="(bool skipNextStep=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::AnimationInstance::start </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>skipNextStep</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Starts this animation instance - sets position to 0.0 and unpauses. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">skipNextStep</td><td>if true the next injected time pulse is skipped</td></tr>
</table>
</dd>
</dl>
<dl class="user"><dt><b></b></dt><dd>This also causes base values to be purged! </dd></dl>
</div>
</div>
<a class="anchor" id="a67161a2891e6a08a4cc34211a7a48440"></a><!-- doxytag: member="CEGUI::AnimationInstance::togglePause" ref="a67161a2891e6a08a4cc34211a7a48440" args="(bool skipNextStep=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::AnimationInstance::togglePause </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>skipNextStep</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pauses the animation if it's running and unpauses it if it isn't. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">skipNextStep</td><td>if true the next injected time pulse is skipped (only applies when unpausing!) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aba5a76b9f4440190a0be96ef9785da03"></a><!-- doxytag: member="CEGUI::AnimationInstance::unpause" ref="aba5a76b9f4440190a0be96ef9785da03" args="(bool skipNextStep=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::AnimationInstance::unpause </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>skipNextStep</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unpauses this animation instance - allows it to step forward again. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">skipNextStep</td><td>if true the next injected time pulse is skipped </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad4d477fdeb44b17d24720c30b4cfff17"></a><!-- doxytag: member="CEGUI::AnimationInstance::unsubscribeAutoConnections" ref="ad4d477fdeb44b17d24720c30b4cfff17" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::AnimationInstance::unsubscribeAutoConnections </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Internal method, unsubscribes auto connections. </p>
<dl class="user"><dt><b></b></dt><dd>DO NOT USE THIS DIRECTLY </dd></dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ada34b7a0c20e56df7100ef11f44b0966"></a><!-- doxytag: member="CEGUI::AnimationInstance::EventNamespace" ref="ada34b7a0c20e56df7100ef11f44b0966" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a> <a class="el" href="classCEGUI_1_1AnimationInstance.html#ada34b7a0c20e56df7100ef11f44b0966">CEGUI::AnimationInstance::EventNamespace</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Namespace for animation instance events these are fired on event receiver, not this animation instance! </p>
</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>
|
