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

Static Public Member Functions
static StateTransitionPtr	create ()
	Create a state transition.

Constructor & Destructor Documentation

StateTransition()

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

default

Member Function Documentation

create()

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

static

Create a state transition.

operator=()

StateTransition & kanzi::StateManager::StateTransition::operator= ( StateTransition && other )

default

setStartTime()

void kanzi::StateManager::StateTransition::setStartTime

(

chrono::milliseconds

startTime

)

Sets transition start time, in ms.

getStartTime()

chrono::milliseconds kanzi::StateManager::StateTransition::getStartTime

(

)

const

Returns transition start time, in ms.

setDuration()

void kanzi::StateManager::StateTransition::setDuration

(

chrono::milliseconds

durationMs

)

Sets transition duration, in ms.

getDuration()

chrono::milliseconds kanzi::StateManager::StateTransition::getDuration

(

)

const

Returns transition duration, in ms.

setReturnTimeType()

void kanzi::StateManager::StateTransition::setReturnTimeType

(

TransitionReturnTimeType

type

)

Sets return time type of state transition.

getReturnTimeType()

TransitionReturnTimeType kanzi::StateManager::StateTransition::getReturnTimeType

(

)

const

Returns return time type of state transition.

setFromState()

void kanzi::StateManager::StateTransition::setFromState

(

string_view

name

)

Sets state that acts as origin for this transition.

hasFromState()

bool kanzi::StateManager::StateTransition::hasFromState

(

)

const

Returns true if this transition has origin state.

equalFromState()

bool kanzi::StateManager::StateTransition::equalFromState

(

const StateRuntime &

state

)

const

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

setToState()

void kanzi::StateManager::StateTransition::setToState

(

string_view

name

)

Sets state that acts as target for this transition.

hasToState()

bool kanzi::StateManager::StateTransition::hasToState

(

)

const

Returns true if this transition has target state.

equalToState()

bool kanzi::StateManager::StateTransition::equalToState

(

const StateRuntime &

state

)

const

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

setDefaultAnimationMode()

void kanzi::StateManager::StateTransition::setDefaultAnimationMode

(

AnimationMode

mode

)

Sets default animation mode for this transition.

getDefaultAnimationMode()

AnimationMode kanzi::StateManager::StateTransition::getDefaultAnimationMode

(

)

const

Returns default animation mode for this transition.

setDefaultEasingArguments()

void kanzi::StateManager::StateTransition::setDefaultEasingArguments

(

const EasingArguments &

easingArguments

)

Sets the default easing function arguments.

getDefaultEasingArguments()

EasingArguments kanzi::StateManager::StateTransition::getDefaultEasingArguments

(

)

const

Gets the default easing function arguments.

setDefaultAnimationEasingMode()

void kanzi::StateManager::StateTransition::setDefaultAnimationEasingMode

(

AnimationEasingMode

mode

)

Sets default animation easing mode for this transition.

getDefaultAnimationEasingMode()

AnimationEasingMode kanzi::StateManager::StateTransition::getDefaultAnimationEasingMode

(

)

const

Returns default animation easing mode for this transition.

addTransitionAnimation()

void kanzi::StateManager::StateTransition::addTransitionAnimation

(

StateTransitionAnimationPtr

animation

)

Adds transition animation to transition.

beginAnimations()

StateTransitionAnimationIterator kanzi::StateManager::StateTransition::beginAnimations

(

)

const

Returns iterator to first transition animation.

endAnimations()

StateTransitionAnimationIterator kanzi::StateManager::StateTransition::endAnimations

(

)

const

Returns iterator to last transition animation.

---

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

• kanzi/core.ui/state_manager/state_manager.hpp