GUIPositionEffect Class Reference

GUI position effect. More...

#include <tdme/gui/effects/GUIPositionEffect.h>

Inheritance diagram for GUIPositionEffect:

Collaboration diagram for GUIPositionEffect:

Public Member Functions
	GUIPositionEffect (GUINode *guiNode)
	Public constructor. More...
float	getPositionX () const
void	setPositionX (float positionX)
	Set position X. More...
float	getPositionY () const
void	setPositionY (float positionY)
	Set position Y. More...
float	getStartPositionX () const
void	setStartPositionX (float positionX)
	Set start position X. More...
float	getStartPositionY () const
void	setStartPositionY (float positionY)
	Set start position Y. More...
void	apply (GUIRenderer *guiRenderer) override
	Apply effect. More...
Public Member Functions inherited from GUIEffect
	GUIEffect (EffectType type, GUINode *guiNode)
	Public constructor. More...
virtual	~GUIEffect ()
	Destructor. More...
EffectType	getType () const
bool	isActive () const
float	getTimeTotal () const
void	setTimeTotal (float timeTotal)
	Set time total. More...
int	getRepeat () const
void	setRepeat (int repeat)
	Set repeat count or -1 for unlimited repeating. More...
float	isYoyo () const
void	setYoyo (bool yoyo)
	Set yoyo. More...
float	isPersistant () const
void	setPersistant (bool persistant)
	Set persistant, means if duration is reached this effect will still remain until removal. More...
Action *	getAction () const
void	setAction (Action *action)
	Set action to be performed on effect end. More...
virtual void	start ()
	Start this effect. More...
virtual void	stop ()
	Stop this effect. More...
virtual bool	update (GUIRenderer *guiRenderer)
	Updates the effect to GUI renderer and updates time. More...
virtual void	apply (GUIRenderer *guiRenderer)=0
	Apply effect. More...

Static Public Member Functions
static void	resetEffectState (GUIEffectState *effectState)
	Reset effect state regarding position effect. More...

Additional Inherited Members
Public Types inherited from GUIEffect
enum	EffectType { EFFECTTYPE_NONE , EFFECTTYPE_COLOR , EFFECTTYPE_POSITION }
Static Public Attributes inherited from GUIEffect
static constexpr int	REPEAT_UNLIMITED { -1 }
Protected Attributes inherited from GUIEffect
EffectType	type { EFFECTTYPE_NONE }
bool	active { false }
int64_t	timeLast { -1LL }
float	timeTotal { 0.0 }
float	timeLeft { 0.0 }
float	timePassed { 0.0 }
int	repeat { 0 }
int	repeatLeft { 0 }
bool	yoyo { false }
int	yoyoLeft { 0 }
bool	persistant { false }
Action *	action { nullptr }
GUINode *	node { nullptr }
GUIEffectState	originalStartState
GUIEffectState	originalEndState
GUIEffectState	startState
GUIEffectState	endState

Detailed Description

GUI position effect.

Author

Andreas Drewke

Version

$Id$

Definition at line 20 of file GUIPositionEffect.h.

Constructor & Destructor Documentation

GUIPositionEffect()

GUIPositionEffect

(

GUINode *

guiNode

)

Public constructor.

Parameters

guiNode

GUI node

Definition at line 18 of file GUIPositionEffect.cpp.

Member Function Documentation

apply()

void apply ( GUIRenderer *  guiRenderer )

overridevirtual

Apply effect.

Parameters

guiRenderer	GUI renderer
guiNode	GUI node

Implements GUIEffect.

Definition at line 22 of file GUIPositionEffect.cpp.

getPositionX()

float getPositionX ( ) const

inline

Returns

position X

Definition at line 42 of file GUIPositionEffect.h.

getPositionY()

float getPositionY ( ) const

inline

Returns

position Y

Definition at line 57 of file GUIPositionEffect.h.

getStartPositionX()

float getStartPositionX ( ) const

inline

Returns

start position X

Definition at line 72 of file GUIPositionEffect.h.

getStartPositionY()

float getStartPositionY ( ) const

inline

Returns

start position Y

Definition at line 87 of file GUIPositionEffect.h.

resetEffectState()

static void resetEffectState ( GUIEffectState *  effectState )

inlinestatic

Reset effect state regarding position effect.

Parameters

effectState

effect state

Definition at line 28 of file GUIPositionEffect.h.

setPositionX()

void setPositionX ( float  positionX )

inline

Set position X.

Parameters

positionX

position X

Definition at line 50 of file GUIPositionEffect.h.

setPositionY()

void setPositionY ( float  positionY )

inline

Set position Y.

Parameters

positionX

position Y

Definition at line 65 of file GUIPositionEffect.h.

setStartPositionX()

void setStartPositionX ( float  positionX )

inline

Set start position X.

Parameters

positionX

start position X

Definition at line 80 of file GUIPositionEffect.h.

setStartPositionY()

void setStartPositionY ( float  positionY )

inline

Set start position Y.

Parameters

positionX

start position Y

Definition at line 95 of file GUIPositionEffect.h.

---

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

• /home/andreas/Development/drewke.net/tdme2/src/tdme/gui/effects/GUIPositionEffect.h
• /home/andreas/Development/drewke.net/tdme2/src/tdme/gui/effects/GUIPositionEffect.cpp