Peoplemon  0.1.0
Peoplemon 3 game source documentation
Public Member Functions | Static Public Member Functions | List of all members
editor::state::MainEditor Class Reference

The primary state of the editor. Owns the GUI and all tabs. More...

#include <MainEditor.hpp>

+ Inheritance diagram for editor::state::MainEditor:

Public Member Functions

virtual ~MainEditor ()=default
 Destroy the Main Editor state. More...
 
virtual const char * name () const override
 Returns "MainEditor". More...
 
virtual void activate (bl::engine::Engine &) override
 Subscribes the gui to window events. More...
 
virtual void deactivate (bl::engine::Engine &) override
 Unsubscribes the gui from window events. More...
 
virtual void update (bl::engine::Engine &, float dt, float) override
 Updates the gui and the current page. More...
 

Static Public Member Functions

static Ptr create (core::system::Systems &systems)
 Construct a new Main Editor state. More...
 
static void registerCustomGuiComponents ()
 Registers renderer components for custom GUI elements. More...
 

Detailed Description

The primary state of the editor. Owns the GUI and all tabs.

Definition at line 35 of file MainEditor.hpp.

Constructor & Destructor Documentation

◆ ~MainEditor()

virtual editor::state::MainEditor::~MainEditor ( )
virtualdefault

Destroy the Main Editor state.

Member Function Documentation

◆ activate()

void editor::state::MainEditor::activate ( bl::engine::Engine &  engine)
overridevirtual

Subscribes the gui to window events.

Definition at line 71 of file MainEditor.cpp.

◆ create()

MainEditor::Ptr editor::state::MainEditor::create ( core::system::Systems systems)
static

Construct a new Main Editor state.

Parameters
systemsThe primary systems object

Definition at line 15 of file MainEditor.cpp.

◆ deactivate()

void editor::state::MainEditor::deactivate ( bl::engine::Engine &  engine)
overridevirtual

Unsubscribes the gui from window events.

Definition at line 78 of file MainEditor.cpp.

◆ name()

const char * editor::state::MainEditor::name ( ) const
overridevirtual

Returns "MainEditor".

Definition at line 69 of file MainEditor.cpp.

◆ registerCustomGuiComponents()

void editor::state::MainEditor::registerCustomGuiComponents ( )
static

Registers renderer components for custom GUI elements.

Definition at line 98 of file MainEditor.cpp.

◆ update()

void editor::state::MainEditor::update ( bl::engine::Engine &  ,
float  dt,
float   
)
overridevirtual

Updates the gui and the current page.

Parameters
dtTime elapsed in seconds

Definition at line 84 of file MainEditor.cpp.


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