galaxy::state::State Class Reference

A state to use in a finite state machine. More...

#include <State.hpp>

Collaboration diagram for galaxy::state::State:

Public Member Functions
virtual	~State ()=default
	Virtual destructor.
virtual void	on_push ()=0
	Triggered when state is pushed onto the stack.
virtual void	on_pop ()=0
	Triggered when state is popped off the stack.
virtual void	update ()=0
	Handle state events / update state data.

Protected Member Functions
	State ()=default
	Constructor.

Detailed Description

A state to use in a finite state machine.

Definition at line 18 of file State.hpp.

Constructor & Destructor Documentation

~State()

virtual galaxy::state::State::~State ( )

virtualdefault

Virtual destructor.

State()

galaxy::state::State::State ( )

protecteddefault

Constructor.

Member Function Documentation

on_push()

virtual void galaxy::state::State::on_push ( )

pure virtual

Triggered when state is pushed onto the stack.

Here is the caller graph for this function:

on_pop()

virtual void galaxy::state::State::on_pop ( )

pure virtual

Triggered when state is popped off the stack.

Here is the caller graph for this function:

update()

virtual void galaxy::state::State::update ( )

pure virtual

Handle state events / update state data.

Here is the caller graph for this function:

---

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

• galaxy/src/galaxy/state/State.hpp