Core::StateEngine Class Reference

Inheritance diagram for Core::StateEngine:

Public Types
typedef Application::mutex_type	mutex_type
typedef Application::lock_type	lock_type
typedef boost::signals2::signal< void()>	state_changed_signal_type
	This signal is triggered when a state in the state engine is changed.

Public Member Functions
bool	get_state (const std::string &stateid, StateBaseHandle &state)
	Get pointer to the state variable based on the unique state tag.
bool	get_state (const size_t idx, StateBaseHandle &state)
	Get the state variable by index.
size_t	number_of_states ()
	The number of state variables in the system.
size_t	get_next_statehandler_count (const std::string &stateid)
	Get the count for the next state handler.
void	set_next_statehandler_count (const std::string &stateid, size_t count)
bool	load_states (const StateIO &state_io)
bool	save_states (StateIO &state_io)
mutex_type &	get_mutex () const

Static Public Member Functions
static mutex_type &	GetMutex ()

Public Attributes
state_changed_signal_type	state_changed_signal_
boost::signals2::signal< void() >	pre_load_states_signal_
	Triggered at the beginning of load_states function.
boost::signals2::signal< void() >	post_load_states_signal_
	Triggered at the end of load_states function.

Friends
class	StateHandler

Member Function Documentation

static mutex_type& Core::StateEngine::GetMutex ( )

inlinestatic

Get the mutex of the state engine NOTE: Do not lock the StateEngine while RenderResources is locked as this will cause deadlock

bool Core::StateEngine::load_states

(

const StateIO &

state_io

)

This function finds the StateHandlers that are saved to file by default and then sets their state variables from the values that have been loaded into session_states_

void Core::StateEngine::set_next_statehandler_count	(	const std::string &	stateid,
		size_t	count
	)

Reset the count to a certain number NOTE: This functionality is intended for redo

---

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

• Core/State/StateEngine.h
• Core/State/StateEngine.cc