Kanzi  3.9.6
Kanzi Engine API
kanzi::PageTransitionCollection::Transition Class Reference

Describes transition from one page to another. More...

#include <kanzi/ui/node/page_transition_collection.hpp>

Public Types

enum  AnimationTarget { PageIn, PageOut }
 Defines target for animation. More...
 
enum  Direction { Bidirectional, Unidirectional }
 Enumeration that describes the direction of the transition. More...
 

Public Member Functions

 Transition ()
 

Public Attributes

TransitionAnimationContainer animationsIn
 Animations in this transition. More...
 
TransitionAnimationContainer animationsOut
 Animations in this transition. More...
 
Direction direction
 Direction of the transition. More...
 
chrono::milliseconds duration
 Duration of the transition in ms. More...
 
string from
 Selection criteria for a state: Path to source page (relative to context). More...
 
string stateId
 Named state for this transition. More...
 
string to
 Selection criteria for a state : Path to target page(relative to context). More...
 

Detailed Description

Describes transition from one page to another.

Member Enumeration Documentation

◆ Direction

Enumeration that describes the direction of the transition.

Enumerator
Bidirectional 

Transition is two-way.

Unidirectional 

Transition is one-way from source to target.

◆ AnimationTarget

Defines target for animation.

Enumerator
PageIn 

Animation targets to item that is transitioning in.

PageOut 

Animation targets to item that is transitioning out.

Constructor & Destructor Documentation

◆ Transition()

kanzi::PageTransitionCollection::Transition::Transition ( )
inlineexplicit

Member Data Documentation

◆ direction

Direction kanzi::PageTransitionCollection::Transition::direction

Direction of the transition.

◆ from

string kanzi::PageTransitionCollection::Transition::from

Selection criteria for a state: Path to source page (relative to context).

◆ to

string kanzi::PageTransitionCollection::Transition::to

Selection criteria for a state : Path to target page(relative to context).

◆ stateId

string kanzi::PageTransitionCollection::Transition::stateId

Named state for this transition.

◆ duration

chrono::milliseconds kanzi::PageTransitionCollection::Transition::duration

Duration of the transition in ms.

◆ animationsIn

TransitionAnimationContainer kanzi::PageTransitionCollection::Transition::animationsIn

Animations in this transition.

◆ animationsOut

TransitionAnimationContainer kanzi::PageTransitionCollection::Transition::animationsOut

Animations in this transition.


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