ControlBarSchemeAnimation Class Reference

#include <ControlBarScheme.h>

Public Types
enum	{ CB_ANIM_SLIDE_RIGHT = 0 , CB_ANIM_MAX }

Public Member Functions
	ControlBarSchemeAnimation (void)
	~ControlBarSchemeAnimation (void)
UnsignedInt	getCurrentFrame (void)
void	setCurrentFrame (UnsignedInt currentFrame)
ICoord2D	getStartPos (void)
void	setStartPos (ICoord2D startPos)

Public Attributes
AsciiString	m_name
	Current animation name.
Int	m_animType
	Type of animation that this will follow.
ControlBarSchemeImage *	m_animImage
	Pointer of the image that this animation will act on.
UnsignedInt	m_animDuration
	Contians how long the animation should take based off game frames.
ICoord2D	m_finalPos
	The final position when we hit the m_animDuration frame.

Detailed Description

Definition at line 94 of file ControlBarScheme.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enum that will contain all the kinds of animations we have... make sure in ControlBarScheme.cpp there's a mapping for it for the INI translation

Enumerator
CB_ANIM_SLIDE_RIGHT
CB_ANIM_MAX

Definition at line 101 of file ControlBarScheme.h.

Constructor & Destructor Documentation

ControlBarSchemeAnimation()

ControlBarSchemeAnimation::ControlBarSchemeAnimation

(

void

)

Definition at line 194 of file ControlBarScheme.cpp.

~ControlBarSchemeAnimation()

ControlBarSchemeAnimation::~ControlBarSchemeAnimation

(

void

)

Definition at line 210 of file ControlBarScheme.cpp.

Member Function Documentation

getCurrentFrame()

UnsignedInt ControlBarSchemeAnimation::getCurrentFrame ( void )

inline

Definition at line 114 of file ControlBarScheme.h.

getStartPos()

ICoord2D ControlBarSchemeAnimation::getStartPos ( void )

inline

Definition at line 116 of file ControlBarScheme.h.

setCurrentFrame()

void ControlBarSchemeAnimation::setCurrentFrame ( UnsignedInt currentFrame )

inline

Definition at line 115 of file ControlBarScheme.h.

setStartPos()

void ControlBarSchemeAnimation::setStartPos ( ICoord2D startPos )

inline

Definition at line 117 of file ControlBarScheme.h.

Member Data Documentation

m_animDuration

UnsignedInt ControlBarSchemeAnimation::m_animDuration

Contians how long the animation should take based off game frames.

Definition at line 111 of file ControlBarScheme.h.

m_animImage

ControlBarSchemeImage* ControlBarSchemeAnimation::m_animImage

Pointer of the image that this animation will act on.

Definition at line 110 of file ControlBarScheme.h.

m_animType

Int ControlBarSchemeAnimation::m_animType

Type of animation that this will follow.

Definition at line 109 of file ControlBarScheme.h.

m_finalPos

ICoord2D ControlBarSchemeAnimation::m_finalPos

The final position when we hit the m_animDuration frame.

Definition at line 112 of file ControlBarScheme.h.

m_name

AsciiString ControlBarSchemeAnimation::m_name

Current animation name.

Definition at line 108 of file ControlBarScheme.h.

---

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

• Code/GameEngine/Include/GameClient/ControlBarScheme.h
• Code/GameEngine/Source/GameClient/GUI/ControlBar/ControlBarScheme.cpp