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
|
<!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::KeyFrame 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_1KeyFrame.html">KeyFrame</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::KeyFrame Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::KeyFrame" -->
<p>Defines a 'key frame' class.
<a href="classCEGUI_1_1KeyFrame.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::KeyFrame:</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_1KeyFrame__coll__graph.gif" border="0" usemap="#CEGUI_1_1KeyFrame_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1KeyFrame_coll__map" id="CEGUI_1_1KeyFrame_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="5,5,112,35"/><area shape="rect" id="node4" href="classCEGUI_1_1Affector.html" title="Defines an 'affector' class." alt="" coords="167,104,284,133"/><area shape="rect" id="node6" href="classCEGUI_1_1Interpolator.html" title="Defines a 'interpolator' class." alt="" coords="156,5,295,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1KeyFrame-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_1KeyFrame.html#aacff632581029102c1ff485266ff7977">Progression</a> { <a class="el" href="classCEGUI_1_1KeyFrame.html#aacff632581029102c1ff485266ff7977a02fa7c9d2fc993e47a673acd54304f23">P_Linear</a>,
<a class="el" href="classCEGUI_1_1KeyFrame.html#aacff632581029102c1ff485266ff7977aa391a1f653a0ab111747c3ffcc3810fc">P_QuadraticAccelerating</a>,
<a class="el" href="classCEGUI_1_1KeyFrame.html#aacff632581029102c1ff485266ff7977a0dab15d410be846e4152a30599912d86">P_QuadraticDecelerating</a>,
<a class="el" href="classCEGUI_1_1KeyFrame.html#aacff632581029102c1ff485266ff7977a250005c4eca85e544bfb8be7f4277968">P_Discrete</a>
}</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"><a class="anchor" id="ad174d23d7d81598301340f4f98b42038"></a><!-- doxytag: member="CEGUI::KeyFrame::KeyFrame" ref="ad174d23d7d81598301340f4f98b42038" args="(Affector *parent, float position)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1KeyFrame.html#ad174d23d7d81598301340f4f98b42038">KeyFrame</a> (<a class="el" href="classCEGUI_1_1Affector.html">Affector</a> *parent, float position)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">internal constructor, please use <a class="el" href="classCEGUI_1_1Affector.html#a59f739a5d48b110d654e150394775b9d" title="Creates a KeyFrame at given position.">Affector::createKeyFrame</a> <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a11fae7201beb9210c243deae6d62add3"></a><!-- doxytag: member="CEGUI::KeyFrame::~KeyFrame" ref="a11fae7201beb9210c243deae6d62add3" args="(void)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1KeyFrame.html#a11fae7201beb9210c243deae6d62add3">~KeyFrame</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">internal destructor, please use <a class="el" href="classCEGUI_1_1Affector.html#a8364bb107e99a72301e9dc8a16ada8f1" title="Destroys given keyframe.">Affector::destroyKeyFrame</a> <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae7f2a7905d31d789d540550eb401740b"></a><!-- doxytag: member="CEGUI::KeyFrame::getParent" ref="ae7f2a7905d31d789d540550eb401740b" args="() const " -->
<a class="el" href="classCEGUI_1_1Affector.html">Affector</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1KeyFrame.html#ae7f2a7905d31d789d540550eb401740b">getParent</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves parent <a class="el" href="classCEGUI_1_1Affector.html" title="Defines an 'affector' class.">Affector</a> of this <a class="el" href="structCEGUI_1_1Key.html" title="struct to give scope to scan code enumeration.">Key</a> Frame. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a34908fe9fa6295b8c0f1eccc49f3f3d8"></a><!-- doxytag: member="CEGUI::KeyFrame::moveToPosition" ref="a34908fe9fa6295b8c0f1eccc49f3f3d8" args="(float newPosition)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1KeyFrame.html#a34908fe9fa6295b8c0f1eccc49f3f3d8">moveToPosition</a> (float newPosition)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Moves this keyframe to a new given position. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a07e2666f77651fe77486a8e0f18cfe15"></a><!-- doxytag: member="CEGUI::KeyFrame::getPosition" ref="a07e2666f77651fe77486a8e0f18cfe15" args="() const " -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1KeyFrame.html#a07e2666f77651fe77486a8e0f18cfe15">getPosition</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves position of this key frame in the animation (in seconds) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1KeyFrame.html#a3cadb32e821783741ffbb4ffba92c7b1">setValue</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the value of this key frame. <a href="#a3cadb32e821783741ffbb4ffba92c7b1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab518d8355da8009d8a294b5704730b16"></a><!-- doxytag: member="CEGUI::KeyFrame::getValue" ref="ab518d8355da8009d8a294b5704730b16" 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_1KeyFrame.html#ab518d8355da8009d8a294b5704730b16">getValue</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves value of this key frame. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1KeyFrame.html#af0f3969c8c3d4b09b2f3f854e4c1c268">setSourceProperty</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &sourceProperty)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the source property of this key frame. <a href="#af0f3969c8c3d4b09b2f3f854e4c1c268"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abcfa22f1012b5ae3c58c370d64c7d14d"></a><!-- doxytag: member="CEGUI::KeyFrame::getSourceProperty" ref="abcfa22f1012b5ae3c58c370d64c7d14d" 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_1KeyFrame.html#abcfa22f1012b5ae3c58c370d64c7d14d">getSourceProperty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the source property of this key frame. <br/></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_1KeyFrame.html#a853f80eaf88c6c089b68eb469bac7431">getValueForAnimation</a> (<a class="el" href="classCEGUI_1_1AnimationInstance.html">AnimationInstance</a> *instance) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves value of this for use when animating. <a href="#a853f80eaf88c6c089b68eb469bac7431"></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_1KeyFrame.html#a51fa50911567aa280015dce01d67f665">setProgression</a> (<a class="el" href="classCEGUI_1_1KeyFrame.html#aacff632581029102c1ff485266ff7977">Progression</a> p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the progression method of this key frame. <a href="#a51fa50911567aa280015dce01d67f665"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a654d346e652b86fa172a47cb57130ab0"></a><!-- doxytag: member="CEGUI::KeyFrame::getProgression" ref="a654d346e652b86fa172a47cb57130ab0" args="() const " -->
<a class="el" href="classCEGUI_1_1KeyFrame.html#aacff632581029102c1ff485266ff7977">Progression</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1KeyFrame.html#a654d346e652b86fa172a47cb57130ab0">getProgression</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves progression method of this key frame. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4c8876bc646c5760bbe892ceea329f3a"></a><!-- doxytag: member="CEGUI::KeyFrame::alterInterpolationPosition" ref="a4c8876bc646c5760bbe892ceea329f3a" args="(float position)" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1KeyFrame.html#a4c8876bc646c5760bbe892ceea329f3a">alterInterpolationPosition</a> (float position)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal method, alters interpolation position based on progression method. Don't use unless you know what you're doing! <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23a3647c0c066f94e4c65acc0b2b7670"></a><!-- doxytag: member="CEGUI::KeyFrame::savePropertyValue" ref="a23a3647c0c066f94e4c65acc0b2b7670" args="(AnimationInstance *instance)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1KeyFrame.html#a23a3647c0c066f94e4c65acc0b2b7670">savePropertyValue</a> (<a class="el" href="classCEGUI_1_1AnimationInstance.html">AnimationInstance</a> *instance)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal method, if this keyframe is using source property, this saves it's value to given instance 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_1KeyFrame.html#aac50692771732190e467f285c456323a">notifyPositionChanged</a> (float newPosition)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">internal method, notifies this keyframe that it has been moved <a href="#aac50692771732190e467f285c456323a"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Defines a 'key frame' class. </p>
<p><a class="el" href="structCEGUI_1_1Key.html" title="struct to give scope to scan code enumeration.">Key</a> frames are defined inside Affectors. The values they hold are used when animation is precisely at the key frame's position. If it's between two key frames, the value is interpolated.</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><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="aacff632581029102c1ff485266ff7977"></a><!-- doxytag: member="CEGUI::KeyFrame::Progression" ref="aacff632581029102c1ff485266ff7977" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classCEGUI_1_1KeyFrame.html#aacff632581029102c1ff485266ff7977">CEGUI::KeyFrame::Progression</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>enumerates possible progression methods, IE how the value progresses TOWARS this key frames, this means that progression method of the first key frame won't be used for anything! </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="aacff632581029102c1ff485266ff7977a02fa7c9d2fc993e47a673acd54304f23"></a><!-- doxytag: member="P_Linear" ref="aacff632581029102c1ff485266ff7977a02fa7c9d2fc993e47a673acd54304f23" args="" -->P_Linear</em> </td><td>
<p>linear progression </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aacff632581029102c1ff485266ff7977aa391a1f653a0ab111747c3ffcc3810fc"></a><!-- doxytag: member="P_QuadraticAccelerating" ref="aacff632581029102c1ff485266ff7977aa391a1f653a0ab111747c3ffcc3810fc" args="" -->P_QuadraticAccelerating</em> </td><td>
<p>progress is accelerated, starts slow and speeds up </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aacff632581029102c1ff485266ff7977a0dab15d410be846e4152a30599912d86"></a><!-- doxytag: member="P_QuadraticDecelerating" ref="aacff632581029102c1ff485266ff7977a0dab15d410be846e4152a30599912d86" args="" -->P_QuadraticDecelerating</em> </td><td>
<p>progress is decelerated, starts fast and slows down </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aacff632581029102c1ff485266ff7977a250005c4eca85e544bfb8be7f4277968"></a><!-- doxytag: member="P_Discrete" ref="aacff632581029102c1ff485266ff7977a250005c4eca85e544bfb8be7f4277968" args="" -->P_Discrete</em> </td><td>
<p>left neighbour's value is picked if interpolation position is lower than 1.0, right is only picked when interpolation position is exactly 1.0 </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a853f80eaf88c6c089b68eb469bac7431"></a><!-- doxytag: member="CEGUI::KeyFrame::getValueForAnimation" ref="a853f80eaf88c6c089b68eb469bac7431" args="(AnimationInstance *instance) const " -->
<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::KeyFrame::getValueForAnimation </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> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves value of this for use when animating. </p>
<dl class="user"><dt><b></b></dt><dd>This is an internal method! Only use if you know what you're doing!</dd></dl>
<dl class="user"><dt><b></b></dt><dd>This returns the base property value if source property is set on this keyframe, it works the same as <a class="el" href="classCEGUI_1_1KeyFrame.html#ab518d8355da8009d8a294b5704730b16" title="Retrieves value of this key frame.">getValue()</a> if source property is empty </dd></dl>
</div>
</div>
<a class="anchor" id="aac50692771732190e467f285c456323a"></a><!-- doxytag: member="CEGUI::KeyFrame::notifyPositionChanged" ref="aac50692771732190e467f285c456323a" args="(float newPosition)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::KeyFrame::notifyPositionChanged </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>newPosition</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>internal method, notifies this keyframe that it has been moved </p>
<dl class="user"><dt><b></b></dt><dd>DO NOT CALL DIRECTLY, should only be used by <a class="el" href="classCEGUI_1_1Affector.html" title="Defines an 'affector' class.">Affector</a> class</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classCEGUI_1_1KeyFrame.html#a34908fe9fa6295b8c0f1eccc49f3f3d8" title="Moves this keyframe to a new given position.">KeyFrame::moveToPosition</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a51fa50911567aa280015dce01d67f665"></a><!-- doxytag: member="CEGUI::KeyFrame::setProgression" ref="a51fa50911567aa280015dce01d67f665" args="(Progression p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::KeyFrame::setProgression </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1KeyFrame.html#aacff632581029102c1ff485266ff7977">Progression</a> </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the progression method of this key frame. </p>
<dl class="user"><dt><b></b></dt><dd>This controls how the animation will progress TOWARDS this key frame, whether it will be a linear motion, accelerated, decelerated, etc...</dd></dl>
<p>That means that the progression of the first key frame is never used!</p>
<p>Please see <a class="el" href="classCEGUI_1_1KeyFrame.html#aacff632581029102c1ff485266ff7977">KeyFrame::Progression</a> </p>
</div>
</div>
<a class="anchor" id="af0f3969c8c3d4b09b2f3f854e4c1c268"></a><!-- doxytag: member="CEGUI::KeyFrame::setSourceProperty" ref="af0f3969c8c3d4b09b2f3f854e4c1c268" args="(const String &sourceProperty)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::KeyFrame::setSourceProperty </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>sourceProperty</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the source property of this key frame. </p>
<dl class="user"><dt><b></b></dt><dd><a class="el" href="structCEGUI_1_1Key.html" title="struct to give scope to scan code enumeration.">Key</a> frame can get it's value from 2 places, it's either stored inside it (setValue, getValue methods) or it's linked to a property (setSourcePropery, getSourceProperty).</dd></dl>
<p>The decision about what value is used is simple, if there is a source property (sourceProperty is not empty, it's used) </p>
</div>
</div>
<a class="anchor" id="a3cadb32e821783741ffbb4ffba92c7b1"></a><!-- doxytag: member="CEGUI::KeyFrame::setValue" ref="a3cadb32e821783741ffbb4ffba92c7b1" args="(const String &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::KeyFrame::setValue </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the value of this key frame. </p>
<dl class="user"><dt><b></b></dt><dd>This is only used if source property is empty!</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classCEGUI_1_1KeyFrame.html#af0f3969c8c3d4b09b2f3f854e4c1c268" title="Sets the source property of this key frame.">KeyFrame::setSourceProperty</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>
|
