Crazy Eddie's GUI System
0.8.7
|
29 #ifndef _CEGUIAnimationInstance_h_
30 #define _CEGUIAnimationInstance_h_
32 #include "CEGUI/EventArgs.h"
33 #include "CEGUI/Event.h"
38 # pragma warning(push)
39 # pragma warning(disable : 4251)
252 void start(
bool skipNextStep =
true);
393 void onAnimationStarted();
395 void onAnimationStopped();
397 void onAnimationPaused();
399 void onAnimationUnpaused();
402 void onAnimationEnded();
404 void onAnimationLooped();
426 bool d_bounceBackwards;
432 float d_maxStepDeltaSkip;
434 float d_maxStepDeltaClamp;
436 bool d_autoSteppingEnabled;
438 typedef std::map<String, String, std::less<String>
443 PropertyValueMap d_savedPropertyValues;
448 ConnectionTracker d_autoConnections;
453 #if defined(_MSC_VER)
454 # pragma warning(pop)
457 #endif // end of guard _CEGUIAnimationInstance_h_
AnimationInstance * instance
pointer to a AnimationInstance object of relevance to the event.
Definition: AnimationInstance.h:56
void unpause(bool skipNextStep=true)
Unpauses this animation instance - allows it to step forward again.
void setTarget(PropertySet *target)
Sets the target property set - this class will get it's properties affected by the Affectors!
Animation * getDefinition() const
Retrieves the animation definition that is used in this instance.
void pause()
Pauses this animation instance - stops it from stepping forward.
float getMaxStepDeltaSkip() const
Gets the max delta before step skipping occurs.
bool handleUnpause(const CEGUI::EventArgs &e)
handler that unpauses the animation instance
static const String EventAnimationStarted
fired when animation instance starts
Definition: AnimationInstance.h:82
Defines an 'animation instance' class.
Definition: AnimationInstance.h:75
static const String EventAnimationStopped
fired when animation instance stops
Definition: AnimationInstance.h:84
bool handleStart(const CEGUI::EventArgs &e)
handler that starts the animation instance
void setEventReceiver(EventSet *receiver)
Sets event receiver - this class will receive events when something happens to the playback of this a...
bool handleStop(const CEGUI::EventArgs &e)
handler that stops the animation instance
void setSpeed(float speed)
Sets playback speed - you can speed up / slow down individual instances of the same animation....
void setMaxStepDeltaSkip(float maxDelta)
Sets the max delta before step skipping occurs.
EventArgs based class that holds information about which animation instnace fired given event.
Definition: AnimationInstance.h:52
void savePropertyValue(const String &propertyName)
Internal method, saves given property (called before it's affected)
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
Interface providing event signaling and handling.
Definition: EventSet.h:167
void purgeSavedPropertyValues(void)
void setMaxStepDeltaClamp(float maxDelta)
Sets the max delta before step clamping occurs.
Interface providing introspection capabilities.
Definition: PropertySet.h:108
Definition: MemoryAllocatedObject.h:110
bool getSkipNextStep() const
Returns true if the next step is going to be skipped.
float getMaxStepDeltaClamp() const
Gets the max delta before step clamping occurs.
void setSkipNextStep(bool skip)
Controls whether the next time step is skipped.
void setPosition(float position)
Sets playback position. Has to be higher or equal to 0.0 and lower or equal to Animation definition's...
bool isAutoSteppingEnabled() const
Checks whether auto stepping is enabled.
static const String EventNamespace
Definition: AnimationInstance.h:79
void addAutoConnection(Event::Connection conn)
Internal method, adds reference to created auto connection.
static const String EventAnimationPaused
fired when animation instance pauses
Definition: AnimationInstance.h:86
EventSet * getEventSender() const
Retrieves the event sender.
static const String EventAnimationEnded
fired when animation instance ends
Definition: AnimationInstance.h:90
void step(float delta)
Steps the animation forward by the given delta.
void setEventSender(EventSet *sender)
Sets event sender - this class will send events and can affect this animation instance if there are a...
float getSpeed() const
Retrieves current playback speed.
void setAutoSteppingEnabled(bool enabled)
Controls whether auto stepping is enabled.
bool handleTogglePause(const CEGUI::EventArgs &e)
handler that toggles pause on this animation instance
void unsubscribeAutoConnections()
Internal method, unsubscribes auto connections.
An abstract base class providing common functionality and specifying the required interface for deriv...
Definition: Window.h:151
PropertySet * getTarget() const
Retrieves the target property set.
void apply()
Applies this animation instance.
void togglePause(bool skipNextStep=true)
Pauses the animation if it's running and unpauses it if it isn't.
const String & getSavedPropertyValue(const String &propertyName)
String class used within the GUI system.
Definition: String.h:64
Defines an 'animation' class.
Definition: Animation.h:65
float getPosition() const
Retrieves current playback position.
void stop()
Stops this animation instance - sets position to 0.0 and pauses.
void setTargetWindow(Window *target)
Helper method, sets given window as target property set, event receiver and event set.
static const String EventAnimationUnpaused
fired when animation instance unpauses
Definition: AnimationInstance.h:88
EventSet * getEventReceiver() const
Retrieves the event receiver.
AnimationInstance(Animation *definition)
internal constructor, please use AnimationManager::instantiateAnimation
bool handlePause(const CEGUI::EventArgs &e)
handler that pauses the animation instance
bool isRunning() const
Returns true if this animation instance is currently unpaused, if it is stepping forward.
void start(bool skipNextStep=true)
Starts this animation instance - sets position to 0.0 and unpauses.
static const String EventAnimationLooped
fired when animation instance loops
Definition: AnimationInstance.h:92
Base class used as the argument to all subscribers Event object.
Definition: EventArgs.h:51