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

State group runtime. More...

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

Public Member Functions

void goToInitialState ()
 Set initial state. More...
 
void goToState (const StateRuntimeSharedPtr &newStateRuntime, bool immediate)
 Go to a state in a state group. More...
 
void stopTransition ()
 
void syncState (bool immediate)
 Sync the state in the state group. More...
 
template<typename T >
void toggleControlPropertyNotificationHandler (Node *node, AbstractPropertyType propertyType, bool add)
 
void toggleControlPropertyNotificationHandler (Node *node, AbstractPropertyType propertyType, bool add)
 
 ~StateGroupRuntime ()
 Destructor. More...
 

Static Public Member Functions

template<typename T >
static void controlPropertyNotificationHandler (PropertyObject &object, const typename PropertyType< T >::Traits::StorageType &, PropertyNotificationReason reason, void *userData)
 
static StateGroupRuntimeSharedPtr create (const StateManagerRuntimeSharedPtr &stateManagerRuntime, StateGroup &stateGroup)
 

Public Attributes

StateRuntimeSharedPtr m_currentStateRuntime
 Current state runtime. More...
 
StateGroupm_group
 State group. More...
 
bool m_inTransition
 Is in transition. More...
 
AbstractPropertyType m_notificationHandlerPropertyType
 Property type the property notification handler has been installed for. More...
 
Statem_previousState
 Previous state. More...
 
StateManagerRuntimeWeakPtr m_stateManagerRuntime
 State manager runtime. More...
 
StateRuntimeContainer m_stateRuntimes
 State runtimes. More...
 
chrono::milliseconds m_transitionBaseTime
 Base transition time in ms. More...
 
TimelinePlaybackSharedPtr m_transitionPlayback
 Transition timeline playback. More...
 

Protected Member Functions

void createAnimation (Object *stateObject, string_view stateObjectPath, AbstractPropertyType propertyType, AbstractPropertyTypeDescriptor::ValueSource *valueSource, chrono::milliseconds start, chrono::milliseconds duration, AnimationMode animationMode, const EasingArguments &easingArguments, AnimationEasingMode easingMode, ParallelTimeline &timeline, bool longerPath)
 Create an animation for a state group. More...
 
void onTransitionFinished (TimelinePlayback &)
 Transition finished message handler. More...
 
void sendTransitionFinished ()
 Dispatches TransitionFinished message on the attached node. More...
 
void sendTransitionStarted ()
 Dispatches TransitionStarted message on the attached node. More...
 
 StateGroupRuntime (const StateManagerRuntimeSharedPtr &stateManagerRuntime, StateGroup &stateGroup)
 

Detailed Description

State group runtime.

Constructor & Destructor Documentation

◆ ~StateGroupRuntime()

kanzi::StateManager::StateGroupRuntime::~StateGroupRuntime ( )

Destructor.

◆ StateGroupRuntime()

kanzi::StateManager::StateGroupRuntime::StateGroupRuntime ( const StateManagerRuntimeSharedPtr stateManagerRuntime,
StateGroup stateGroup 
)
explicitprotected

Member Function Documentation

◆ create()

static StateGroupRuntimeSharedPtr kanzi::StateManager::StateGroupRuntime::create ( const StateManagerRuntimeSharedPtr stateManagerRuntime,
StateGroup stateGroup 
)
static

◆ stopTransition()

void kanzi::StateManager::StateGroupRuntime::stopTransition ( )

◆ goToInitialState()

void kanzi::StateManager::StateGroupRuntime::goToInitialState ( )

Set initial state.

Should be called after creating the state group runtime, after it has been added to group runtimes.

◆ goToState()

void kanzi::StateManager::StateGroupRuntime::goToState ( const StateRuntimeSharedPtr newStateRuntime,
bool  immediate 
)

Go to a state in a state group.

◆ syncState()

void kanzi::StateManager::StateGroupRuntime::syncState ( bool  immediate)

Sync the state in the state group.

◆ controlPropertyNotificationHandler()

template<typename T >
static void kanzi::StateManager::StateGroupRuntime::controlPropertyNotificationHandler ( PropertyObject object,
const typename PropertyType< T >::Traits::StorageType &  ,
PropertyNotificationReason  reason,
void *  userData 
)
static

◆ toggleControlPropertyNotificationHandler() [1/2]

template<typename T >
void kanzi::StateManager::StateGroupRuntime::toggleControlPropertyNotificationHandler ( Node node,
AbstractPropertyType  propertyType,
bool  add 
)

◆ toggleControlPropertyNotificationHandler() [2/2]

void kanzi::StateManager::StateGroupRuntime::toggleControlPropertyNotificationHandler ( Node node,
AbstractPropertyType  propertyType,
bool  add 
)

◆ onTransitionFinished()

void kanzi::StateManager::StateGroupRuntime::onTransitionFinished ( TimelinePlayback )
protected

Transition finished message handler.

◆ createAnimation()

void kanzi::StateManager::StateGroupRuntime::createAnimation ( Object stateObject,
string_view  stateObjectPath,
AbstractPropertyType  propertyType,
AbstractPropertyTypeDescriptor::ValueSource valueSource,
chrono::milliseconds  start,
chrono::milliseconds  duration,
AnimationMode  animationMode,
const EasingArguments easingArguments,
AnimationEasingMode  easingMode,
ParallelTimeline timeline,
bool  longerPath 
)
protected

Create an animation for a state group.

◆ sendTransitionStarted()

void kanzi::StateManager::StateGroupRuntime::sendTransitionStarted ( )
protected

Dispatches TransitionStarted message on the attached node.

◆ sendTransitionFinished()

void kanzi::StateManager::StateGroupRuntime::sendTransitionFinished ( )
protected

Dispatches TransitionFinished message on the attached node.

Member Data Documentation

◆ m_stateManagerRuntime

StateManagerRuntimeWeakPtr kanzi::StateManager::StateGroupRuntime::m_stateManagerRuntime

State manager runtime.

◆ m_group

StateGroup* kanzi::StateManager::StateGroupRuntime::m_group

State group.

◆ m_stateRuntimes

StateRuntimeContainer kanzi::StateManager::StateGroupRuntime::m_stateRuntimes

State runtimes.

◆ m_currentStateRuntime

StateRuntimeSharedPtr kanzi::StateManager::StateGroupRuntime::m_currentStateRuntime

Current state runtime.

◆ m_previousState

State* kanzi::StateManager::StateGroupRuntime::m_previousState

Previous state.

◆ m_transitionPlayback

TimelinePlaybackSharedPtr kanzi::StateManager::StateGroupRuntime::m_transitionPlayback

Transition timeline playback.

◆ m_inTransition

bool kanzi::StateManager::StateGroupRuntime::m_inTransition

Is in transition.

◆ m_transitionBaseTime

chrono::milliseconds kanzi::StateManager::StateGroupRuntime::m_transitionBaseTime

Base transition time in ms.

◆ m_notificationHandlerPropertyType

AbstractPropertyType kanzi::StateManager::StateGroupRuntime::m_notificationHandlerPropertyType

Property type the property notification handler has been installed for.

If no notification handler has been installed, the property type is empty.


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