The widget that displays the level show area or a mate's subshow area. More...

Inheritance diagram for stmg::LevelShowWidget:

Classes
struct	Init

struct	LocalInit

Public Member Functions
double	getWidth () const noexcept
	The shown width in tiles. More...

double	getHeight () const noexcept
	The shown height in tiles. More...

double	getTopMarginInTiles () const noexcept
	The top margin in tiles. More...

double	getBottomMarginInTiles () const noexcept
	The bottom margin in tiles. More...

double	getLeftMarginInTiles () const noexcept
	The left margin in tiles. More...

double	getRightMarginInTiles () const noexcept
	The right margin in tiles. More...

bool	isInteractive () const noexcept
	Whether the widget should receive events of type stmi::XYEvent. More...

bool	isSubshow () const noexcept
	Whether the widget displays the level's show area or mate's subshow area. More...

void	handleXYInput (const shared_ptr< stmi::Event > &refXYEvent, int32_t nTeam, int32_t nMate) noexcept
	Sends an input event generated into the widget to a player. More...

	LevelShowWidget (Init &&oInit) noexcept
	Constructor. More...

void	dump (int32_t nIndentSpaces, bool bHeader) const noexcept override
	Writes object contents to std::cout. More...

Public Member Functions inherited from stmg::GameWidget
virtual	~GameWidget () noexcept=default

int32_t	getViewWidgetNameIdx () const noexcept
	The type (name) that might be used to choose a ThemeWidget. More...

const std::string &	getName () const noexcept
	The name of the widget. More...

int32_t	getTeam () const noexcept
	The team the widget is assigned to. More...

int32_t	getMate () const noexcept
	The mate the widget is assigned to. More...

WidgetAxisFit	getWidgetHorizAxisFit (int32_t nLayoutConfig) const noexcept
	Widget alignment and expansion for the x axis. More...

WidgetAxisFit	getWidgetVertAxisFit (int32_t nLayoutConfig) const noexcept
	Widget alignment and expansion for the y axis. More...

bool	isAssignedToHuman () const noexcept
	Tells whether the widget is assigned to a human. More...

ContainerWidget *	getContainer () const noexcept
	The container to which this widget was added to. More...

void	dump (int32_t nIndentSpaces) const noexcept
	Writes object contents to std::cout (header included). More...

void	dump () const noexcept
	Writes object contents to std::cout (header included). More...

Protected Member Functions
void	reInit (Init &&oInit) noexcept
	Reinitialization. More...

void	onAddedToGame () noexcept override
	Signals widget was added to game. More...

Protected Member Functions inherited from stmg::GameWidget
	GameWidget (Init &&oData) noexcept
	Constructor. More...

void	reInit (Init &&oData) noexcept
	Reinitialization. More...

Layout &	layout () noexcept
	The layout the widget belongs to. More...

const Layout &	layout () const noexcept
	The layout the widget belongs to. More...

GameProxy &	game () noexcept
	The game the widget belongs to. More...

const GameProxy &	game () const noexcept
	The game the widget belongs to. More...

virtual void	onAddedToLayout () noexcept
	Signals widget was added to layout. More...

Detailed Description

The widget that displays the level show area or a mate's subshow area.

Constructor & Destructor Documentation

◆ LevelShowWidget()

stmg::LevelShowWidget::LevelShowWidget ( Init && oInit )

explicitnoexcept

Constructor.

oInit.m_nLevel must be >=0.

Parameters

oInit The initialization data.

Member Function Documentation

◆ dump()

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

overridevirtualnoexcept

Writes object contents to std::cout.

Should only do it in debug mode. The function is also exposed in release mode because it is virtual.

If bHeader is true this function should also output the type of the object and its address.

Parameters

nIndentSpaces	Number of spaces put in front of each output line.
bHeader	Whether the header of the object should be displayed.

Reimplemented from stmg::GameWidget.

◆ getBottomMarginInTiles()

double stmg::LevelShowWidget::getBottomMarginInTiles ( ) const

inlinenoexcept

The bottom margin in tiles.

Returns: The bottom margin in tiles.

◆ getHeight()

double stmg::LevelShowWidget::getHeight ( ) const

noexcept

The shown height in tiles.

Margins excluded.

Returns: The height in tiles.

◆ getLeftMarginInTiles()

double stmg::LevelShowWidget::getLeftMarginInTiles ( ) const

inlinenoexcept

The left margin in tiles.

Returns: The left margin in tiles.

◆ getRightMarginInTiles()

double stmg::LevelShowWidget::getRightMarginInTiles ( ) const

inlinenoexcept

The right margin in tiles.

Returns: The right margin in tiles.

◆ getTopMarginInTiles()

double stmg::LevelShowWidget::getTopMarginInTiles ( ) const

inlinenoexcept

The top margin in tiles.

Returns: The top margin in tiles.

◆ getWidth()

double stmg::LevelShowWidget::getWidth ( ) const

noexcept

The shown width in tiles.

Margins excluded.

Returns: The width in tiles.

◆ handleXYInput()

void stmg::LevelShowWidget::handleXYInput	(	const shared_ptr< stmi::Event > &	refXYEvent,
		int32_t	nTeam,
		int32_t	nMate
	)

inlinenoexcept

Sends an input event generated into the widget to a player.

The input event can also be generated outside of the widget's rectangle. The event's x and y are in tiles, not pixels!

Parameters

refXYEvent	The event generated in the view. Cannot be null.
nTeam	The team of the player. Must be `>=0`.
nMate	The mate number of the player. Must be `>=0`.

◆ isInteractive()

bool stmg::LevelShowWidget::isInteractive ( ) const

inlinenoexcept

Whether the widget should receive events of type stmi::XYEvent.

Returns: Whether interactive.

◆ isSubshow()

bool stmg::LevelShowWidget::isSubshow ( ) const

noexcept

Whether the widget displays the level's show area or mate's subshow area.

Returns: Whether subshow mode.

◆ onAddedToGame()

void stmg::LevelShowWidget::onAddedToGame ( )

overrideprotectedvirtualnoexcept

Signals widget was added to game.

This happens after onAddedToLayout().

Reimplemented from stmg::GameWidget.

◆ reInit()

void stmg::LevelShowWidget::reInit ( Init && oInit )

protectednoexcept

Reinitialization.

Parameters

oInit The initialization data.

Classes

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ LevelShowWidget()

Member Function Documentation

◆ dump()

◆ getBottomMarginInTiles()

◆ getHeight()

◆ getLeftMarginInTiles()

◆ getRightMarginInTiles()

◆ getTopMarginInTiles()

◆ getWidth()

◆ handleXYInput()

◆ isInteractive()

◆ isSubshow()

◆ onAddedToGame()

◆ reInit()