IMS2  Pre-Alpha
An Orbiter add-on to allow on-runtime construction of spacecraft from predefined modules
TrackingAnimationStatusEvent Class Reference

Event that carries the current status of a tracking animation. More...

Inheritance diagram for TrackingAnimationStatusEvent:
AnimationEvent_Base Event_Base

Public Member Functions

 TrackingAnimationStatusEvent (string animationid, OBJHANDLE trackingtarget, TRACKINGANIMATIONSTATUS _status)
 
OBJHANDLE GetTrackingTarget ()
 
TRACKINGANIMATIONSTATUS GetStatus ()
 
- 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)
 
EventHandlerGetCaller ()
 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 ()
 

Private Attributes

OBJHANDLE target
 Stores the target the animation is currently tracking.
 
TRACKINGANIMATIONSTATUS status
 stores the current tracking status of the animation
 

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

Event that carries the current status of a tracking animation.

This event is triggered by a tracking animation for every frame the animation is running.

See also
EventHandler.h
Todo:
add current pointing vector of the animation to the information carried by this event

Constructor & Destructor Documentation

TrackingAnimationStatusEvent::TrackingAnimationStatusEvent ( string  animationid,
OBJHANDLE  trackingtarget,
TRACKINGANIMATIONSTATUS  _status 
)
inline
Parameters
animationidIdentifier of the animation sending the event
trackingtargetThe objhandle of the object to track
_statusThe current status of the tracking animation

Member Function Documentation

TRACKINGANIMATIONSTATUS TrackingAnimationStatusEvent::GetStatus ( )
inline
Returns
The current status of the animation
OBJHANDLE TrackingAnimationStatusEvent::GetTrackingTarget ( )
inline
Returns
Handle to the target the animation is currently tracking

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