stmm-games-doc  0.32.0
Classes | Public Member Functions | Protected Member Functions | List of all members
stmg::TextAnimation Class Reference
Inheritance diagram for stmg::TextAnimation:
Inheritance graph
[legend]

Classes

struct  Init
 
struct  LocalInit
 

Public Member Functions

 TextAnimation (Init &&oInit) noexcept
 Constructor. More...
 
double getFontHeight () const noexcept
 
const std::vector< std::string > & getText () const noexcept
 
- Public Member Functions inherited from stmg::LevelAnimation
virtual ~LevelAnimation () noexcept=default
 
int32_t getId () const noexcept
 Returns unique Id of this object. More...
 
bool isActive () const noexcept
 Whether the animation was added to the level (and not removed yet). More...
 
int32_t getViewAnimationNameIdx () const noexcept
 The optional view animation name index. More...
 
REFSYS getRefSys () noexcept
 The reference system of the animation. More...
 
FPoint getPos () const noexcept
 The current position of the animation within its reference system. More...
 
FSize getSize () const noexcept
 The size of the animation. More...
 
int32_t getZ () const noexcept
 The depth of the animation. More...
 
double gameInterval () const noexcept
 The current game interval. More...
 
double getDuration () const noexcept
 The duration in milliseconds. More...
 
void moveTo (FPoint oPos) noexcept
 Sets new position within reference system. More...
 
void moveTo (int32_t nZ) noexcept
 Sets new position within reference system. More...
 
virtual void onScrolled (Direction::VALUE eDir) noexcept
 Called by Level when the animation is scrolled by Level::boardScroll. More...
 
double getElapsed (int32_t nViewTick, int32_t nTotViewTicks) const noexcept
 The time elapsed since the animation was started in milliseconds. More...
 
bool isStarted (int32_t nViewTick, int32_t nTotViewTicks) const noexcept
 Whether the animation has already started. More...
 
bool isDone (int32_t nViewTick, int32_t nTotViewTicks) const noexcept
 Whether the animation has finished. More...
 
Levellevel () noexcept
 The level. More...
 
const Levellevel () const noexcept
 The level. More...
 
GameProxygame () noexcept
 The game. More...
 
const GameProxygame () const noexcept
 The game. More...
 

Protected Member Functions

void reInit (Init &&oInit) noexcept
 
- Protected Member Functions inherited from stmg::LevelAnimation
 LevelAnimation (const Init &oInit) noexcept
 Constructor. More...
 
void reInit (const Init &oInit) noexcept
 Reinitialization. More...
 

Additional Inherited Members

- Public Types inherited from stmg::LevelAnimation
enum  REFSYS { REFSYS_BOARD = -3, REFSYS_SHOW = -2, REFSYS_INVALID = -1, REFSYS_SUBSHOW = 0 }
 Reference system extended enumeration. More...
 
- Static Public Attributes inherited from stmg::LevelAnimation
static const double s_fDurationUndefined
 Undefined duration constant. More...
 
static const double s_fDurationInfinity
 Infinite duration constant. More...
 

Constructor & Destructor Documentation

◆ TextAnimation()

stmg::TextAnimation::TextAnimation ( Init &&  oInit)
inlineexplicitnoexcept

Constructor.

Parameters
oInitThe initialization parameters.

Member Function Documentation

◆ getFontHeight()

double stmg::TextAnimation::getFontHeight ( ) const
inlinenoexcept

◆ getText()

const std::vector<std::string>& stmg::TextAnimation::getText ( ) const
inlinenoexcept

◆ reInit()

void stmg::TextAnimation::reInit ( Init &&  oInit)
inlineprotectednoexcept