Crazy Eddies GUI System  0.7.8
CEGUIKeyFrame.h
1 /***********************************************************************
2  filename: CEGUIKeyFrame.h
3  created: 7/8/2010
4  author: Martin Preisler
5 
6  purpose: Defines the interface for the KeyFrame class
7 *************************************************************************/
8 /***************************************************************************
9  * Copyright (C) 2004 - 2010 Paul D Turner & The CEGUI Development Team
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining
12  * a copy of this software and associated documentation files (the
13  * "Software"), to de/al in the Software without restriction, including
14  * without limitation the rights to use, copy, modify, merge, publish,
15  * distribute, sublicense, and/or sell copies of the Software, and to
16  * permit persons to whom the Software is furnished to do so, subject to
17  * the following conditions:
18  *
19  * The above copyright notice and this permission notice shall be
20  * included in all copies or substantial portions of the Software.
21  *
22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
25  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
26  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
27  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
28  * OTHER DEALINGS IN THE SOFTWARE.
29  ***************************************************************************/
30 #ifndef _CEGUIKeyFrame_h_
31 #define _CEGUIKeyFrame_h_
32 
33 #include "CEGUIString.h"
34 
35 // Start of CEGUI namespace section
36 namespace CEGUI
37 {
38 
50 class CEGUIEXPORT KeyFrame
51 {
52 public:
57  {
68  P_Discrete
69  };
70 
72  KeyFrame(Affector* parent, float position);
73 
75  ~KeyFrame(void);
76 
81  Affector* getParent() const;
82 
87  void moveToPosition(float newPosition);
88 
93  float getPosition() const;
94 
105  void setValue(const String& value);
106 
111  const String& getValue() const;
112 
125  void setSourceProperty(const String& sourceProperty);
126 
131  const String& getSourceProperty() const;
132 
144  const String& getValueForAnimation(AnimationInstance* instance) const;
145 
158  void setProgression(Progression p);
159 
164  Progression getProgression() const;
165 
171  float alterInterpolationPosition(float position);
172 
178  void savePropertyValue(AnimationInstance* instance);
179 
190  void notifyPositionChanged(float newPosition);
191 
192 private:
194  Affector* d_parent;
196  float d_position;
197 
199  String d_value;
201  String d_sourceProperty;
203  Progression d_progression;
204 };
205 
206 } // End of CEGUI namespace section
207 
208 #endif // end of guard _CEGUIKeyFrame_h_
209