CG-Project2
Loading...
Searching...
No Matches
BootstrapState Class Reference

This State allows to load one State in an ImGui window from cached states in the StateManager. More...

#include <BootstrapState.hpp>

Inheritance diagram for BootstrapState:
Collaboration diagram for BootstrapState:

Public Member Functions

virtual void onAttach () override
 This method is called after using StateManager::sync() (read StateMnaager::sync() documentation for more info). It should contain all the operations that must be done before you start the execution of a State.
virtual void onDetach () override
 This method is called while using sync() (read sync() documentation for more info). It should contain all the operations that must be done at the end of State execution before deleting or changing State, it is automatically called by sync().
virtual void onUpdate () override
 This methods contains all the operations executed at every event::loop::LOOP_UPDATE if there are any.
virtual void onRender () override
 This methods contains all the operations executed at every event::loop::LOOP_RENDER if there are any.
virtual bool isCurrentStateEnd () override
 Retrieves the current binary state of the current State
 BootstrapState (const std::string &name="Bootstrap State")
 Instances basic state with the given name.
Public Member Functions inherited from State
std::string getName () const
 Retrieves the State name.
bool isAttached () const
 Retrieves if the state is attached.
 State (const std::string &name="State")
 Instances a state with the given name.

Additional Inherited Members

Protected Attributes inherited from State
const std::string m_name
 state's name
bool m_attached = false
 true if the state is attached

Detailed Description

This State allows to load one State in an ImGui window from cached states in the StateManager.

Constructor & Destructor Documentation

◆ BootstrapState()

BootstrapState::BootstrapState ( const std::string & name = "Bootstrap State")
inline

Instances basic state with the given name.

Parameters
namestate name

Member Function Documentation

◆ isCurrentStateEnd()

bool BootstrapState::isCurrentStateEnd ( )
overridevirtual

Retrieves the current binary state of the current State

Returns
bool true if the state is finished

Reimplemented from State.

◆ onAttach()

void BootstrapState::onAttach ( )
overridevirtual

This method is called after using StateManager::sync() (read StateMnaager::sync() documentation for more info). It should contain all the operations that must be done before you start the execution of a State.

Also this method need to be called in child class implementation using State::onAttach()

Reimplemented from State.

◆ onDetach()

void BootstrapState::onDetach ( )
overridevirtual

This method is called while using sync() (read sync() documentation for more info). It should contain all the operations that must be done at the end of State execution before deleting or changing State, it is automatically called by sync().

Also this method need to be called in child class implementation using State::onDetach()

Reimplemented from State.

◆ onRender()

void BootstrapState::onRender ( )
overridevirtual

This methods contains all the operations executed at every event::loop::LOOP_RENDER if there are any.

Reimplemented from State.

◆ onUpdate()

void BootstrapState::onUpdate ( )
overridevirtual

This methods contains all the operations executed at every event::loop::LOOP_UPDATE if there are any.

Reimplemented from State.


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