CEditorComponent Class Reference

#include <component.h>

Inheritance diagram for CEditorComponent:

Collaboration diagram for CEditorComponent:

Public Member Functions
void	OnInit (CEditor *pEditor) override
virtual void	OnReset ()
virtual void	OnMapLoad ()
virtual bool	OnInput (const IInput::CEvent &Event)
virtual void	OnUpdate ()
virtual void	OnRender (CUIRect View)
void	InitSubComponents ()
void	RegisterSubComponent (CEditorComponent &Component)
Public Member Functions inherited from CEditorObject
virtual	~CEditorObject ()=default
CEditor *	Editor ()
const CEditor *	Editor () const
IInput *	Input ()
const IInput *	Input () const
IClient *	Client ()
const IClient *	Client () const
CConfig *	Config ()
const CConfig *	Config () const
IConsole *	Console ()
const IConsole *	Console () const
IEngine *	Engine ()
const IEngine *	Engine () const
IGraphics *	Graphics ()
const IGraphics *	Graphics () const
ISound *	Sound ()
const ISound *	Sound () const
ITextRender *	TextRender ()
const ITextRender *	TextRender () const
IStorage *	Storage ()
const IStorage *	Storage () const
CUi *	Ui ()
const CUi *	Ui () const
CRenderMap *	RenderMap ()
const CRenderMap *	RenderMap () const

Private Attributes
std::vector< std::reference_wrapper< CEditorComponent > >	m_vSubComponents = {}

Member Function Documentation

InitSubComponents()

void CEditorComponent::InitSubComponents

(

)

Initialize all registered subcomponents. Needs to be called after the interfaces have been initialized.

OnInit()

void CEditorComponent::OnInit ( CEditor *  pEditor )

overridevirtual

Initialize the component and interface pointers. Needs to be the first function that is called. The default implentation also resets the component.

Reimplemented from CEditorObject.

Reimplemented in CMapSettingsBackend, CFontTyper, CLayerSelector, CMapView, CEditorImage, CPrompt, and CProofMode.

OnInput()

bool CEditorComponent::OnInput ( const IInput::CEvent &  Event )

virtual

Gets called before OnRender. Should return true if the event was consumed.

Reimplemented in CFontTyper, and CPrompt.

OnMapLoad()

void CEditorComponent::OnMapLoad ( )

virtual

Reimplemented in CMapSettingsBackend, CMapView, and CProofMode.

OnRender()

void CEditorComponent::OnRender ( CUIRect  View )

virtual

Reimplemented in CFileBrowser, CPrompt, CFontTyper, and CMapGrid.

OnReset()

void CEditorComponent::OnReset ( )

virtual

Reimplemented in CMapGrid, CMapView, and CProofMode.

OnUpdate()

void CEditorComponent::OnUpdate ( )

virtual

RegisterSubComponent()

void CEditorComponent::RegisterSubComponent

(

CEditorComponent &

Component

)

Member Data Documentation

m_vSubComponents

std::vector<std::reference_wrapper<CEditorComponent> > CEditorComponent::m_vSubComponents = {}

private

---

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

• src/game/editor/component.h
• src/game/editor/component.cpp