Urho3D::StateManager Class Reference

Inheritance diagram for Urho3D::StateManager:

Classes
struct	QueueItem
	Queue item. More...

Public Member Functions
	StateManager (Context *context)
void	Reset ()
	Hard reset of state manager. Current state will be set to nullptr and the queue is purged.
void	Update (float timeStep)
	Update state manager. This is called automatically by the engine every frame.
void	CacheState (ApplicationState *state)
	Cache state without using it.
ApplicationState *	GetCachedState (StringHash type) const
	Get cached state if present.
template<typename T >
T *	GetCachedState () const
ApplicationState *	GetState () const
	Get current application state.
StringHash	GetTargetState () const
	Get target application state.
Window *	GetFadeOverlay ()
	Get fade overlay.
void	SetFadeInDuration (float durationInSeconds)
	Set fade in animation duration;.
void	SetFadeOutDuration (float durationInSeconds)
	Set fade out animation duration;.
float	GetFadeInDuration () const
	Get fade in animation duration;.
float	GetFadeOutDuration () const
	Get fade out animation duration;.
void	EnqueueState (ApplicationState *gameScreen, StringVariantMap &bundle)
void	EnqueueState (ApplicationState *gameScreen)
void	EnqueueState (StringHash type, StringVariantMap &bundle)
void	EnqueueState (StringHash type)
template<typename T >
void	EnqueueState (StringVariantMap &bundle)
template<typename T >
void	EnqueueState ()
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
	~Object () override
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
virtual const ea::string &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.
template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.
void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.
template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.
void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
const VariantMap &	GetGlobalVars () const
void	SetGlobalVar (StringHash key, const Variant &value)
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.
const ea::string &	GetCategory () const
void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.
void	SetBlockEvents (bool block)
	Block object from sending and receiving events.
bool	GetBlockEvents () const
	Return sending and receiving events blocking status.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
int	AddRef ()
int	ReleaseRef ()
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.
bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.
bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Private Types
enum	TransitionState { Sustain, FadeOut, FadeIn, WaitToExit }

Private Member Functions
	URHO3D_OBJECT (StateManager, Object)
void	InitiateTransition ()
	Initiate state transition if necessary.
void	HandleUpdate (StringHash eventName, VariantMap &args)
	Handle update event to animate state transitions.
void	SetTransitionState (TransitionState state)
	Set current transition state and initialize related values.
void	UpdateFadeOverlay (float t)
	Update fade overlay size and transparency.
void	StartTransition ()
	Start transition out of the current state.
void	CompleteTransition ()
	Complete transition into the current state.
void	DeactivateState ()
	Deactivate state.
void	CreateNextState ()
	Dequeue and set next state as active.
void	Notify (StringHash eventType)
	Notify subscribers about transition state updates.

Private Attributes
StringHash	originState_ {StringHash::Empty}
	Origin state.
StringHash	destinationState_ {StringHash::Empty}
	Destination state.
ea::unordered_map< StringHash, WeakPtr< ApplicationState > >	stateCache_
	Cache of previously created states.
ea::queue< QueueItem >	stateQueue_
	Queue of application states.
SharedPtr< ApplicationState >	activeState_
	Current active game screen.
float	fadeTime_ {}
	Fade animation time.
float	fadeInDuration_ {ea::numeric_limits<float>::epsilon()}
	Fade in duration in seconds.
float	fadeOutDuration_ {ea::numeric_limits<float>::epsilon()}
	Fade out duration in seconds.
SharedPtr< Window >	fadeOverlay_
	Fade overlay window.
TransitionState	transitionState_ {TransitionState::Sustain}
	State transition state.

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Constructor & Destructor Documentation

StateManager()

Urho3D::StateManager::StateManager ( Context *  context )

explicit

Construct. Parse default engine parameters from the command line, and create the engine in an uninitialized state.

Member Function Documentation

EnqueueState()

void Urho3D::StateManager::EnqueueState	(	ApplicationState *	gameScreen,
		StringVariantMap &	bundle
	)

Transition to the application state.

---

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

• Urho3D/Engine/StateManager.h
• Urho3D/Engine/StateManager.cpp