stmm-games-doc  0.32.0
Classes | Public Member Functions | List of all members
stmg::StopModifier Class Reference

Tells the theme to stop drawing. More...

Inheritance diagram for stmg::StopModifier:
Inheritance graph
[legend]

Classes

struct  Init
 

Public Member Functions

 StopModifier (Init &&oInit) noexcept
 Constructor. More...
 
FLOW_CONTROL drawTile (const Cairo::RefPtr< Cairo::Context > &refCc, StdThemeDrawingContext &oDc, const Tile &oTile, int32_t nPlayer, const std::vector< double > &aAniElapsed) noexcept override
 Draw tile (with player skin). More...
 
- Public Member Functions inherited from stmg::StdThemeModifier
virtual ~StdThemeModifier () noexcept=default
 
virtual void registerTileSize (int32_t nW, int32_t nH) noexcept
 Register tile size. More...
 
virtual void unregisterTileSize (int32_t nW, int32_t nH) noexcept
 Unregister tile size. More...
 
int32_t getDebugTag () const noexcept
 The debug tag. More...
 

Additional Inherited Members

- Public Types inherited from stmg::StdThemeModifier
enum  FLOW_CONTROL { FLOW_CONTROL_CONTINUE = 0, FLOW_CONTROL_STOP = 1 }
 
- Protected Member Functions inherited from stmg::StdThemeModifier
 StdThemeModifier (Init &&oInit) noexcept
 Constructor. More...
 
StdThemeowner () noexcept
 The theme. More...
 
const StdThemeowner () const noexcept
 The theme. More...
 

Detailed Description

Tells the theme to stop drawing.

Constructor & Destructor Documentation

◆ StopModifier()

stmg::StopModifier::StopModifier ( Init &&  oInit)
explicitnoexcept

Constructor.

Parameters
oInitThe initialization data.

Member Function Documentation

◆ drawTile()

FLOW_CONTROL stmg::StopModifier::drawTile ( const Cairo::RefPtr< Cairo::Context > &  refCc,
StdThemeDrawingContext oDc,
const Tile oTile,
int32_t  nPlayer,
const std::vector< double > &  aAniElapsed 
)
overridevirtualnoexcept

Draw tile (with player skin).

Parameters
refCcThe cairo context. Cannot be null.
oDcThe theme drawing context. Cannot be null.
oTileThe tile to draw.
nPlayerThe player the tile "belongs" to. -1 means no player. Must be >= -1.
aAniElapsedThe tile animations current value.
Returns
Whether the caller should continue or stop painting.

Implements stmg::StdThemeModifier.