stmm-games-doc  0.32.0
Public Member Functions | Static Public Member Functions | List of all members
stmg::TileRect Class Referenceabstract
Inheritance diagram for stmg::TileRect:
Inheritance graph
[legend]

Public Member Functions

virtual ~TileRect () noexcept=default
 
virtual int32_t getW () const noexcept=0
 The width in tiles. More...
 
virtual int32_t getH () const noexcept=0
 The height in tiles. More...
 
virtual const Tileget (NPoint oXY) const noexcept=0
 The tile at a certain position. More...
 

Static Public Member Functions

static bool isAllEmptyTiles (const TileRect &oTiles) noexcept
 Whether an instance has all empty tiles. More...
 

Constructor & Destructor Documentation

◆ ~TileRect()

virtual stmg::TileRect::~TileRect ( )
virtualdefaultnoexcept

Member Function Documentation

◆ get()

virtual const Tile& stmg::TileRect::get ( NPoint  oXY) const
pure virtualnoexcept

The tile at a certain position.

Parameters
oXYThe position. Must be >= 0 and oXY.m_nX < getW() and oXY.m_nY < getH().
Returns
The tile.

Implemented in stmg::TileBuffer.

◆ getH()

virtual int32_t stmg::TileRect::getH ( ) const
pure virtualnoexcept

The height in tiles.

Returns
The height. Must be >= 0.

Implemented in stmg::TileBuffer.

◆ getW()

virtual int32_t stmg::TileRect::getW ( ) const
pure virtualnoexcept

The width in tiles.

Returns
The width. Must be >= 0.

Implemented in stmg::TileBuffer.

◆ isAllEmptyTiles()

static bool stmg::TileRect::isAllEmptyTiles ( const TileRect oTiles)
staticnoexcept

Whether an instance has all empty tiles.

Parameters
oTilesThe tile rect.
Returns
Whether all empty.