Odyssey::State< MixinT > Class Template Reference

A state is a discrete, executable member of a finite state machine. More...

#include <State.h>

List of all members.

Public Member Functions
virtual	~State ()
virtual void	onAdded ()
virtual void	onRemoved ()
virtual void	onActivated ()
	Called when the state is activated within an fsm.
virtual void	onDeactivated ()
	Called when the state is deactivated within an fsm.

---

Detailed Description

template<class MixinT>
class Odyssey::State< MixinT >

A state is a discrete, executable member of a finite state machine.

This class represents a discrete state within a finite state machine. It has callbacks to be notified of activation and deactivation is intended to implement state-specific functionality in its update method.

The MixinT template parameter is the interface to mix into the interface for this class.

---

Constructor & Destructor Documentation

template<class MixinT> virtual Odyssey::State< MixinT >::~State (   )  [inline, virtual]

---

Member Function Documentation

template<class MixinT> virtual void Odyssey::State< MixinT >::onActivated (   )  [inline, virtual]

Called when the state is activated within an fsm.

template<class MixinT> virtual void Odyssey::State< MixinT >::onAdded (   )  [inline, virtual]

template<class MixinT> virtual void Odyssey::State< MixinT >::onDeactivated (   )  [inline, virtual]

Called when the state is deactivated within an fsm.

template<class MixinT> virtual void Odyssey::State< MixinT >::onRemoved (   )  [inline, virtual]

---

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

• D:/Programs/odyssey/odyssey/include/State.h

---