You.i Engine
CYIViewController::TimelineHelper Class Reference

Detailed Description

Helper class used to start the begin and end animations of the CYIViewController.

#include <screen/YiViewController.h>

Inheritance diagram for CYIViewController::TimelineHelper:

Public Types

enum  AnimationDirection {
  AnimationDirection::Forward,
  AnimationDirection::Reverse
}
 

Public Member Functions

 TimelineHelper ()
 
virtual ~TimelineHelper ()
 
void SetAnimation (CYIAbstractTimeline *pAnimation, AnimationDirection direction)
 
void Start ()
 
- Public Member Functions inherited from CYISignalHandler
 CYISignalHandler ()
 
 CYISignalHandler (const CYISignalHandler &rSignalHandler)
 
virtual ~CYISignalHandler ()
 
CYISignalHandleroperator= (const CYISignalHandler &rSignalHandler)
 
void MoveToThread (CYIThread *pThread)
 This function allows the user to override the default thread affinity to any CYIThread that may or may not be running. More...
 
CYIThreadHandle GetThreadAffinity () const
 
void SetThreadAffinity (const CYIThreadHandle &rThreadAffinity)
 
virtual bool IsConnected () const
 
virtual bool IsConnected (const CYISignalBase &rSignal) const
 
void Disconnect (CYISignalBase &rSignal)
 
void DisconnectFromAllSignals ()
 
- Public Member Functions inherited from CYIThread::Listener
 Listener ()
 
virtual ~Listener ()
 
virtual void OnThreadStarted (CYIThread *)
 
virtual void OnThreadTerminated (CYIThread *)
 
virtual void OnThreadFinished (CYIThread *)
 

Public Attributes

CYISignal AnimationCompleted
 

Member Enumeration Documentation

◆ AnimationDirection

Enumeration of the directions which a timeline can be playd in.

Enumerator
Forward 

Represents an animation playing from start to end.

Reverse 

Represents an animation playing from end to start.

Constructor & Destructor Documentation

◆ TimelineHelper()

CYIViewController::TimelineHelper::TimelineHelper ( )

◆ ~TimelineHelper()

virtual CYIViewController::TimelineHelper::~TimelineHelper ( )
virtual

Member Function Documentation

◆ SetAnimation()

void CYIViewController::TimelineHelper::SetAnimation ( CYIAbstractTimeline pAnimation,
AnimationDirection  direction 
)

Sets the animation and direction on the helper.

Note
Specifying a nullptr pAnimation will clear the animation.

◆ Start()

void CYIViewController::TimelineHelper::Start ( )

Start playing the animation in the direction specified by SetAnimation(). The AnimationCompleted signal will be emitted when the animation completes.

Note
If no animation is set, the AnimationCompleted will be emitted immediately.

Member Data Documentation

◆ AnimationCompleted

CYISignal CYIViewController::TimelineHelper::AnimationCompleted

Signals that the animation has completed.

See also
Start

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