Animation Class Reference

The base animation class. More...

#include <jmAnimationCommon.h>

Inherited by FrameAnimation, and TimelineAnimation.

Public Member Functions
AnimationKind	GetKind ()
	Returns the kind of this animation. More...
SourceSprite *	GetSourceSprite ()
	Returns the source sprite to which this animation belongs. More...
std::string	GetName ()
	Returns the name of this animation. More...
AnimationBaseParameters &	GetBaseParameters ()
	Returns a reference to the base parameters of this animation. More...
std::vector< Parameter > &	GetParameters ()
	Returns a reference to the vector of stored parameters in this animation. More...
int	GetDataFlags ()
	Returns the dataFlags factor of this frame animation. More...
int	GetDuration ()
	Returns duration of this animation in milliseconds. This is duration of one loop. More...

Protected Member Functions
virtual	~Animation ()
	Destructor. More...

Detailed Description

The base animation class.

This class stores animation data and parameters as they were created in JugiMap Editor.

Constructor & Destructor Documentation

~Animation()

virtual ~Animation ( )

inlineprotectedvirtual

Destructor.

Member Function Documentation

GetKind()

AnimationKind GetKind ( )

inline

Returns the kind of this animation.

GetSourceSprite()

SourceSprite* GetSourceSprite ( )

inline

Returns the source sprite to which this animation belongs.

GetName()

std::string GetName ( )

inline

Returns the name of this animation.

GetBaseParameters()

AnimationBaseParameters& GetBaseParameters ( )

inline

Returns a reference to the base parameters of this animation.

GetParameters()

std::vector<Parameter>& GetParameters ( )

inline

Returns a reference to the vector of stored parameters in this animation.

GetDataFlags()

int GetDataFlags ( )

inline

Returns the dataFlags factor of this frame animation.

GetDuration()

int GetDuration ( )

inline

Returns duration of this animation in milliseconds. This is duration of one loop.

---

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

• C:/Development/JugiMapProject/JugiMapFRM/framework_c++/jugimap/jmAnimationCommon.h
• C:/Development/JugiMapProject/JugiMapFRM/framework_c++/jugimap/jmAnimationCommon.cpp