IMS2  Pre-Alpha
An Orbiter add-on to allow on-runtime construction of spacecraft from predefined modules
StartTrackingAnimationEvent Class Reference
Inheritance diagram for StartTrackingAnimationEvent:
StartAnimationEvent AnimationEvent_Base Event_Base

Public Member Functions

 StartTrackingAnimationEvent (string animationid, double _speed, OBJHANDLE trackingtarget)
 
OBJHANDLE GetTrackingTarget ()
 
- Public Member Functions inherited from StartAnimationEvent
 StartAnimationEvent (string animationid, double _speed)
 
double GetSpeed ()
 
- 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 handle to the target the animation should be tracking.
 

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 StartAnimationEvent
double speed
 An abstract property for how fast the animation should play, and in which direction. 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

Notifies a tracking animation to start tracking, and which target

Triggers AnimationStartedEvent or AnimationFailedEvent in response, and after that TrackingStatusAnimationEvent() for every frame the animation is running. Indistinguishable from StartAnimationEvent if aimed at a non-tracking animation.

See also
AnimationStartedEvent
AnimationFailedEvent
TrackingAnimationStatusEvent
EventHandler.h

Constructor & Destructor Documentation

StartTrackingAnimationEvent::StartTrackingAnimationEvent ( string  animationid,
double  _speed,
OBJHANDLE  trackingtarget 
)
inline
Parameters
animationidIdentifier of the tracking animation the event is aimed at.
_speedThe speed at which the animation should track
trackingtargetHandle of the object to track
Note
The speed of a tracking animation does not determine its direction. The animation will choose the direction itself.

Member Function Documentation

OBJHANDLE StartTrackingAnimationEvent::GetTrackingTarget ( )
inline
Returns
Handle to the object the animation should track

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