Represents a renderable identified object. More...

#include <Component.h>

Inheritance diagram for Andromenda::Component:

[legend]

Collaboration diagram for Andromenda::Component:

[legend]

Public Member Functions
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.

void	ProvideActions (ActionRegistry &registry) override=0
	Provides own actions to the ActionRegistry.

virtual bool	IsSelectable () const =0
	Returns value indicating, whether component is selectable.

virtual void	Draw (DrawContext &context)=0
	Draws self.

Protected Member Functions
int32	getCenteredX ()
	Returns X aligned to the center.

virtual Int2	getSize ()=0
	Returns size of a component.

void	markAsDirty ()
	Sets m_Dirty to true.

Protected Attributes
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.

Friends
class	Surface

class	ComponentRegistry

Detailed Description

Represents a renderable identified object.

Member Function Documentation

◆ Draw()

virtual void Andromenda::Component::Draw ( DrawContext & context )

pure virtual

Draws self.

Implemented in Andromenda::SelectionTextComponent, Andromenda::TextComponent, Game::AsciiArtComponent, Game::BooleanComponent, Game::CardComponent, Game::EnumComponent, Game::FoundationComponent, Game::FragmentComponent, Game::SettingComponent, and Game::StockComponent.

◆ GetBounds()

Box Andromenda::Component::GetBounds ( )

Returns Component bounds. Position is already aligned.

Returns: Box

◆ getCenteredX()

int32 Andromenda::Component::getCenteredX ( )

protected

Returns X aligned to the center.

Returns: int32

◆ getSize()

virtual Int2 Andromenda::Component::getSize ( )

protectedpure virtual

Returns size of a component.

Returns: Int2

Implemented in Andromenda::SelectionTextComponent, and Andromenda::TextComponent.

◆ IsSelectable()

virtual bool Andromenda::Component::IsSelectable ( ) const

nodiscardpure virtual

Returns value indicating, whether component is selectable.

Implemented in Andromenda::SelectionTextComponent, Andromenda::TextComponent, Game::AsciiArtComponent, Game::CardComponent, Game::FoundationComponent, Game::FragmentComponent, Game::SettingComponent, and Game::StockComponent.

◆ ProvideActions()

void Andromenda::Component::ProvideActions ( ActionRegistry & registry )

overridepure virtual

Provides own actions to the ActionRegistry.

Implements Andromenda::IActionProvider.

Implemented in Andromenda::SelectionTextComponent, Andromenda::TextComponent, Game::AsciiArtComponent, Game::BooleanComponent, Game::CardComponent, Game::EnumComponent, Game::FoundationComponent, Game::FragmentComponent, Game::SettingComponent, and Game::StockComponent.

◆ SetActive()

void Andromenda::Component::SetActive ( bool active )

Sets m_IsActive to given state.

Parameters

active

◆ SetPosition()

void Andromenda::Component::SetPosition ( const Int2 & position )

Sets position to given.

Parameters

position

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

andromenda/Component.h
andromenda/Components.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends