CEditorObject Class Reference

#include <editor_object.h>

Inheritance diagram for CEditorObject:

Collaboration diagram for CEditorObject:

Public Member Functions
virtual	~CEditorObject ()=default
virtual void	OnInit (CEditor *pEditor)
virtual void	OnUpdate ()
virtual bool	OnInput (const IInput::CEvent &Event)
virtual void	OnRender (CUIRect View)
virtual void	OnHot ()
virtual void	OnActive ()
virtual void	OnReset ()
virtual void	OnMapLoad ()
bool	IsHot ()
void	SetHot ()
void	UnsetHot ()
bool	IsActive ()
void	SetActive ()
void	SetInactive ()
CEditor *	Editor ()
const CEditor *	Editor () const
IInput *	Input ()
IClient *	Client ()
CConfig *	Config ()
IConsole *	Console ()
IEngine *	Engine ()
IGraphics *	Graphics ()
ISound *	Sound ()
ITextRender *	TextRender ()
IStorage *	Storage ()
CUi *	Ui ()
CRenderTools *	RenderTools ()

Private Attributes
CEditor *	m_pEditor

Constructor & Destructor Documentation

~CEditorObject()

virtual CEditorObject::~CEditorObject ( )

virtualdefault

Member Function Documentation

Client()

IClient * CEditorObject::Client

(

)

Config()

CConfig * CEditorObject::Config

(

)

Console()

IConsole * CEditorObject::Console

(

)

Editor() [1/2]

CEditor * CEditorObject::Editor

(

)

Editor() [2/2]

const CEditor * CEditorObject::Editor

(

)

const

Engine()

IEngine * CEditorObject::Engine

(

)

Graphics()

IGraphics * CEditorObject::Graphics

(

)

Input()

IInput * CEditorObject::Input

(

)

IsActive()

bool CEditorObject::IsActive

(

)

IsHot()

bool CEditorObject::IsHot

(

)

OnActive()

void CEditorObject::OnActive ( )

virtual

Gets called after OnRender when the component is active.

OnHot()

void CEditorObject::OnHot ( )

virtual

Gets called after OnRender when the component is hot but not active.

OnInit()

void CEditorObject::OnInit ( CEditor *  pEditor )

virtual

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

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

OnInput()

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

virtual

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

Reimplemented in CEditorComponent, CMapSettingsBackend, and CPrompt.

OnMapLoad()

void CEditorObject::OnMapLoad ( )

virtual

Reimplemented in CMapSettingsBackend, CMapView, and CProofMode.

OnRender()

void CEditorObject::OnRender ( CUIRect  View )

virtual

Reimplemented in CPrompt, and CMapGrid.

OnReset()

void CEditorObject::OnReset ( )

virtual

Reimplemented in CMapGrid, CMapView, and CProofMode.

OnUpdate()

void CEditorObject::OnUpdate ( )

virtual

Maybe calls OnHot or OnActive.

Reimplemented in CMapSettingsBackend.

RenderTools()

CRenderTools * CEditorObject::RenderTools

(

)

SetActive()

void CEditorObject::SetActive

(

)

SetHot()

void CEditorObject::SetHot

(

)

SetInactive()

void CEditorObject::SetInactive

(

)

Sound()

ISound * CEditorObject::Sound

(

)

Storage()

IStorage * CEditorObject::Storage

(

)

TextRender()

ITextRender * CEditorObject::TextRender

(

)

Ui()

CUi * CEditorObject::Ui

(

)

UnsetHot()

void CEditorObject::UnsetHot

(

)

Member Data Documentation

m_pEditor

CEditor* CEditorObject::m_pEditor

private

---

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

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