Kanzi  3.9.5
Kanzi Engine API
kanzi::StateManager::StateManagerRuntime Class Reference

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

Public Member Functions

void detach ()
 Detach state manager runtime. More...
 
virtual ~StateManagerRuntime ()
 Destructor. More...
 

Static Public Member Functions

static StateManagerRuntimeSharedPtr create (StateManagerSharedPtr stateManager, Domain *domain, const StateGroupContainer &groups, Node &objectNode)
 Constructor. More...
 

Public Attributes

Domainm_domain
 
StateGroupRuntimeContainer m_groupRuntimes
 
Nodem_objectNode
 
StateManagerSharedPtr m_stateManager
 

Protected Types

typedef shared_ptr< TargetObjectTargetObjectSharedPtr
 
typedef vector< TargetObjectSharedPtrTargetObjectVector
 

Protected Member Functions

void captureTargetObjects ()
 Starts tracking target objects. More...
 
void releaseTargetObjects ()
 Stops tracking target objects. More...
 
void removeHandlers ()
 Remove handlers from state manager runtime. More...
 
 StateManagerRuntime (StateManagerSharedPtr stateManager, Domain *domain, Node &objectNode)
 Constructor. More...
 
void stopTransitions ()
 Stop transitions recursively. More...
 
void unapplyStyles ()
 Unapply and delete styles recursively. More...
 

Protected Attributes

Node::MessageSubscriptionToken m_goToNextDefinedStateMessageSubscription
 Subscription to StateManagerGoToNextDefinedState messages. More...
 
Node::MessageSubscriptionToken m_goToPreviousDefinedStateMessageSubscription
 Subscription to StateManagerGoToPreviousDefinedState messages. More...
 
Node::MessageSubscriptionToken m_goToStateMessageSubscription
 Subscription to StateManagerGoToState messages. More...
 
TargetObjectVector m_targetObjects
 Collection of target objects. More...
 

Member Typedef Documentation

◆ TargetObjectSharedPtr

◆ TargetObjectVector

Constructor & Destructor Documentation

◆ ~StateManagerRuntime()

virtual kanzi::StateManager::StateManagerRuntime::~StateManagerRuntime ( )
virtual

Destructor.

◆ StateManagerRuntime()

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

Constructor.

Parameters
stateManagerState manager this runtime is using.
domainDomain.
objectNodeNode owning the state manager.

Member Function Documentation

◆ create()

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

Constructor.

Parameters
stateManagerState manager this runtime is using.
domainDomain.
groupsList of state groups in state manager.
objectNodeNode owning the state manager.

◆ detach()

void kanzi::StateManager::StateManagerRuntime::detach ( )

Detach state manager runtime.

◆ removeHandlers()

void kanzi::StateManager::StateManagerRuntime::removeHandlers ( )
protected

Remove handlers from state manager runtime.

◆ unapplyStyles()

void kanzi::StateManager::StateManagerRuntime::unapplyStyles ( )
protected

Unapply and delete styles recursively.

◆ stopTransitions()

void kanzi::StateManager::StateManagerRuntime::stopTransitions ( )
protected

Stop transitions recursively.

◆ releaseTargetObjects()

void kanzi::StateManager::StateManagerRuntime::releaseTargetObjects ( )
protected

Stops tracking target objects.

◆ captureTargetObjects()

void kanzi::StateManager::StateManagerRuntime::captureTargetObjects ( )
protected

Starts tracking target objects.

Member Data Documentation

◆ m_domain

Domain* kanzi::StateManager::StateManagerRuntime::m_domain

◆ m_objectNode

Node& kanzi::StateManager::StateManagerRuntime::m_objectNode

◆ m_groupRuntimes

StateGroupRuntimeContainer kanzi::StateManager::StateManagerRuntime::m_groupRuntimes

◆ m_stateManager

StateManagerSharedPtr kanzi::StateManager::StateManagerRuntime::m_stateManager

◆ m_targetObjects

TargetObjectVector kanzi::StateManager::StateManagerRuntime::m_targetObjects
protected

Collection of target objects.

◆ m_goToStateMessageSubscription

Node::MessageSubscriptionToken kanzi::StateManager::StateManagerRuntime::m_goToStateMessageSubscription
protected

Subscription to StateManagerGoToState messages.

◆ m_goToNextDefinedStateMessageSubscription

Node::MessageSubscriptionToken kanzi::StateManager::StateManagerRuntime::m_goToNextDefinedStateMessageSubscription
protected

Subscription to StateManagerGoToNextDefinedState messages.

◆ m_goToPreviousDefinedStateMessageSubscription

Node::MessageSubscriptionToken kanzi::StateManager::StateManagerRuntime::m_goToPreviousDefinedStateMessageSubscription
protected

Subscription to StateManagerGoToPreviousDefinedState messages.


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