Kanzi  3.9.6
Kanzi Engine API
kanzi::StateManager::StateTransitionAnimation Class Reference

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

Public Member Functions

bool equalObjectPath (string_view path) const
 Returns true if parameter is same as the animated property. More...
 
AnimationMode getAnimationMode () const
 Returns animation mode of this transition animation. More...
 
TimelineSharedPtr getCustomAnimation () const
 Returns custom animation of this transition animation. More...
 
EasingArguments getEasingArguments () const
 Gets the easing function arguments. More...
 
AnimationEasingMode getEasingMode () const
 Returns easing mode for this animation. More...
 
string getObjectPath () const
 Gets object path that contains the animated property. More...
 
AbstractPropertyType getPropertyType () const
 Returns property being animated by this transition animation. More...
 
chrono::milliseconds getStartTime () const
 Returns animation start time, in ms. More...
 
bool isLongerPath () const
 Does this transition animation use longer path. More...
 
void setAnimationMode (AnimationMode mode)
 Sets animation mode of this transition animation. More...
 
void setCustomAnimation (TimelineSharedPtr animation)
 Sets custom animation for this transition animation. More...
 
void setEasingArguments (const EasingArguments &easingArguments)
 Sets the easing function arguments. More...
 
void setEasingMode (AnimationEasingMode mode)
 Sets easing mode for this animation. More...
 
void setLongerPath (bool value)
 Sets this transition animation to use longer path. More...
 
void setObjectPath (string_view path)
 Sets object path that contains the animated property. More...
 
void setPropertyType (AbstractPropertyType propertyType)
 Sets property being animated by this transition animation. More...
 
void setStartTime (chrono::milliseconds startTime)
 Sets animation start time, in ms. More...
 
 StateTransitionAnimation ()
 

Static Public Member Functions

static StateTransitionAnimationPtr create ()
 

Constructor & Destructor Documentation

◆ StateTransitionAnimation()

kanzi::StateManager::StateTransitionAnimation::StateTransitionAnimation ( )
inlineexplicit

Member Function Documentation

◆ create()

static StateTransitionAnimationPtr kanzi::StateManager::StateTransitionAnimation::create ( )
static

◆ setStartTime()

void kanzi::StateManager::StateTransitionAnimation::setStartTime ( chrono::milliseconds  startTime)

Sets animation start time, in ms.

◆ getStartTime()

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

Returns animation start time, in ms.

◆ setPropertyType()

void kanzi::StateManager::StateTransitionAnimation::setPropertyType ( AbstractPropertyType  propertyType)

Sets property being animated by this transition animation.

◆ getPropertyType()

AbstractPropertyType kanzi::StateManager::StateTransitionAnimation::getPropertyType ( ) const

Returns property being animated by this transition animation.

◆ getObjectPath()

string kanzi::StateManager::StateTransitionAnimation::getObjectPath ( ) const

Gets object path that contains the animated property.

◆ setObjectPath()

void kanzi::StateManager::StateTransitionAnimation::setObjectPath ( string_view  path)

Sets object path that contains the animated property.

◆ equalObjectPath()

bool kanzi::StateManager::StateTransitionAnimation::equalObjectPath ( string_view  path) const

Returns true if parameter is same as the animated property.

◆ setAnimationMode()

void kanzi::StateManager::StateTransitionAnimation::setAnimationMode ( AnimationMode  mode)

Sets animation mode of this transition animation.

◆ getAnimationMode()

AnimationMode kanzi::StateManager::StateTransitionAnimation::getAnimationMode ( ) const

Returns animation mode of this transition animation.

◆ setEasingArguments()

void kanzi::StateManager::StateTransitionAnimation::setEasingArguments ( const EasingArguments easingArguments)

Sets the easing function arguments.

◆ getEasingArguments()

EasingArguments kanzi::StateManager::StateTransitionAnimation::getEasingArguments ( ) const

Gets the easing function arguments.

◆ setEasingMode()

void kanzi::StateManager::StateTransitionAnimation::setEasingMode ( AnimationEasingMode  mode)

Sets easing mode for this animation.

◆ getEasingMode()

AnimationEasingMode kanzi::StateManager::StateTransitionAnimation::getEasingMode ( ) const

Returns easing mode for this animation.

◆ setCustomAnimation()

void kanzi::StateManager::StateTransitionAnimation::setCustomAnimation ( TimelineSharedPtr  animation)

Sets custom animation for this transition animation.

◆ getCustomAnimation()

TimelineSharedPtr kanzi::StateManager::StateTransitionAnimation::getCustomAnimation ( ) const

Returns custom animation of this transition animation.

◆ setLongerPath()

void kanzi::StateManager::StateTransitionAnimation::setLongerPath ( bool  value)

Sets this transition animation to use longer path.

◆ isLongerPath()

bool kanzi::StateManager::StateTransitionAnimation::isLongerPath ( ) const

Does this transition animation use longer path.


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