Animator Class Reference

#include <Animator.h>

Inherited by PhysicsStep.

Inheritance diagram for Animator:

Inheritance graph
[legend]
Collaboration diagram for Animator:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Animator (Object *obj, unsigned int frame)
virtual ~Animator ()
virtual bool animate (unsigned int frame)=0

Protected Attributes

ObjectmObject
 Object to animate.
unsigned int mFrame
 Frame number.

Detailed Description

Abstract base class for all object animators

Author:
Alex Busenius

Definition at line 15 of file Animator.h.


Constructor & Destructor Documentation

Animator::Animator ( Object obj,
unsigned int  frame 
) [inline]

Constructor

Parameters:
obj Object to animate
frame Frame number when animation should start

Definition at line 23 of file Animator.h.

virtual Animator::~Animator (  )  [inline, virtual]

Destructor

Definition at line 32 of file Animator.h.


Member Function Documentation

virtual bool Animator::animate ( unsigned int  frame  )  [pure virtual]

Execute animation or do nothing if no animation should be done in given frame

Parameters:
frame Current frame
Returns:
true if animation was applied

Implemented in PhysicsStep.


Member Data Documentation

Object* Animator::mObject [protected]

Object to animate.

Definition at line 45 of file Animator.h.

Referenced by PhysicsStep::animate().

unsigned int Animator::mFrame [protected]

Frame number.

Definition at line 48 of file Animator.h.

Referenced by PhysicsStep::animate().


The documentation for this class was generated from the following file:
Generated on Fri Feb 1 00:02:11 2008 for Grayfall by  doxygen 1.5.1