FsmState Class Reference

Implement this abstract class to create a new State that can be added to an Fsm. FsmState derives from FsmEventHandler, enabling reaction to platform application events (such as input, window events, etc.) by overriding the appropriate functions. More...

#include <FsmState.h>

Inheritance diagram for FsmState:

Public Member Functions
virtual	~FsmState ()=default
virtual FsmAction	update ()=0
virtual FsmAction	enter ()=0
	Invoked within Fsm::update() when transitioning to this state as the new current state. More...
virtual void	exit ()=0
	Invoked within Fsm::update() when this state is replaced by a new current state. More...
Public Member Functions inherited from FsmEventHandler
	FsmEventHandler ()
Public Member Functions inherited from PlatformEventFilter
	PlatformEventFilter (std::initializer_list< PlatformEventType > eventTypes)
	PlatformEventFilter (PlatformEventWildcard eventTypes)
virtual bool	event (const PlatformEvent *event)
const std::vector< PlatformEventType >	eventTypes () const

Additional Inherited Members
Protected Member Functions inherited from PlatformEventFilter
virtual bool	keyPressEvent (const PlatformKeyEvent *event)
virtual bool	keyReleaseEvent (const PlatformKeyEvent *event)
virtual bool	mouseMoveEvent (const PlatformMouseEvent *event)
virtual bool	mousePressEvent (const PlatformMouseEvent *event)
virtual bool	mouseReleaseEvent (const PlatformMouseEvent *event)
virtual bool	wheelEvent (const PlatformWheelEvent *event)
virtual bool	moveEvent (const PlatformMoveEvent *event)
virtual bool	resizeEvent (const PlatformResizeEvent *event)
virtual bool	activationEvent (const PlatformWindowEvent *event)
virtual bool	closeEvent (const PlatformWindowEvent *event)
virtual bool	gamepadConnectionEvent (const PlatformGamepadEvent *event)
virtual bool	gamepadKeyPressEvent (const PlatformGamepadKeyEvent *event)
virtual bool	gamepadKeyReleaseEvent (const PlatformGamepadKeyEvent *event)
virtual bool	gamepadAxisEvent (const PlatformGamepadAxisEvent *event)
virtual bool	nativeEvent (const PlatformNativeEvent *event)
virtual bool	textInputEvent (const PlatformTextInputEvent *event)

Detailed Description

Implement this abstract class to create a new State that can be added to an Fsm. FsmState derives from FsmEventHandler, enabling reaction to platform application events (such as input, window events, etc.) by overriding the appropriate functions.

Constructor & Destructor Documentation

~FsmState()

virtual FsmState::~FsmState ( )

virtualdefault

Member Function Documentation

enter()

virtual FsmAction FsmState::enter ( )

pure virtual

Invoked within Fsm::update() when transitioning to this state as the new current state.

Implemented in CreditsState, LoadStep2State, MainMenuState, StartState, and VideoState.

exit()

virtual void FsmState::exit ( )

pure virtual

Invoked within Fsm::update() when this state is replaced by a new current state.

Implemented in CreditsState, LoadStep2State, MainMenuState, StartState, and VideoState.

update()

virtual FsmAction FsmState::update ( )

pure virtual

Implemented in CreditsState, LoadStep2State, MainMenuState, StartState, and VideoState.

---

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

• src/Library/Fsm/FsmState.h