TDME2 1.9.121
Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
GUIEffect Class Referenceabstract

GUI effect base class. More...

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

Inheritance diagram for GUIEffect:
Inheritance graph
Collaboration diagram for GUIEffect:
Collaboration graph

Public Types

enum  EffectType { EFFECTTYPE_NONE , EFFECTTYPE_COLOR , EFFECTTYPE_POSITION }
 

Public Member Functions

 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 Attributes

static constexpr int REPEAT_UNLIMITED { -1 }
 

Protected Attributes

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 effect base class.

Author
Andreas Drewke
Version
$Id$

Definition at line 22 of file GUIEffect.h.

Member Enumeration Documentation

◆ EffectType

enum EffectType
Enumerator
EFFECTTYPE_NONE 
EFFECTTYPE_COLOR 
EFFECTTYPE_POSITION 

Definition at line 25 of file GUIEffect.h.

Constructor & Destructor Documentation

◆ GUIEffect()

GUIEffect ( EffectType  type,
GUINode *  guiNode 
)

Public constructor.

Parameters
typetype
GUINodeGUI node

Definition at line 15 of file GUIEffect.cpp.

◆ ~GUIEffect()

~GUIEffect ( )
virtual

Destructor.

Definition at line 19 of file GUIEffect.cpp.

Member Function Documentation

◆ apply()

virtual void apply ( GUIRenderer *  guiRenderer)
pure virtual

Apply effect.

Parameters
guiRendererGUI renderer
guiNodeGUI node

Implemented in GUIColorEffect, and GUIPositionEffect.

◆ getAction()

Action * getAction ( ) const
inline
Returns
action to be performed on effect end

Definition at line 137 of file GUIEffect.h.

◆ getRepeat()

int getRepeat ( ) const
inline
Returns
repeat count or -1 for unlimited repeating

Definition at line 92 of file GUIEffect.h.

◆ getTimeTotal()

float getTimeTotal ( ) const
inline
Returns
time total

Definition at line 77 of file GUIEffect.h.

◆ getType()

EffectType getType ( ) const
inline
Returns
type

Definition at line 63 of file GUIEffect.h.

◆ isActive()

bool isActive ( ) const
inline
Returns
active

Definition at line 70 of file GUIEffect.h.

◆ isPersistant()

float isPersistant ( ) const
inline
Returns
if this effect is persistant, means if duration is reached this effect will still remain until removal

Definition at line 122 of file GUIEffect.h.

◆ isYoyo()

float isYoyo ( ) const
inline
Returns
yoyo

Definition at line 107 of file GUIEffect.h.

◆ setAction()

void setAction ( Action *  action)
inline

Set action to be performed on effect end.

Parameters
actionaction

Definition at line 145 of file GUIEffect.h.

◆ setPersistant()

void setPersistant ( bool  persistant)
inline

Set persistant, means if duration is reached this effect will still remain until removal.

Parameters
persistantpersistant

Definition at line 130 of file GUIEffect.h.

◆ setRepeat()

void setRepeat ( int  repeat)
inline

Set repeat count or -1 for unlimited repeating.

Parameters
repeatrepeat

Definition at line 100 of file GUIEffect.h.

◆ setTimeTotal()

void setTimeTotal ( float  timeTotal)
inline

Set time total.

Parameters
timeTotaltime total

Definition at line 85 of file GUIEffect.h.

◆ setYoyo()

void setYoyo ( bool  yoyo)
inline

Set yoyo.

Parameters
yoyoyoyo

Definition at line 115 of file GUIEffect.h.

◆ start()

void start ( )
virtual

Start this effect.

Definition at line 23 of file GUIEffect.cpp.

◆ stop()

void stop ( )
virtual

Stop this effect.

Definition at line 35 of file GUIEffect.cpp.

◆ update()

bool update ( GUIRenderer *  guiRenderer)
virtual

Updates the effect to GUI renderer and updates time.

Parameters
guiRenderergui renderer
Returns
if action should be called

Definition at line 40 of file GUIEffect.cpp.

Member Data Documentation

◆ action

Action* action { nullptr }
protected

Definition at line 40 of file GUIEffect.h.

◆ active

bool active { false }
protected

Definition at line 30 of file GUIEffect.h.

◆ endState

GUIEffectState endState
protected

Definition at line 45 of file GUIEffect.h.

◆ node

GUINode* node { nullptr }
protected

Definition at line 41 of file GUIEffect.h.

◆ originalEndState

GUIEffectState originalEndState
protected

Definition at line 43 of file GUIEffect.h.

◆ originalStartState

GUIEffectState originalStartState
protected

Definition at line 42 of file GUIEffect.h.

◆ persistant

bool persistant { false }
protected

Definition at line 39 of file GUIEffect.h.

◆ repeat

int repeat { 0 }
protected

Definition at line 35 of file GUIEffect.h.

◆ REPEAT_UNLIMITED

constexpr int REPEAT_UNLIMITED { -1 }
staticconstexpr

Definition at line 26 of file GUIEffect.h.

◆ repeatLeft

int repeatLeft { 0 }
protected

Definition at line 36 of file GUIEffect.h.

◆ startState

GUIEffectState startState
protected

Definition at line 44 of file GUIEffect.h.

◆ timeLast

int64_t timeLast { -1LL }
protected

Definition at line 31 of file GUIEffect.h.

◆ timeLeft

float timeLeft { 0.0 }
protected

Definition at line 33 of file GUIEffect.h.

◆ timePassed

float timePassed { 0.0 }
protected

Definition at line 34 of file GUIEffect.h.

◆ timeTotal

float timeTotal { 0.0 }
protected

Definition at line 32 of file GUIEffect.h.

◆ type

EffectType type { EFFECTTYPE_NONE }
protected

Definition at line 29 of file GUIEffect.h.

◆ yoyo

bool yoyo { false }
protected

Definition at line 37 of file GUIEffect.h.

◆ yoyoLeft

int yoyoLeft { 0 }
protected

Definition at line 38 of file GUIEffect.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.3