GlsAnimation Library  1.0.6
Provides classes and functions to support animating GL Studio objects programmatically or with script files
Public Types | Public Member Functions | List of all members
disti::GlsAnimationObserverBase Class Reference

#include <gls_animation_observer.h>

Inheritance diagram for disti::GlsAnimationObserverBase:
disti::GlsAnimationObserver

Public Types

typedef stdortr1::shared_ptr< GlsAnimationObserverBasePtr
 Alias for easier reading.
 
typedef Detail::ID ID
 Alias for easier reading.
 

Public Member Functions

 GlsAnimationObserverBase ()
 Constructor.
 
virtual ~GlsAnimationObserverBase ()
 Destructor.
 
virtual void OnStarted (ID)
 
virtual void OnUpdated (ID)
 Called when the animation updates (i.e., SetKey() is called with a new value)
 
virtual void OnCompleted (ID)
 
virtual void OnCanceled (ID)
 Called when the animation is canceled.
 

Detailed Description

Base class for all callback functors for when an animation is started, updates, or ends. Derive from this class to make a custom observer with its own state data.

Member Function Documentation

virtual void disti::GlsAnimationObserverBase::OnCompleted ( ID  )
inlinevirtual

Called when the animation completes

Note
If the looping behavior is PLAY_ONCE, the juggler calls this when the animation is done. If LOOP, the juggler calls this function each time the animation restarts. If PING_PONG, the juggler calls this function each time the animation changes direction.

Reimplemented in disti::GlsAnimationObserver.

virtual void disti::GlsAnimationObserverBase::OnStarted ( ID  )
inlinevirtual

Called when the animation starts

Note
Restarts due to looping do not trigger this callback

Reimplemented in disti::GlsAnimationObserver.


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