ProtoZed  awesome branch
A simple but powerful game framework
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
PZ::AnimationBase Class Referenceabstract
Inheritance diagram for PZ::AnimationBase:
PZ::AnimationGroup PZ::Tween

Public Types

enum  State {
  NOT_STARTED, STARTED, RUNNING, PAUSED,
  STOPPED, FINISHED
}
 

Public Member Functions

 AnimationBase (AnimationManager &animationManager)
 
 AnimationBase (AnimationProperties *properties, AnimationManager &animationManager)
 
virtual ~AnimationBase ()
 
void Start (Animable &animable)
 
void Stop ()
 
void Pause (bool pause=true)
 
void Resume ()
 
bool IsPaused () const
 
virtual AnimationBaseGetCopy ()=0
 
void SetStartCallback (AnimationCallback &callback)
 
void SetFinishedCallback (AnimationCallback &callback)
 
AnimableGetAnimable ()
 
State GetState () const
 
virtual void AddTime (float deltaTime)=0
 

Protected Member Functions

virtual bool StartImpl ()=0
 
AnimationManagerGetAnimationManager () const
 

Protected Attributes

Animableobject
 
State state
 
AnimationCallback onStart
 
AnimationCallback onFinished
 

Friends

class Animable
 
class AnimationGroup
 

Member Enumeration Documentation

Enumerator:
NOT_STARTED 
STARTED 
RUNNING 
PAUSED 
STOPPED 
FINISHED 

Constructor & Destructor Documentation

PZ::AnimationBase::AnimationBase ( AnimationManager animationManager)
PZ::AnimationBase::AnimationBase ( AnimationProperties properties,
AnimationManager animationManager 
)
virtual PZ::AnimationBase::~AnimationBase ( )
virtual

Member Function Documentation

virtual void PZ::AnimationBase::AddTime ( float  deltaTime)
pure virtual

Implemented in PZ::Tween, and PZ::AnimationGroup.

Animable& PZ::AnimationBase::GetAnimable ( )
inline
AnimationManager& PZ::AnimationBase::GetAnimationManager ( ) const
inlineprotected
virtual AnimationBase* PZ::AnimationBase::GetCopy ( )
pure virtual

Implemented in PZ::Tween, and PZ::AnimationGroup.

State PZ::AnimationBase::GetState ( ) const
inline
bool PZ::AnimationBase::IsPaused ( ) const
inline
void PZ::AnimationBase::Pause ( bool  pause = true)
void PZ::AnimationBase::Resume ( )
void PZ::AnimationBase::SetFinishedCallback ( AnimationCallback callback)
inline
void PZ::AnimationBase::SetStartCallback ( AnimationCallback callback)
inline
void PZ::AnimationBase::Start ( Animable animable)
virtual bool PZ::AnimationBase::StartImpl ( )
protectedpure virtual

Implemented in PZ::Tween, and PZ::AnimationGroup.

void PZ::AnimationBase::Stop ( )

Friends And Related Function Documentation

friend class Animable
friend
friend class AnimationGroup
friend

Member Data Documentation

Animable* PZ::AnimationBase::object
protected
AnimationCallback PZ::AnimationBase::onFinished
protected
AnimationCallback PZ::AnimationBase::onStart
protected
State PZ::AnimationBase::state
protected

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