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	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...

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

typedef shared_ptr< StateManagerRuntime >	StateManagerRuntimeSharedPtr

typedef weak_ptr< StateManagerRuntime >	StateManagerRuntimeWeakPtr

typedef unique_ptr< StateGroup >	StateGroupPtr

typedef vector< StateGroupPtr >	StateGroupContainer

typedef StateGroupContainer::const_iterator	StateGroupIterator

typedef unique_ptr< State >	StatePtr

typedef vector< StatePtr >	StateContainer

typedef StateContainer::const_iterator	StateIterator

typedef unique_ptr< StateTransition >	StateTransitionPtr

typedef vector< StateTransitionPtr >	StateTransitionContainer

typedef StateTransitionContainer::const_iterator	StateTransitionIterator

typedef unique_ptr< StateTransitionAnimation >	StateTransitionAnimationPtr

typedef vector< StateTransitionAnimationPtr >	StateTransitionAnimationContainer

typedef StateTransitionAnimationContainer::const_iterator	StateTransitionAnimationIterator

typedef unique_ptr< StateObject >	StateObjectPtr

typedef vector< StateObjectPtr >	StateObjectContainer

typedef StateObjectContainer::const_iterator	StateObjectIterator

Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
	~StateManager ()
	Destructor. More...

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

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

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

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

virtual void	loadFromKZB (const ResourceLoaderThreadContext threadContext, KzcInputStream inputStream, const KzuBinaryFileInfo *file) KZ_OVERRIDE
	Load a state manager from kzb. More...

virtual	~StateManagerRuntime ()
	Destructor. More...

void	detach ()
	Detach state manager runtime. More...

Public Member Functions inherited from kanzi::Resource
KzcMemoryManager *	getMemoryManager () const

	Resource (Domain *domain, string_view name)

virtual	~Resource ()

virtual void	unloadOverride ()
	Unload function for resource. Releases all CPU memory taken by the resource except the resource loader. More...

virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...

void	setKZB (const KzuBinaryDirectory *binaryDirectory, string_view path)
	Set the binary directory and path of the resource. More...

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

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

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

void	setNotLoaded ()

bool	isFromKZB () const

void	reload ()

void	reloadFromKzb (KzcInputStream inputStream, const KzuBinaryFileInfo file)

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

void	reloadFromFile (string_view filePath)

void	load ()

void	unload ()

bool	isLoaded () const

void	kzuResourceLoad_private (const ResourceLoaderThreadContext *threadContext)
	Private function for kzuResourceLoad() with specified thread context. More...

void	kzuResourceFinishLoading_private (const ResourceLoaderThreadContext *threadContext)
	Private function for finishing the loading of the resource. More...

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

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

Public Member Functions inherited from kanzi::Object
	Object (Domain *domain)

virtual	~Object ()

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

KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...

KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

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

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

AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

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

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

Public Member Functions inherited from kanzi::MetaObject
virtual	~MetaObject ()

bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

Public Member Functions inherited from kanzi::PropertyObject
	PropertyObject ()

virtual	~PropertyObject ()

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

void	removeKzbProperties ()

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

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 >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...

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

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

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. 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...

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

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...

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

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

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

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

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

void	validatePropertyModifiers (AbstractPropertyType propertyType)

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

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

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

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 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 StatePtr	loadStateFromKZB (KzcInputStream inputStream, Domain domain, const KzuBinaryFileInfo *file, bool hasControlType)

static StateObjectPtr	loadStateObjectFromKZB (KzcInputStream inputStream, Domain domain, const KzuBinaryFileInfo *file)

static StateTransitionPtr	loadTransitionFromKZB (KzcInputStream inputStream, Domain domain, const KzuBinaryFileInfo *file)

static StateTransitionAnimationPtr	loadTransitionAnimationFromKZB (KzcInputStream inputStream, Domain domain, const KzuBinaryFileInfo *file)

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

static StateManagerRuntimeSharedPtr	create (StateManagerSharedPtr stateManager, Domain *domain, const StateGroupContainer &groups, Node &objectNode)
	Constructor. 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...

Public Attributes
Domain *	m_domain

Node &	m_objectNode

StateGroupRuntimeContainer	m_groupRuntimes

StateManagerSharedPtr	m_stateManager

Static Public Attributes
static PropertyType< bool >	LongestPathProperty
	LongestPath property. More...

static MessageType< GoToStateMessageArguments >	GoToStateMessage

static MessageType< GoToNextDefinedStateMessageArguments >	GoToNextDefinedStateMessage

static MessageType< GoToPreviousDefinedStateMessageArguments >	GoToPreviousDefinedStateMessage

static MessageType< EnteredStateMessageArguments >	EnteredStateMessage

static MessageType< LeftStateMessageArguments >	LeftStateMessage

static MessageType< TransitionStartedMessageArguments >	TransitionStartedMessage

static MessageType< TransitionFinishedMessageArguments >	TransitionFinishedMessage

Protected Types
typedef shared_ptr< StateGroupRuntime >	StateGroupRuntimeSharedPtr

typedef shared_ptr< StateRuntime >	StateRuntimeSharedPtr

typedef shared_ptr< StateObjectRuntime >	StateObjectRuntimeSharedPtr

typedef shared_ptr< TargetObject >	TargetObjectSharedPtr

typedef weak_ptr< StateObjectRuntime >	StateObjectRuntimeWeakPtr

typedef weak_ptr< TargetObject >	TargetObjectWeakPtr

typedef vector< StateGroupRuntimeSharedPtr >	StateGroupRuntimeContainer

typedef StateGroupRuntimeContainer::const_iterator	StateGroupRuntimeIterator

typedef vector< StateRuntimeSharedPtr >	StateRuntimeContainer

typedef StateRuntimeContainer::const_iterator	StateRuntimeIterator

typedef vector< StateObjectRuntimeSharedPtr >	StateObjectRuntimeContainer

typedef StateObjectRuntimeContainer::iterator	StateObjectRuntimeIterator

typedef shared_ptr< TargetObject >	TargetObjectSharedPtr

typedef vector< TargetObjectSharedPtr >	TargetObjectVector

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

Protected Member Functions
	StateManager (Domain *domain, string_view name)

void	cleanup ()
	Cleanup state manager internals. More...

	StateManagerRuntime (StateManagerSharedPtr stateManager, Domain *domain, Node &objectNode)
	Constructor. More...

void	removeHandlers ()
	Remove handlers from state manager runtime. More...

void	unapplyStyles ()
	Unapply and delete styles recursively. More...

void	stopTransitions ()
	Stop transitions recursively. More...

void	releaseTargetObjects ()
	Stops tracking target objects. More...

void	captureTargetObjects ()
	Starts tracking target objects. More...

Protected Member Functions inherited from kanzi::Resource
virtual void	reloadOverride ()

virtual void	reloadFromKzbOverride (KzcInputStream inputStream, const KzuBinaryFileInfo file)

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

virtual void	reloadFromFileOverride (string_view filePath)

virtual unsigned int	getCPUMemoryUsageOverride () const

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

void	onCopy (const Object &other)

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

void	initialize ()

Protected Member Functions inherited from kanzi::PropertyObject
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void owner)

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const

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

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

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

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

AbstractPropertyTypeDescriptor::ValueSourceEntry *	findLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

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

AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

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

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

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

PropertyStorageContainer::iterator	beginPropertyStorage ()

PropertyStorageContainer::iterator	endPropertyStorage ()

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)

void	onCopy (const PropertyObject &other)

Static Protected Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

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

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...

Protected Attributes
StateGroupContainer	m_groups

TargetObjectVector	m_targetObjects
	Collection of target objects. More...

Node::MessageSubscriptionToken	m_goToStateMessageSubscription
	Subscription to StateManagerGoToState messages. More...

Node::MessageSubscriptionToken	m_goToNextDefinedStateMessageSubscription
	Subscription to StateManagerGoToNextDefinedState messages. More...

Node::MessageSubscriptionToken	m_goToPreviousDefinedStateMessageSubscription
	Subscription to StateManagerGoToPreviousDefinedState messages. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

protected

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

protected

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

protected

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

protected

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

protected

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

protected

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

protected

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

protected

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

protected

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

protected

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

protected

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

protected

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

protected

typedef vector<TargetObjectSharedPtr> kanzi::StateManager::TargetObjectVector

protected

Member Enumeration Documentation

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

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

kanzi::StateManager::~StateManager ( )

Destructor.

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

inlineexplicitprotected

virtual kanzi::StateManager::~StateManagerRuntime ( )

virtual

Destructor.

Member Function Documentation

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

static

Create a state manager.

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

static

Create an empty state manager.

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

Add new state group to state manager.

StateGroupIterator kanzi::StateManager::beginStateGroups ( ) const

inline

Returns an iterator to start of the state group container.

Returns: Iterator at the beginning of the container.

StateGroupIterator kanzi::StateManager::endStateGroups ( ) const

inline

Returns an iterator to end of the state group container.

Returns: Iterator at the end of the container.

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.

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.

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.

virtual void kanzi::StateManager::loadFromKZB	(	const ResourceLoaderThreadContext *	threadContext,
		KzcInputStream *	inputStream,
		const KzuBinaryFileInfo *	file
	)

virtual

Load a state manager from kzb.

Reimplemented from kanzi::Resource.

static StatePtr kanzi::StateManager::loadStateFromKZB	(	KzcInputStream *	inputStream,
		Domain *	domain,
		const KzuBinaryFileInfo *	file,
		bool	hasControlType
	)

static

static StateObjectPtr kanzi::StateManager::loadStateObjectFromKZB	(	KzcInputStream *	inputStream,
		Domain *	domain,
		const KzuBinaryFileInfo *	file
	)

static

static StateTransitionPtr kanzi::StateManager::loadTransitionFromKZB	(	KzcInputStream *	inputStream,
		Domain *	domain,
		const KzuBinaryFileInfo *	file
	)

static

static StateTransitionAnimationPtr kanzi::StateManager::loadTransitionAnimationFromKZB	(	KzcInputStream *	inputStream,
		Domain *	domain,
		const KzuBinaryFileInfo *	file
	)

static

static ResourceManager::LoadTaskSharedPtr kanzi::StateManager::createLoadTask	(	string_view	name,
		KzbFile *	kzbFile,
		unique_ptr< ReadOnlyMemoryFile >	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.

static PropertyTypeEditorInfoSharedPtr kanzi::StateManager::makeEditorInfo ( )

staticprotected

void kanzi::StateManager::cleanup ( )

protected

Cleanup state manager internals.

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

staticprotected

Go to state message handler.

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

staticprotected

Go to next defined state message handler.

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

staticprotected

Go to previous defined state message handler.

static StateManagerRuntimeSharedPtr kanzi::StateManager::create	(	StateManagerSharedPtr	stateManager,
		Domain *	domain,
		const StateGroupContainer &	groups,
		Node &	objectNode
	)

static

Constructor.

Parameters

stateManager	State manager this runtime is using.
domain	Domain.
groups	List of state groups in state manager.
objectNode	Node owning the state manager.

void kanzi::StateManager::detach ( )

Detach state manager runtime.

kanzi::StateManager::StateManagerRuntime	(	StateManagerSharedPtr	stateManager,
		Domain *	domain,
		Node &	objectNode
	)

inlineexplicitprotected

Constructor.

Parameters

stateManager	State manager this runtime is using.
domain	Domain.
objectNode	Node owning the state manager.

void kanzi::StateManager::removeHandlers ( )

protected

Remove handlers from state manager runtime.

void kanzi::StateManager::unapplyStyles ( )

protected

Unapply and delete styles recursively.

void kanzi::StateManager::stopTransitions ( )

protected

Stop transitions recursively.

void kanzi::StateManager::releaseTargetObjects ( )

protected

Stops tracking target objects.

void kanzi::StateManager::captureTargetObjects ( )

protected

Starts tracking target objects.

Member Data Documentation

PropertyType<bool> kanzi::StateManager::LongestPathProperty

static

LongestPath property.

The default value is false.

See also: setLongestPath(), isLongestPath()

MessageType<GoToStateMessageArguments> kanzi::StateManager::GoToStateMessage

static

MessageType<GoToNextDefinedStateMessageArguments> kanzi::StateManager::GoToNextDefinedStateMessage

static

MessageType<GoToPreviousDefinedStateMessageArguments> kanzi::StateManager::GoToPreviousDefinedStateMessage

static

MessageType<EnteredStateMessageArguments> kanzi::StateManager::EnteredStateMessage

static

MessageType<LeftStateMessageArguments> kanzi::StateManager::LeftStateMessage

static

MessageType<TransitionStartedMessageArguments> kanzi::StateManager::TransitionStartedMessage

static

MessageType<TransitionFinishedMessageArguments> kanzi::StateManager::TransitionFinishedMessage

static

StateGroupContainer kanzi::StateManager::m_groups

protected

Domain* kanzi::StateManager::m_domain

Node& kanzi::StateManager::m_objectNode

StateGroupRuntimeContainer kanzi::StateManager::m_groupRuntimes

StateManagerSharedPtr kanzi::StateManager::m_stateManager

TargetObjectVector kanzi::StateManager::m_targetObjects

protected

Collection of target objects.

Node::MessageSubscriptionToken kanzi::StateManager::m_goToStateMessageSubscription

protected

Subscription to StateManagerGoToState messages.

Node::MessageSubscriptionToken kanzi::StateManager::m_goToNextDefinedStateMessageSubscription

protected

Subscription to StateManagerGoToNextDefinedState messages.

Node::MessageSubscriptionToken kanzi::StateManager::m_goToPreviousDefinedStateMessageSubscription

protected

Subscription to StateManagerGoToPreviousDefinedState messages.

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

kanzi/core.ui/state_manager/state_manager.hpp
kanzi/core.ui/state_manager/state_manager_runtime.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation