Game::SettingComponent Class Reference

Represents an GUI editor of parameter. More...

#include <SettingComponent.h>

Inheritance diagram for Game::SettingComponent:

Collaboration diagram for Game::SettingComponent:

Public Member Functions
	SettingComponent (Phosphorus::IBaseParameter *parameter)
void	ProvideActions (ActionRegistry &registry) override=0
	Provides own actions to the ActionRegistry.
void	Draw (DrawContext &context) override=0
	Draws self.
template<typename T>
T *	As ()
	Returns casted parameter to T.
bool	IsSelectable () const override
	Returns value indicating, whether component is selectable.
Public Member Functions inherited from Andromenda::Component
bool	UpdateState ()
	Checks whether component is dirty, if yes then returns true and sets dirty state to false, else returns false.
void	SetActive (bool active)
	Sets m_IsActive to given state.
Box	GetBounds ()
	Returns Component bounds. Position is already aligned.
void	SetPosition (const Int2 &position)
	Sets position to given.

Public Attributes
Phosphorus::IBaseParameter *	Parameter
	Edited parameter.

Protected Member Functions
WideString	RedactSettingName ()
Protected Member Functions inherited from Andromenda::Component
int32	getCenteredX ()
	Returns X aligned to the center.
void	markAsDirty ()
	Sets m_Dirty to true.

Additional Inherited Members
Protected Attributes inherited from Andromenda::Component
bool	m_IsActive = false
	A value indicating, whether object is being pointed by pointer.
std::atomic< bool >	m_Dirty = false
	A value indicating, whether object is dirty.
String	m_Id = ""
	Object identifier, that is unique per ComponentRegistry.
ComponentCallback	m_Callback
	Action component callback.
Surface *	m_OwnerSurface = nullptr
	Owning surface.
Int2	m_Position
	Component position.

Detailed Description

Represents an GUI editor of parameter.

Member Function Documentation

Draw()

void Game::SettingComponent::Draw ( DrawContext & context )

overridepure virtual

Draws self.

Implements Andromenda::Component.

Implemented in Game::BooleanComponent, and Game::EnumComponent.

IsSelectable()

bool Game::SettingComponent::IsSelectable ( ) const

inlineoverridevirtual

Returns value indicating, whether component is selectable.

Implements Andromenda::Component.

ProvideActions()

void Game::SettingComponent::ProvideActions ( ActionRegistry & registry )

overridepure virtual

Provides own actions to the ActionRegistry.

Implements Andromenda::Component.

Implemented in Game::BooleanComponent, and Game::EnumComponent.

---

The documentation for this class was generated from the following file:

• game/Screens/Settings/SettingComponent.h