stmm-games-doc  0.32.0
Functions
stmg::Helpers Namespace Reference

Functions

NRect boardInsertRemove (const NRect &oRect, Direction::VALUE eDir) noexcept
 The remove rectangle of a Level::boardInsert(). More...
 
NRect boardInsertMovingPre (const NRect &oRect, Direction::VALUE eDir) noexcept
 The moved rectangle of a Level::boardInsert() before the move. More...
 
NRect boardInsertMovingPost (const NRect &oRect, Direction::VALUE eDir) noexcept
 The moved rectangle of a Level::boardInsert() after the move. More...
 
NRect boardInsertAdd (const NRect &oRect, Direction::VALUE eDir) noexcept
 The add rectangle of a Level::boardInsert(). More...
 
NRect boardInsertInAreaRemove (const NRect &oRect, Direction::VALUE eDir, const NRect &oArea) noexcept
 The remove rectangle of a Level::boardInsert() within a delimiting area. More...
 
NRect boardInsertInAreaMovingPre (const NRect &oRect, Direction::VALUE eDir, const NRect &oArea) noexcept
 The moved rectangle of a Level::boardInsert() before the move within a delimiting area. More...
 
NRect boardInsertInAreaMovingPost (const NRect &oRect, Direction::VALUE eDir, const NRect &oArea) noexcept
 The moved rectangle of a Level::boardInsert() after the move within a delimiting area. More...
 
NRect boardInsertInAreaAdd (const NRect &oRect, Direction::VALUE eDir, const NRect &oArea) noexcept
 The add rectangle of a Level::boardInsert() within a delimiting area. More...
 
NRect boardScrollRemove (NSize oBoardSize, Direction::VALUE eDir) noexcept
 The remove rectangle of a Level::boardScroll(). More...
 
NRect boardScrollMovingPre (NSize oBoardSize, Direction::VALUE eDir) noexcept
 The moved rectangle of a Level::boardScroll() before the move. More...
 
NRect boardScrollMovingPost (NSize oBoardSize, Direction::VALUE eDir) noexcept
 The moved rectangle of a Level::boardScroll() after the move. More...
 
NRect boardScrollAdd (NSize oBoardSize, Direction::VALUE eDir) noexcept
 The add rectangle of a Level::boardScroll(). More...
 

Function Documentation

◆ boardInsertAdd()

NRect stmg::Helpers::boardInsertAdd ( const NRect oRect,
Direction::VALUE  eDir 
)
noexcept

The add rectangle of a Level::boardInsert().

Parameters
oRectThe insert rectangle.
eDirThe direction.
Returns
The rectangle.

◆ boardInsertInAreaAdd()

NRect stmg::Helpers::boardInsertInAreaAdd ( const NRect oRect,
Direction::VALUE  eDir,
const NRect oArea 
)
noexcept

The add rectangle of a Level::boardInsert() within a delimiting area.

Parameters
oRectThe insert rectangle.
eDirThe direction.
oAreaThe delimiting area.
Returns
The rectangle.

◆ boardInsertInAreaMovingPost()

NRect stmg::Helpers::boardInsertInAreaMovingPost ( const NRect oRect,
Direction::VALUE  eDir,
const NRect oArea 
)
noexcept

The moved rectangle of a Level::boardInsert() after the move within a delimiting area.

Parameters
oRectThe insert rectangle.
eDirThe direction.
oAreaThe delimiting area.
Returns
The rectangle.

◆ boardInsertInAreaMovingPre()

NRect stmg::Helpers::boardInsertInAreaMovingPre ( const NRect oRect,
Direction::VALUE  eDir,
const NRect oArea 
)
noexcept

The moved rectangle of a Level::boardInsert() before the move within a delimiting area.

Parameters
oRectThe insert rectangle.
eDirThe The direction.
oAreaThe delimiting area.
Returns
The rectangle.

◆ boardInsertInAreaRemove()

NRect stmg::Helpers::boardInsertInAreaRemove ( const NRect oRect,
Direction::VALUE  eDir,
const NRect oArea 
)
noexcept

The remove rectangle of a Level::boardInsert() within a delimiting area.

Parameters
oRectThe insert rectangle.
eDirThe direction.
oAreaThe delimiting area.
Returns
The rectangle.

◆ boardInsertMovingPost()

NRect stmg::Helpers::boardInsertMovingPost ( const NRect oRect,
Direction::VALUE  eDir 
)
noexcept

The moved rectangle of a Level::boardInsert() after the move.

Parameters
oRectThe insert rectangle.
eDirThe direction.
Returns
The rectangle.

◆ boardInsertMovingPre()

NRect stmg::Helpers::boardInsertMovingPre ( const NRect oRect,
Direction::VALUE  eDir 
)
noexcept

The moved rectangle of a Level::boardInsert() before the move.

Parameters
oRectThe insert rectangle.
eDirThe The direction.
Returns
The rectangle.

◆ boardInsertRemove()

NRect stmg::Helpers::boardInsertRemove ( const NRect oRect,
Direction::VALUE  eDir 
)
noexcept

The remove rectangle of a Level::boardInsert().

Parameters
oRectThe insert rectangle.
eDirThe direction.
Returns
The rectangle.

◆ boardScrollAdd()

NRect stmg::Helpers::boardScrollAdd ( NSize  oBoardSize,
Direction::VALUE  eDir 
)
inlinenoexcept

The add rectangle of a Level::boardScroll().

Parameters
oBoardSizeThe board size
eDirThe direction.
Returns
The rectangle.

◆ boardScrollMovingPost()

NRect stmg::Helpers::boardScrollMovingPost ( NSize  oBoardSize,
Direction::VALUE  eDir 
)
inlinenoexcept

The moved rectangle of a Level::boardScroll() after the move.

Parameters
oBoardSizeThe board size
eDirThe direction.
Returns
The rectangle.

◆ boardScrollMovingPre()

NRect stmg::Helpers::boardScrollMovingPre ( NSize  oBoardSize,
Direction::VALUE  eDir 
)
inlinenoexcept

The moved rectangle of a Level::boardScroll() before the move.

Parameters
oBoardSizeThe board size
eDirThe direction.
Returns
The rectangle.

◆ boardScrollRemove()

NRect stmg::Helpers::boardScrollRemove ( NSize  oBoardSize,
Direction::VALUE  eDir 
)
inlinenoexcept

The remove rectangle of a Level::boardScroll().

Parameters
oBoardSizeThe board size
eDirThe direction.
Returns
The rectangle.