IMS2  Pre-Alpha
An Orbiter add-on to allow on-runtime construction of spacecraft from predefined modules
Public Member Functions | List of all members
AnimationFinishedEvent Class Reference

Notifies that an animation has finished. More...

Inheritance diagram for AnimationFinishedEvent:
AnimationEvent_Base Event_Base

Public Member Functions

 AnimationFinishedEvent (string animationid)
 
- Public Member Functions inherited from AnimationEvent_Base
 AnimationEvent_Base (EVENTTYPE type, string animationid, int _delay)
 
string GetAnimationId ()
 
virtual bool operator== (Event_Base *e)
 
- Public Member Functions inherited from Event_Base
 Event_Base (EVENTTYPE _type, unsigned int _delay=0)
 
EventHandler * GetCaller ()
 Returns the EventHandler at which this event originated.
 
virtual bool operator!= (Event_Base *e)
 
virtual bool operator== (EVENTTYPE type)
 Allows to compare an event directly to an EVENTTYPE. More...
 
EVENTPIPE GetEventPipe ()
 

Additional Inherited Members

- Protected Member Functions inherited from Event_Base
virtual bool sendMe ()
 Used to determine whether the event should be sent by the event generator. More...
 
- Protected Attributes inherited from AnimationEvent_Base
string animid
 Stores the identifier of the animation this event is aimed at.
 
- Protected Attributes inherited from Event_Base
unsigned int delay
 How many calls of ProcessEvents() on the event generator the event should be delayed.
 
EventHandler * caller
 Stores the EventHandler at which the event originated.
 
EVENTTYPE eventtype
 The type of this event.
 
EVENTPIPE pipe
 The pipe the event travels in (unless it was relayed). This is set by the EventHandler itself.
 

Detailed Description

Notifies that an animation has finished.

Triggered by the animation when it stops. The exact point of the animation stop depends on the type of animation. While Sequential animations are able to stop at any moment, Both Continuous and tracking animations will first return to their original state upon receiving a StopAnimationEvent, and will only fire this event once they are savely back where they started.

See also
StopAnimationEvent
EventHandler.h

Constructor & Destructor Documentation

AnimationFinishedEvent::AnimationFinishedEvent ( string  animationid)
inline
Parameters
animationidIdentifier of the animation that finished
The documentation for this class was generated from the following file: