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

Public Member Functions

 ColorPalTraitSet ()=delete
 
std::pair< bool, int32_t > getTraitValue (const Tile &oTile) const noexcept override
 Either the value of the tile's trait or empty. More...
 
void setTileTraitValue (Tile &oTile, int32_t nValue) const noexcept override
 Sets the tile's trait value. More...
 
void dump (int32_t nIndentSpaces, bool bHeader) const noexcept override
 Dumps the trait set. More...
 
- Public Member Functions inherited from stmg::NotEmptyIntTraitSet
 NotEmptyIntTraitSet () noexcept=delete
 
 NotEmptyIntTraitSet (int32_t nValue) noexcept
 
 NotEmptyIntTraitSet (int32_t nFromValue, int32_t nToValue) noexcept
 
 NotEmptyIntTraitSet (int32_t nFromValue, int32_t nToValue, int32_t nStep) noexcept
 
 NotEmptyIntTraitSet (const std::vector< int32_t > &aValues) noexcept
 
 NotEmptyIntTraitSet (const IntSet &oIntSet) noexcept
 
 NotEmptyIntTraitSet (IntSet &&oIntSet) noexcept
 
 NotEmptyIntTraitSet (const NotEmptyIntTraitSet &oSource) noexcept=default
 
 NotEmptyIntTraitSet (NotEmptyIntTraitSet &&oSource) noexcept=default
 
NotEmptyIntTraitSetoperator= (const NotEmptyIntTraitSet &oSource) noexcept=default
 
NotEmptyIntTraitSetoperator= (NotEmptyIntTraitSet &&oSource) noexcept=default
 
bool hasEmptyValue () const noexcept override final
 Whether the trait set contains the empty value. More...
 
int32_t getTotValues () const noexcept override final
 Get the total number of values in this tile trait indexed set. More...
 
void dump (int32_t nIndentSpaces, bool bHeader) const noexcept override
 Dumps the trait set. More...
 
- Public Member Functions inherited from stmg::IntTraitSet
bool setTileTraitValueByIndex (Tile &oTile, int32_t nIdx) const noexcept override final
 Sets the trait of a tile to the value identified by an index. More...
 
int32_t getIndexOfTileTraitValue (const Tile &oTile) const noexcept override final
 Gets the index of the value of the tile's trait in the set. More...
 
- Public Member Functions inherited from stmg::TraitSet
virtual ~TraitSet () noexcept=default
 

Additional Inherited Members

- Protected Member Functions inherited from stmg::NotEmptyIntTraitSet
void resetTileTraitValue (Tile &) const noexcept override final
 Sets the tile's trait to empty. More...
 
- Protected Member Functions inherited from stmg::IntTraitSet
 IntTraitSet () noexcept
 Constructs empty trait set. More...
 
 IntTraitSet (int32_t nValue) noexcept
 Constructs trait set with one value. More...
 
 IntTraitSet (int32_t nFromValue, int32_t nToValue) noexcept
 Constructs trait set with ordered value range. More...
 
 IntTraitSet (int32_t nFromValue, int32_t nToValue, int32_t nStep) noexcept
 Constructs trait set with ordered stepped value range. More...
 
 IntTraitSet (const std::vector< int32_t > &aValues) noexcept
 Constructs trait set with array of values. More...
 
 IntTraitSet (const IntSet &oIntSet) noexcept
 Constructs trait set from an integer set. More...
 
 IntTraitSet (IntSet &&oIntSet) noexcept
 Constructs trait set from an integer set. More...
 
 IntTraitSet (const IntTraitSet &oSource) noexcept=default
 
 IntTraitSet (IntTraitSet &&oSource) noexcept=default
 
IntTraitSetoperator= (const IntTraitSet &oSource) noexcept=default
 
IntTraitSetoperator= (IntTraitSet &&oSource) noexcept=default
 
bool hasValue (int32_t nValue) const noexcept
 

Constructor & Destructor Documentation

◆ ColorPalTraitSet()

stmg::ColorPalTraitSet::ColorPalTraitSet ( )
delete

Member Function Documentation

◆ dump()

void stmg::ColorPalTraitSet::dump ( int32_t  nIndentSpaces,
bool  bHeader 
) const
overridevirtualnoexcept

Dumps the trait set.

This only works if NDEBUG macro is not defined.

Implements stmg::TraitSet.

◆ getTraitValue()

std::pair<bool, int32_t> stmg::ColorPalTraitSet::getTraitValue ( const Tile oTile) const
overridevirtualnoexcept

Either the value of the tile's trait or empty.

Parameters
oTileThe tile
Returns
The pair of bool telling whether value empty and the value if not empty.

Implements stmg::IntTraitSet.

◆ setTileTraitValue()

void stmg::ColorPalTraitSet::setTileTraitValue ( Tile oTile,
int32_t  nValue 
) const
overridevirtualnoexcept

Sets the tile's trait value.

Parameters
oTileThe tile to modify.
nValueThe new value.

Implements stmg::IntTraitSet.