StateTransitionListener Class Template

Interface for observing state transitions. More...

Declaration

template <typename StateType> class helios::engine::state::StateTransitionListener<StateType> { ... }

Derived Classes

class	LambdaStateListener<StateType>
	Lambda-based implementation of StateTransitionListener. More...

Public Destructor Index

template <typename StateType>
~StateTransitionListener ()=default

Public Member Functions Index

template <typename StateType>
void	onStateExit (helios::engine::runtime::world::UpdateContext &updateContext, const StateType from) noexcept=0
	Called when exiting a state. More...
template <typename StateType>
void	onStateEnter (helios::engine::runtime::world::UpdateContext &updateContext, const StateType to) noexcept=0
	Called when entering a state. More...
template <typename StateType>
void	onStateTransition (helios::engine::runtime::world::UpdateContext &updateContext, const StateTransitionContext< StateType > transitionCtx) noexcept=0
	Called during a state transition. More...

Description

Interface for observing state transitions.

Listeners are notified during state transitions in order: 1. onStateExit() - before leaving the current state 2. onStateTransition() - during the transition 3. onStateEnter() - after entering the new state

Template Parameters

StateType

The state enum type.

See Also

StateManager

See Also

LambdaStateListener

Definition at line 32 of file StateTransitionListener.ixx.

Public Destructor

~StateTransitionListener()

template <typename StateType>

virtual helios::engine::state::StateTransitionListener< StateType >::~StateTransitionListener ()

virtual default

Definition at line 36 of file StateTransitionListener.ixx.

Public Member Functions

onStateEnter()

template <typename StateType>

virtual void helios::engine::state::StateTransitionListener< StateType >::onStateEnter (helios::engine::runtime::world::UpdateContext & updateContext, const StateType to)

noexcept

Called when entering a state.

Parameters

updateContext	The current frame's update context.
to	The state being entered.

Definition at line 55 of file StateTransitionListener.ixx.

onStateExit()

template <typename StateType>

virtual void helios::engine::state::StateTransitionListener< StateType >::onStateExit (helios::engine::runtime::world::UpdateContext & updateContext, const StateType from)

noexcept

Called when exiting a state.

Parameters

updateContext	The current frame's update context.
from	The state being exited.

Definition at line 44 of file StateTransitionListener.ixx.

onStateTransition()

template <typename StateType>

virtual void helios::engine::state::StateTransitionListener< StateType >::onStateTransition (helios::engine::runtime::world::UpdateContext & updateContext, const StateTransitionContext< StateType > transitionCtx)

noexcept

Called during a state transition.

Parameters

updateContext	The current frame's update context.
transitionCtx	The complete transition context.

Definition at line 66 of file StateTransitionListener.ixx.

---

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

• StateTransitionListener.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.