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

Base event for all animation related events. No intended to be used directly. More...

Inheritance diagram for AnimationEvent_Base:
Event_Base AnimationFailedEvent AnimationFinishedEvent AnimationStartedEvent ModifyAnimationEvent SetAnimationStateEvent StartAnimationEvent StopAnimationEvent TrackingAnimationStatusEvent

Public Member Functions

 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 ()
 

Protected Attributes

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.
 

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...
 

Detailed Description

Base event for all animation related events. No intended to be used directly.

Animation events are special in that they carry the id of the animation they are aimed at. Animations will not listen to events that are not specifically addressed at them.

Constructor & Destructor Documentation

AnimationEvent_Base::AnimationEvent_Base ( EVENTTYPE  type,
string  animationid,
int  _delay 
)
inline
Parameters
animationidThe string identifier of the animation the event is aimed at
typeThe event type fo the event
_delayHow many frames the event should be delayed

Member Function Documentation

string AnimationEvent_Base::GetAnimationId ( )
inline
Returns
The string identifer of the animation this event is aimed at
virtual bool AnimationEvent_Base::operator== ( Event_Base *  e)
inlinevirtual
Parameters
eThe event to compare this event to
Returns
True if the if this and e have the same event type and are aimed at the same animation, false otherwise

Reimplemented from Event_Base.

The documentation for this class was generated from the following file: