Kanzi  3.9.7
Kanzi Engine API
kanzi::StateManager::StateTransition Class Reference

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

Public Member Functions

void addTransitionAnimation (StateTransitionAnimationPtr animation)
 Adds transition animation to transition. More...
 
StateTransitionAnimationIterator beginAnimations () const
 Returns iterator to first transition animation. More...
 
StateTransitionAnimationIterator endAnimations () const
 Returns iterator to last transition animation. More...
 
bool equalFromState (const StateRuntime &state) const
 Returns true if state is same as origin of this transition. More...
 
bool equalToState (const StateRuntime &state) const
 Returns true if state is same as target of this transition. More...
 
AnimationEasingMode getDefaultAnimationEasingMode () const
 Returns default animation easing mode for this transition. More...
 
AnimationMode getDefaultAnimationMode () const
 Returns default animation mode for this transition. More...
 
EasingArguments getDefaultEasingArguments () const
 Gets the default easing function arguments. More...
 
chrono::milliseconds getDuration () const
 Returns transition duration, in ms. More...
 
TransitionReturnTimeType getReturnTimeType () const
 Returns return time type of state transition. More...
 
chrono::milliseconds getStartTime () const
 Returns transition start time, in ms. More...
 
bool hasFromState () const
 Returns true if this transition has origin state. More...
 
bool hasToState () const
 Returns true if this transition has target state. More...
 
StateTransitionoperator= (StateTransition &&other)=default
 
void setDefaultAnimationEasingMode (AnimationEasingMode mode)
 Sets default animation easing mode for this transition. More...
 
void setDefaultAnimationMode (AnimationMode mode)
 Sets default animation mode for this transition. More...
 
void setDefaultEasingArguments (const EasingArguments &easingArguments)
 Sets the default easing function arguments. More...
 
void setDuration (chrono::milliseconds durationMs)
 Sets transition duration, in ms. More...
 
void setFromState (string_view name)
 Sets state that acts as origin for this transition. More...
 
void setReturnTimeType (TransitionReturnTimeType type)
 Sets return time type of state transition. More...
 
void setStartTime (chrono::milliseconds startTime)
 Sets transition start time, in ms. More...
 
void setToState (string_view name)
 Sets state that acts as target for this transition. More...
 
 StateTransition (StateTransition &&other)=default
 

Static Public Member Functions

static StateTransitionPtr create ()
 Create a state transition. More...
 

Constructor & Destructor Documentation

kanzi::StateManager::StateTransition::StateTransition ( StateTransition &&  other)
default

Member Function Documentation

static StateTransitionPtr kanzi::StateManager::StateTransition::create ( )
static

Create a state transition.

StateTransition& kanzi::StateManager::StateTransition::operator= ( StateTransition &&  other)
default
void kanzi::StateManager::StateTransition::setStartTime ( chrono::milliseconds  startTime)

Sets transition start time, in ms.

chrono::milliseconds kanzi::StateManager::StateTransition::getStartTime ( ) const

Returns transition start time, in ms.

void kanzi::StateManager::StateTransition::setDuration ( chrono::milliseconds  durationMs)

Sets transition duration, in ms.

chrono::milliseconds kanzi::StateManager::StateTransition::getDuration ( ) const

Returns transition duration, in ms.

void kanzi::StateManager::StateTransition::setReturnTimeType ( TransitionReturnTimeType  type)

Sets return time type of state transition.

TransitionReturnTimeType kanzi::StateManager::StateTransition::getReturnTimeType ( ) const

Returns return time type of state transition.

void kanzi::StateManager::StateTransition::setFromState ( string_view  name)

Sets state that acts as origin for this transition.

bool kanzi::StateManager::StateTransition::hasFromState ( ) const

Returns true if this transition has origin state.

bool kanzi::StateManager::StateTransition::equalFromState ( const StateRuntime state) const

Returns true if state is same as origin of this transition.

void kanzi::StateManager::StateTransition::setToState ( string_view  name)

Sets state that acts as target for this transition.

bool kanzi::StateManager::StateTransition::hasToState ( ) const

Returns true if this transition has target state.

bool kanzi::StateManager::StateTransition::equalToState ( const StateRuntime state) const

Returns true if state is same as target of this transition.

void kanzi::StateManager::StateTransition::setDefaultAnimationMode ( AnimationMode  mode)

Sets default animation mode for this transition.

AnimationMode kanzi::StateManager::StateTransition::getDefaultAnimationMode ( ) const

Returns default animation mode for this transition.

void kanzi::StateManager::StateTransition::setDefaultEasingArguments ( const EasingArguments easingArguments)

Sets the default easing function arguments.

EasingArguments kanzi::StateManager::StateTransition::getDefaultEasingArguments ( ) const

Gets the default easing function arguments.

void kanzi::StateManager::StateTransition::setDefaultAnimationEasingMode ( AnimationEasingMode  mode)

Sets default animation easing mode for this transition.

AnimationEasingMode kanzi::StateManager::StateTransition::getDefaultAnimationEasingMode ( ) const

Returns default animation easing mode for this transition.

void kanzi::StateManager::StateTransition::addTransitionAnimation ( StateTransitionAnimationPtr  animation)

Adds transition animation to transition.

StateTransitionAnimationIterator kanzi::StateManager::StateTransition::beginAnimations ( ) const

Returns iterator to first transition animation.

StateTransitionAnimationIterator kanzi::StateManager::StateTransition::endAnimations ( ) const

Returns iterator to last transition animation.


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