All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
kanzi::StateManager::StateTransitionAnimation Class Reference

#include <kanzi/state_manager/state_manager.hpp>

Public Member Functions

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

Static Public Member Functions

static
StateTransitionAnimationSharedPtr 
create ()
 

Constructor & Destructor Documentation

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

Member Function Documentation

static StateTransitionAnimationSharedPtr kanzi::StateManager::StateTransitionAnimation::create ( )
static
void kanzi::StateManager::StateTransitionAnimation::setStartTime ( chrono::milliseconds  startTime)

Sets animation start time, in ms.

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

Returns animation start time, in ms.

void kanzi::StateManager::StateTransitionAnimation::setPropertyType ( const KzuPropertyType propertyType)

Sets property being animated by this transition animation.

const KzuPropertyType* kanzi::StateManager::StateTransitionAnimation::getPropertyType ( ) const

Returns property being animated by this transition animation.

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

Gets object path that contains the animated property.

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

Sets object path that contains the animated property.

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

Returns true if parameter is same as the animated property.

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

Sets animation mode of this transition animation.

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

Returns animation mode of this transition animation.

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

Sets easing mode for this animation.

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

Returns easing mode for this animation.

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

Sets custom animation for this transition animation.

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

Returns custom animation of this transition animation.

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

Sets this transition animation to use longer path.

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

Does this transition animation use longer path.


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