State manager for managing states of nodes or application. More...

#include <kanzi/core.ui/state_manager/state_manager.hpp>

Inheritance diagram for kanzi::StateManager:

Classes
struct	EasingArguments
	Easing function arguments. More...

class	EnteredStateMessageArguments
	Represents message arguments of EnteredState message of state manager. More...

class	GoToDefinedStateMessageArguments
	Represents message arguments of GoToNextDefinedState message of state manager. More...

class	GoToNextDefinedStateMessageArguments
	Represents message arguments of GoToNextDefinedState message of state manager. More...

class	GoToPreviousDefinedStateMessageArguments
	Represents message arguments of GoToPreviousDefinedState message of state manager. More...

class	GoToStateMessageArguments
	Represents message arguments of GoToState message of state manager. More...

class	LeftStateMessageArguments
	Represents message arguments of LeftState message of state manager. More...

class	State

class	StateChangeMessageArguments

class	StateGroup

class	StateGroupRuntime
	State group runtime. More...

class	StateManagerMessageArguments
	Represents base message arguments of state manager messages. More...

class	StateManagerRuntime

class	StateObject

class	StateObjectRuntime
	State object runtime. More...

class	StateRuntime
	State runtime. More...

class	StateTransition

class	StateTransitionAnimation

class	TargetObject
	TargetObject. More...

class	TransitionFinishedMessageArguments
	Represents message arguments of TransitionFinished message of state manager. More...

class	TransitionMessageArguments

class	TransitionStartedMessageArguments
	Represents message arguments of TransitionStarted message of state manager. More...

Public Types
enum	AnimationMode { AnimationModeCustom, AnimationModeLinear, AnimationModeSmoothStep, AnimationModeStep, AnimationModeSmootherStep, AnimationModeBack, AnimationModeBounce, AnimationModeCircle, AnimationModeCubic, AnimationModeElastic, AnimationModeExponential, AnimationModePower, AnimationModeQuadratic, AnimationModeQuartic, AnimationModeQuintic, AnimationModeSine }
	State manager animation mode. More...

typedef vector< StatePtr >	StateContainer

typedef vector< StateGroupPtr >	StateGroupContainer

typedef StateGroupContainer::const_iterator	StateGroupIterator

typedef unique_ptr< StateGroup >	StateGroupPtr

typedef StateContainer::const_iterator	StateIterator

typedef shared_ptr< StateManagerRuntime >	StateManagerRuntimeSharedPtr

typedef weak_ptr< StateManagerRuntime >	StateManagerRuntimeWeakPtr

typedef vector< StateObjectPtr >	StateObjectContainer

typedef StateObjectContainer::const_iterator	StateObjectIterator

typedef unique_ptr< StateObject >	StateObjectPtr

typedef unique_ptr< State >	StatePtr

typedef vector< StateTransitionAnimationPtr >	StateTransitionAnimationContainer

typedef StateTransitionAnimationContainer::const_iterator	StateTransitionAnimationIterator

typedef unique_ptr< StateTransitionAnimation >	StateTransitionAnimationPtr

typedef vector< StateTransitionPtr >	StateTransitionContainer

typedef StateTransitionContainer::const_iterator	StateTransitionIterator

typedef unique_ptr< StateTransition >	StateTransitionPtr

enum	TransitionReturnTimeType { TransitionReturnTimeElapsed, TransitionReturnTimeFull }
	State manager transition return time calculation type. More...

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
void	addStateGroup (StateGroupPtr stateGroup)
	Add new state group to state manager. More...

StateManagerRuntimeSharedPtr	attach (StateManagerSharedPtr stateManager, Node &objectNode)
	Attach a state manager runtime. More...

StateGroupIterator	beginStateGroups () const
	Returns an iterator pointing to the beginning of the state group container. More...

StateGroupIterator	endStateGroups () const
	Returns an iterator to end of the state group container. More...

	~StateManager () override
	Destructor. More...

Public Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...

const string &	getName () const
	Gets the resource name. More...

const string &	getUrl () const
	Gets the resource URL. More...

bool	isKeepAlive () const
	Tells if the resource has keep alive flag set. More...

void	reload ()

void	reloadFromFile (string_view filePath)

void	reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag. More...

void	setUrl (string_view url)
	Sets the resource URL. More...

	~Resource () override
	Destructor. More...

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	applyObjectStyles ()
	Apply all styles for an object node. More...

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object. More...

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain. More...

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object. More...

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container. More...

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object. More...

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object. More...

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type. More...

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers. More...

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property. More...

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...

	PropertyObject ()

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set. More...

void	removeKzbProperties ()
	Remove all KZB properties. More...

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type. More...

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	validatePropertyModifiers (AbstractPropertyType propertyType)

virtual	~PropertyObject ()

Static Public Member Functions
static StateManagerSharedPtr	create (Domain *domain, string_view name)
	Create a state manager. More...

static StateManager *	createEmpty (Domain *domain, string_view name)
	Create an empty state manager. More...

static ResourceManager::LoadTaskSharedPtr	createLoadTask (string_view name, KzbFile *kzbFile, ReadOnlyMemoryFilePtr file)
	Factory function for StateManager Load Task, which loads a StateManager from a kzb file. More...

static void	goToState (Node *objectNode, string_view stateGroupName, string_view stateName, bool immediate)
	Attempt to go to a state. More...

static void	goToState (Node *objectNode, string_view stateName, bool immediate)
	Attempt to go to a state. More...

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Attributes
static MessageType< EnteredStateMessageArguments >	EnteredStateMessage

static MessageType< GoToNextDefinedStateMessageArguments >	GoToNextDefinedStateMessage

static MessageType< GoToPreviousDefinedStateMessageArguments >	GoToPreviousDefinedStateMessage

static MessageType< GoToStateMessageArguments >	GoToStateMessage

static MessageType< LeftStateMessageArguments >	LeftStateMessage

static MessageType< TransitionFinishedMessageArguments >	TransitionFinishedMessage

static MessageType< TransitionStartedMessageArguments >	TransitionStartedMessage

Properties
static PropertyType< bool >	LongestPathProperty
	LongestPath property. More...

Protected Types
typedef vector< StateGroupRuntimeSharedPtr >	StateGroupRuntimeContainer

typedef StateGroupRuntimeContainer::const_iterator	StateGroupRuntimeIterator

typedef shared_ptr< StateGroupRuntime >	StateGroupRuntimeSharedPtr

typedef vector< StateObjectRuntimeSharedPtr >	StateObjectRuntimeContainer

typedef StateObjectRuntimeContainer::iterator	StateObjectRuntimeIterator

typedef shared_ptr< StateObjectRuntime >	StateObjectRuntimeSharedPtr

typedef weak_ptr< StateObjectRuntime >	StateObjectRuntimeWeakPtr

typedef vector< StateRuntimeSharedPtr >	StateRuntimeContainer

typedef StateRuntimeContainer::const_iterator	StateRuntimeIterator

typedef shared_ptr< StateRuntime >	StateRuntimeSharedPtr

typedef shared_ptr< TargetObject >	TargetObjectSharedPtr

typedef weak_ptr< TargetObject >	TargetObjectWeakPtr

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...

Protected Member Functions
void	cleanup ()
	Cleanup state manager internals. More...

	StateManager (Domain *domain, string_view name)

Protected Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsageOverride () const

virtual void	reloadFromFileOverride (string_view filePath)

virtual void	reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

virtual void	reloadOverride ()

	Resource (Domain *domain, string_view name)
	Constructor. More...

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source. More...

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source. More...

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor. More...

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor. More...

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage. More...

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source. More...

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

Static Protected Member Functions
static void	goToNextDefinedState (StateManagerRuntime &stateManagerRuntime, GoToNextDefinedStateMessageArguments &goToNextDefinedStateMessage)
	Go to next defined state message handler. More...

static void	goToPreviousDefinedState (StateManagerRuntime &stateManagerRuntime, GoToPreviousDefinedStateMessageArguments &goToPreviousDefinedStateMessage)
	Go to previous defined state message handler. More...

static void	goToStateHandler (StateManagerRuntime &stateManagerRuntime, GoToStateMessageArguments &goToStateMessage)
	Go to state message handler. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Protected Attributes
StateGroupContainer	m_groups

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

State manager for managing states of nodes or application.

Member Typedef Documentation

◆ StateManagerRuntimeSharedPtr

typedef shared_ptr<StateManagerRuntime> kanzi::StateManager::StateManagerRuntimeSharedPtr

◆ StateManagerRuntimeWeakPtr

typedef weak_ptr<StateManagerRuntime> kanzi::StateManager::StateManagerRuntimeWeakPtr

◆ StateGroupPtr

typedef unique_ptr<StateGroup> kanzi::StateManager::StateGroupPtr

◆ StateGroupContainer

typedef vector<StateGroupPtr> kanzi::StateManager::StateGroupContainer

◆ StateGroupIterator

typedef StateGroupContainer::const_iterator kanzi::StateManager::StateGroupIterator

◆ StatePtr

typedef unique_ptr<State> kanzi::StateManager::StatePtr

◆ StateContainer

typedef vector<StatePtr> kanzi::StateManager::StateContainer

◆ StateIterator

typedef StateContainer::const_iterator kanzi::StateManager::StateIterator

◆ StateTransitionPtr

typedef unique_ptr<StateTransition> kanzi::StateManager::StateTransitionPtr

◆ StateTransitionContainer

typedef vector<StateTransitionPtr> kanzi::StateManager::StateTransitionContainer

◆ StateTransitionIterator

typedef StateTransitionContainer::const_iterator kanzi::StateManager::StateTransitionIterator

◆ StateTransitionAnimationPtr

typedef unique_ptr<StateTransitionAnimation> kanzi::StateManager::StateTransitionAnimationPtr

◆ StateTransitionAnimationContainer

typedef vector<StateTransitionAnimationPtr> kanzi::StateManager::StateTransitionAnimationContainer

◆ StateTransitionAnimationIterator

typedef StateTransitionAnimationContainer::const_iterator kanzi::StateManager::StateTransitionAnimationIterator

◆ StateObjectPtr

typedef unique_ptr<StateObject> kanzi::StateManager::StateObjectPtr

◆ StateObjectContainer

typedef vector<StateObjectPtr> kanzi::StateManager::StateObjectContainer

◆ StateObjectIterator

typedef StateObjectContainer::const_iterator kanzi::StateManager::StateObjectIterator

◆ StateGroupRuntimeSharedPtr

typedef shared_ptr<StateGroupRuntime> kanzi::StateManager::StateGroupRuntimeSharedPtr

protected

◆ StateRuntimeSharedPtr

typedef shared_ptr<StateRuntime> kanzi::StateManager::StateRuntimeSharedPtr

protected

◆ StateObjectRuntimeSharedPtr

typedef shared_ptr<StateObjectRuntime> kanzi::StateManager::StateObjectRuntimeSharedPtr

protected

◆ TargetObjectSharedPtr

typedef shared_ptr<TargetObject> kanzi::StateManager::TargetObjectSharedPtr

protected

◆ StateObjectRuntimeWeakPtr

typedef weak_ptr<StateObjectRuntime> kanzi::StateManager::StateObjectRuntimeWeakPtr

protected

◆ TargetObjectWeakPtr

typedef weak_ptr<TargetObject> kanzi::StateManager::TargetObjectWeakPtr

protected

◆ StateGroupRuntimeContainer

typedef vector<StateGroupRuntimeSharedPtr> kanzi::StateManager::StateGroupRuntimeContainer

protected

◆ StateGroupRuntimeIterator

typedef StateGroupRuntimeContainer::const_iterator kanzi::StateManager::StateGroupRuntimeIterator

protected

◆ StateRuntimeContainer

typedef vector<StateRuntimeSharedPtr> kanzi::StateManager::StateRuntimeContainer

protected

◆ StateRuntimeIterator

typedef StateRuntimeContainer::const_iterator kanzi::StateManager::StateRuntimeIterator

protected

◆ StateObjectRuntimeContainer

typedef vector<StateObjectRuntimeSharedPtr> kanzi::StateManager::StateObjectRuntimeContainer

protected

◆ StateObjectRuntimeIterator

typedef StateObjectRuntimeContainer::iterator kanzi::StateManager::StateObjectRuntimeIterator

protected

Member Enumeration Documentation

◆ AnimationMode

enum kanzi::StateManager::AnimationMode

State manager animation mode.

Enumerator
AnimationModeCustom
AnimationModeLinear
AnimationModeSmoothStep
AnimationModeStep
AnimationModeSmootherStep
AnimationModeBack
AnimationModeBounce
AnimationModeCircle
AnimationModeCubic
AnimationModeElastic
AnimationModeExponential
AnimationModePower
AnimationModeQuadratic
AnimationModeQuartic
AnimationModeQuintic
AnimationModeSine

◆ TransitionReturnTimeType

enum kanzi::StateManager::TransitionReturnTimeType

State manager transition return time calculation type.

Enumerator
TransitionReturnTimeElapsed	Play only elapsed time.
TransitionReturnTimeFull	Always play full time.

Constructor & Destructor Documentation

◆ ~StateManager()

kanzi::StateManager::~StateManager ( )

override

Destructor.

◆ StateManager()

kanzi::StateManager::StateManager	(	Domain *	domain,
		string_view	name
	)

inlineexplicitprotected

Member Function Documentation

◆ create()

static StateManagerSharedPtr kanzi::StateManager::create	(	Domain *	domain,
		string_view	name
	)

static

Create a state manager.

◆ createEmpty()

static StateManager* kanzi::StateManager::createEmpty	(	Domain *	domain,
		string_view	name
	)

static

Create an empty state manager.

◆ addStateGroup()

void kanzi::StateManager::addStateGroup ( StateGroupPtr stateGroup )

Add new state group to state manager.

◆ beginStateGroups()

StateGroupIterator kanzi::StateManager::beginStateGroups ( ) const

inline

Returns an iterator pointing to the beginning of the state group container.

Returns: Iterator at the beginning of the container.

◆ endStateGroups()

StateGroupIterator kanzi::StateManager::endStateGroups ( ) const

inline

Returns an iterator to end of the state group container.

Returns: Iterator at the end of the container.

◆ attach()

StateManagerRuntimeSharedPtr kanzi::StateManager::attach	(	StateManagerSharedPtr	stateManager,
		Node &	objectNode
	)

Attach a state manager runtime.

Parameters

stateManager	Shared pointer to this state manager.
objectNode	Object node to attach to.

◆ goToState() [1/2]

static void kanzi::StateManager::goToState	(	Node *	objectNode,
		string_view	stateGroupName,
		string_view	stateName,
		bool	immediate
	)

static

Attempt to go to a state.

Parameters

objectNode	Node to post the message on.
stateGroupName	Name of the state group to do the transition in.
stateName	Name of the state to transition to.
immediate	True to omit transition animations.

◆ goToState() [2/2]

static void kanzi::StateManager::goToState	(	Node *	objectNode,
		string_view	stateName,
		bool	immediate
	)

static

Attempt to go to a state.

If state manager attached to node has multiple state groups with the same name, it is not clearly defined which state is selected.

Parameters

objectNode	Node to post the message on.
stateName	Name of the state to transition to.
immediate	True to omit transition animations.

◆ createLoadTask()

static ResourceManager::LoadTaskSharedPtr kanzi::StateManager::createLoadTask	(	string_view	name,
		KzbFile *	kzbFile,
		ReadOnlyMemoryFilePtr	file
	)

static

Factory function for StateManager Load Task, which loads a StateManager from a kzb file.

Parameters

name	Name of the StateManager being loaded.
kzbFile	Pointer to instance of KzbFile, which holds information about the kzb file.
file	Pointer to instance of ReadOnlyMemoryFile, which wraps the actual kzb file.

Returns: Shared pointer to created load task.

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::StateManager::makeEditorInfo ( )

staticprotected

◆ cleanup()

void kanzi::StateManager::cleanup ( )

protected

Cleanup state manager internals.

◆ goToStateHandler()

static void kanzi::StateManager::goToStateHandler	(	StateManagerRuntime &	stateManagerRuntime,
		GoToStateMessageArguments &	goToStateMessage
	)

staticprotected

Go to state message handler.

◆ goToNextDefinedState()

static void kanzi::StateManager::goToNextDefinedState	(	StateManagerRuntime &	stateManagerRuntime,
		GoToNextDefinedStateMessageArguments &	goToNextDefinedStateMessage
	)

staticprotected

Go to next defined state message handler.

◆ goToPreviousDefinedState()

static void kanzi::StateManager::goToPreviousDefinedState	(	StateManagerRuntime &	stateManagerRuntime,
		GoToPreviousDefinedStateMessageArguments &	goToPreviousDefinedStateMessage
	)

staticprotected

Go to previous defined state message handler.

Member Data Documentation

◆ LongestPathProperty

PropertyType<bool> kanzi::StateManager::LongestPathProperty

static

LongestPath property.

The default value is false.

See also: setLongestPath(), isLongestPath()

◆ GoToStateMessage

MessageType<GoToStateMessageArguments> kanzi::StateManager::GoToStateMessage

static

◆ GoToNextDefinedStateMessage

MessageType<GoToNextDefinedStateMessageArguments> kanzi::StateManager::GoToNextDefinedStateMessage

static

◆ GoToPreviousDefinedStateMessage

MessageType<GoToPreviousDefinedStateMessageArguments> kanzi::StateManager::GoToPreviousDefinedStateMessage

static

◆ EnteredStateMessage

MessageType<EnteredStateMessageArguments> kanzi::StateManager::EnteredStateMessage

static

◆ LeftStateMessage

MessageType<LeftStateMessageArguments> kanzi::StateManager::LeftStateMessage

static

◆ TransitionStartedMessage

MessageType<TransitionStartedMessageArguments> kanzi::StateManager::TransitionStartedMessage

static

◆ TransitionFinishedMessage

MessageType<TransitionFinishedMessageArguments> kanzi::StateManager::TransitionFinishedMessage

static

◆ m_groups

StateGroupContainer kanzi::StateManager::m_groups

protected

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

kanzi/core.ui/state_manager/state_manager.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ StateManagerRuntimeSharedPtr

◆ StateManagerRuntimeWeakPtr

◆ StateGroupPtr

◆ StateGroupContainer

◆ StateGroupIterator

◆ StatePtr

◆ StateContainer

◆ StateIterator

◆ StateTransitionPtr

◆ StateTransitionContainer

◆ StateTransitionIterator

◆ StateTransitionAnimationPtr

◆ StateTransitionAnimationContainer

◆ StateTransitionAnimationIterator

◆ StateObjectPtr

◆ StateObjectContainer

◆ StateObjectIterator

◆ StateGroupRuntimeSharedPtr

◆ StateRuntimeSharedPtr

◆ StateObjectRuntimeSharedPtr

◆ TargetObjectSharedPtr

◆ StateObjectRuntimeWeakPtr

◆ TargetObjectWeakPtr

◆ StateGroupRuntimeContainer

◆ StateGroupRuntimeIterator

◆ StateRuntimeContainer

◆ StateRuntimeIterator

◆ StateObjectRuntimeContainer

◆ StateObjectRuntimeIterator

Member Enumeration Documentation

◆ AnimationMode

◆ TransitionReturnTimeType

Constructor & Destructor Documentation

◆ ~StateManager()

◆ StateManager()

Member Function Documentation

◆ create()

◆ createEmpty()

◆ addStateGroup()

◆ beginStateGroups()

◆ endStateGroups()

◆ attach()

◆ goToState() [1/2]

◆ goToState() [2/2]

◆ createLoadTask()

◆ makeEditorInfo()

◆ cleanup()

◆ goToStateHandler()

◆ goToNextDefinedState()

◆ goToPreviousDefinedState()

Member Data Documentation

◆ LongestPathProperty

◆ GoToStateMessage

◆ GoToNextDefinedStateMessage

◆ GoToPreviousDefinedStateMessage

◆ EnteredStateMessage

◆ LeftStateMessage

◆ TransitionStartedMessage

◆ TransitionFinishedMessage

◆ m_groups