MercuryTweenState Class Reference

All info for a tween state. More...

#include <MercuryObjectCommands.h>

Collaboration diagram for MercuryTweenState:

[legend]List of all members.

Public Types
enum	SPACE { CURRENT = 0, LOCAL, GLOBAL }
Public Member Functions
	MercuryTweenState ()
	MercuryTweenState (const MercuryTweenState &rhs)
MercuryTweenState &	operator= (const MercuryTweenState &rhs)
	~MercuryTweenState ()
void	AttachToObject (MercuryObject *object)
void	Update (float fDeltaTime)
void	AddCommand (MercuryTween *ToPush, float fFuture=0, SPACE iWhichPlace=CURRENT, MString sTweenName="")
	Add command to stack of commands tp perform fFutre will determine what time from NOW it is to be executed.
void	AddCommand (const MString &command, SPACE iWhichPlace=CURRENT, MString sTweenName="")
	Add command to stack of commands tp perform (tack it on the end) Place: 0 for current, 1 for local, 2 for global.
void	ExecuteCommand (const MString &sName, const PStack &pKArgs)
	Execute a pre-added command. pKArgs is where too look for parameters.
void	FinishTweening ()
	Perform all pending tweens.
void	StopTweening ()
	Dump all pending tweens.
void	PauseTweening ()
	Pause tweening in current state.
void	ResumeTweening ()
	Return tweening from paused state.
bool	IsTweeningPaused ()
	Determine if tweening is paused.
bool	IsTweening () const
Public Attributes
MercuryTween *	m_pCurrentTween
Private Member Functions
float	CalculateRemainingPercent (float fDeltaTime)
float	CalculateCurrentPercent (float fDeltaTime)
void	InternalUpdate (float fDeltaTime, bool bFinish=false)
Private Attributes
float	m_fCurTime
bool	m_bPauseTweening
float	m_fRunningEnd
MercuryObject *	m_pObject
MDeque< MercuryTween * >	m_qTweens
std::map< MString, std::vector< MercuryTween * > >	m_LocalTweens
bool	m_bCloned
Static Private Attributes
static std::map< MString, std::vector< MercuryTween * > >	m_GlobalTweens

---

Detailed Description

All info for a tween state.

Definition at line 63 of file MercuryObjectCommands.h.

---

Member Enumeration Documentation

enum MercuryTweenState::SPACE

Enumerator:

CURRENT
LOCAL
GLOBAL

Definition at line 66 of file MercuryObjectCommands.h.

---

Constructor & Destructor Documentation

MercuryTweenState::MercuryTweenState

(

)

Definition at line 239 of file MercuryObjectCommands.cpp.

MercuryTweenState::MercuryTweenState

(

const MercuryTweenState &

rhs

)

Definition at line 247 of file MercuryObjectCommands.cpp.

MercuryTweenState::~MercuryTweenState

(

)

Definition at line 273 of file MercuryObjectCommands.cpp.

---

Member Function Documentation

MercuryTweenState & MercuryTweenState::operator=

(

const MercuryTweenState &

rhs

)

Definition at line 259 of file MercuryObjectCommands.cpp.

void MercuryTweenState::AttachToObject

(

MercuryObject *

object

)

Definition at line 287 of file MercuryObjectCommands.cpp.

void MercuryTweenState::Update

(

float

fDeltaTime

)

Definition at line 292 of file MercuryObjectCommands.cpp.

void MercuryTweenState::AddCommand	(	MercuryTween *	ToPush,
		float	fFuture = 0,
		SPACE	iWhichPlace = CURRENT,
		MString	sTweenName = ""
	)

Add command to stack of commands tp perform fFutre will determine what time from NOW it is to be executed.

Definition at line 415 of file MercuryObjectCommands.cpp.

void MercuryTweenState::AddCommand	(	const MString &	command,
		SPACE	iWhichPlace = CURRENT,
		MString	sTweenName = ""
	)

Add command to stack of commands tp perform (tack it on the end) Place: 0 for current, 1 for local, 2 for global.

Definition at line 463 of file MercuryObjectCommands.cpp.

void MercuryTweenState::ExecuteCommand	(	const MString &	sName,
		const PStack &	pKArgs
	)

Execute a pre-added command. pKArgs is where too look for parameters.

Definition at line 380 of file MercuryObjectCommands.cpp.

void MercuryTweenState::FinishTweening

(

)

Perform all pending tweens.

Definition at line 300 of file MercuryObjectCommands.cpp.

void MercuryTweenState::StopTweening

(

)

Dump all pending tweens.

Definition at line 305 of file MercuryObjectCommands.cpp.

void MercuryTweenState::PauseTweening

(

)

[inline]

Pause tweening in current state.

Definition at line 94 of file MercuryObjectCommands.h.

void MercuryTweenState::ResumeTweening

(

)

[inline]

Return tweening from paused state.

Definition at line 96 of file MercuryObjectCommands.h.

bool MercuryTweenState::IsTweeningPaused

(

)

[inline]

Determine if tweening is paused.

Definition at line 98 of file MercuryObjectCommands.h.

bool MercuryTweenState::IsTweening

(

)

const [inline]

Definition at line 104 of file MercuryObjectCommands.h.

float MercuryTweenState::CalculateRemainingPercent

(

float

fDeltaTime

)

[private]

Definition at line 360 of file MercuryObjectCommands.cpp.

float MercuryTweenState::CalculateCurrentPercent

(

float

fDeltaTime

)

[private]

Definition at line 370 of file MercuryObjectCommands.cpp.

void MercuryTweenState::InternalUpdate	(	float	fDeltaTime,
		bool	bFinish = false
	)			[private]

Definition at line 317 of file MercuryObjectCommands.cpp.

---

Member Data Documentation

MercuryTween* MercuryTweenState::m_pCurrentTween

Definition at line 102 of file MercuryObjectCommands.h.

float MercuryTweenState::m_fCurTime [private]

Definition at line 110 of file MercuryObjectCommands.h.

bool MercuryTweenState::m_bPauseTweening [private]

Definition at line 111 of file MercuryObjectCommands.h.

float MercuryTweenState::m_fRunningEnd [private]

Definition at line 112 of file MercuryObjectCommands.h.

MercuryObject* MercuryTweenState::m_pObject [private]

Definition at line 114 of file MercuryObjectCommands.h.

MDeque< MercuryTween * > MercuryTweenState::m_qTweens [private]

Definition at line 115 of file MercuryObjectCommands.h.

std::map< MString, std::vector< MercuryTween * > > MercuryTweenState::m_LocalTweens [private]

Definition at line 119 of file MercuryObjectCommands.h.

map< MString, vector< MercuryTween * > > MercuryTweenState::m_GlobalTweens [static, private]

Definition at line 120 of file MercuryObjectCommands.h.

bool MercuryTweenState::m_bCloned [private]

Definition at line 121 of file MercuryObjectCommands.h.

---

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

• MercuryObjectCommands.h
• MercuryObjectCommands.cpp

---

Hosted by