Repeats a timeline.
A loop has exactly one child. A repetition number and interval between repetitions can be set. The default is 1 repetition with interval of 0ms. If the child is ommitted no actions are taken.
#include <animation/YiTimelineLoop.h>

Public Member Functions | |
| CYITimelineLoop () | |
| virtual | ~CYITimelineLoop () |
| uint64_t | GetInterval () const |
| uint64_t | GetRepeatCount () const |
| CYIAbstractTimeline * | GetTimeline () const |
| void | SetInterval (uint16_t uMillis) |
| void | SetRepeatCount (uint16_t uCount) |
| void | SetTimeline (CYIAbstractTimeline *pTimeline) |
Public Member Functions inherited from CYIAbstractTimeline | |
| virtual | ~CYIAbstractTimeline () |
| void | Start () |
| void | Finish () |
| void | Pause () |
| void | Continue () |
| void | SetDirection (DIRECTION direction) |
| DIRECTION | GetDirection () const |
| STATUS | GetStatus () const |
| uint64_t | GetStartTime () const |
| uint64_t | GetCurrentTime () const |
| float | GetTimeAsPercentage () const |
| uint64_t | GetTotalTime () const |
| void | SeekToPercentage (float fPercentage) |
| void | SeekToTime (uint64_t uMillis) |
| void | Abort () |
| void | SetDisablesInput (bool bDisablesInput) |
| void | Track () |
| void | Untrack () |
| void | StartForward () |
| void | StartReverse () |
| void | ContinueForward () |
| void | ContinueReverse () |
| void | SetDirectionForward () |
| void | SetDirectionReverse () |
| void | SetFrameModes (YI_FRAME_MODE eStartFrameMode, YI_FRAME_MODE eEndFrameMode) |
| bool | SetSourcePositions (CYISceneNode *pNode, const glm::vec3 &vPosition) |
| bool | ClearSourcePositions (CYISceneNode *pNode) |
| bool | SetTargetPositions (CYISceneNode *pNode, const glm::vec3 &vPosition) |
| bool | ClearTargetPositions (CYISceneNode *pNode) |
| const std::shared_ptr< CYITimelineProxy > & | GetProxy () const |
| void | SetRootNode (CYISceneNode *pRootNode) |
| const std::shared_ptr< CYISceneNodeProxy > & | GetRootNode () const |
Public Member Functions inherited from CYISignalHandler | |
| CYISignalHandler () | |
| CYISignalHandler (const CYISignalHandler &rSignalHandler) | |
| virtual | ~CYISignalHandler () |
| CYISignalHandler & | operator= (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 Member Functions inherited from CYIScriptableRTTIObject | |
| CYIScriptableRTTIObject () | |
| virtual | ~CYIScriptableRTTIObject () |
| virtual const CYIRuntimeTypeInfo * | GetRuntimeTypeInfoForScriptObject () const override |
Public Member Functions inherited from CYIScriptableObject | |
| CYIScriptableObject () | |
| CYIScriptableObject (const CYIScriptableObject &other) | |
| CYIScriptableObject & | operator= (const CYIScriptableObject &other) |
| virtual | ~CYIScriptableObject () |
| CYIBindingImplementation * | GetBindingImplementation () const |
| void | SetBindingImplementation (CYIBindingImplementation *pBindingImplementation) |
Public Attributes | |
| CYISignal | TimelineLooped |
| called whenever a loop completes and the next loop starts More... | |
Public Attributes inherited from CYIAbstractTimeline | |
| CYISignal | Playing |
| called whenever the timeline starts playing (from any position) More... | |
| CYISignal | Paused |
| called whenever the timeline stops playing, including if the timeline execution completes normally More... | |
| CYISignal | Aborted |
| called when the timeline execution is aborted by the Abort() function More... | |
| CYISignal | Started |
| called when playback of the timeline is initiated by one of the Start() functions More... | |
| CYISignal | Completed |
| called when playback of the timeline completes normally (or when the Finish() function is called) More... | |
| CYISignal | PlayingForward |
| same as Playing, but triggered only when direction is forward More... | |
| CYISignal | PlayingReverse |
| same as Playing, but triggered only when direction is reverse More... | |
| CYISignal | PausedForward |
| same as Paused, but triggered only when direction is forward More... | |
| CYISignal | PausedReverse |
| same as Paused, but triggered only when direction is reverse More... | |
| CYISignal | StartedForward |
| same as Started, but triggered only when direction is forward More... | |
| CYISignal | StartedReverse |
| same as Started, but triggered only when direction is reverse More... | |
| CYISignal | CompletedForward |
| same as Completed, but triggered only when direction is forward More... | |
| CYISignal | CompletedReverse |
| same as Completed, but triggered only when direction is reverse More... | |
Additional Inherited Members | |
Public Types inherited from CYIAbstractTimeline | |
| enum | YI_FRAME_MODE { YI_ABSOLUTE, YI_RELATIVE } |
| enum | STATUS { STOPPED, PLAYING } |
| enum | DIRECTION { FORWARD, REVERSE } |
Protected Member Functions inherited from CYIAbstractTimeline | |
| CYIAbstractTimeline (CYIAbstractTimelinePriv *pPriv) | |
Protected Member Functions inherited from CYIScriptableRTTIObject | |
| virtual std::pair< const CYIRuntimeTypeInfo *, const void * > | GetRuntimeTypeInfoWithObject () const =0 |
Protected Attributes inherited from CYIAbstractTimeline | |
| CYIAbstractTimelinePriv * | m_pPriv |
| CYITimelineLoop::CYITimelineLoop | ( | ) |
|
virtual |
| uint64_t CYITimelineLoop::GetInterval | ( | ) | const |
| uint64_t CYITimelineLoop::GetRepeatCount | ( | ) | const |
| CYIAbstractTimeline* CYITimelineLoop::GetTimeline | ( | ) | const |
Returns the child of this loop.
| void CYITimelineLoop::SetInterval | ( | uint16_t | uMillis | ) |
Set the delay between repetitions to uMillis.
| void CYITimelineLoop::SetRepeatCount | ( | uint16_t | uCount | ) |
Set the repetition count to uCount. This is the total number of times the timeline will play. A timeline loop cannot have zero repetitions, therefore a uCount of zero is treated as meaning one repetition.
| void CYITimelineLoop::SetTimeline | ( | CYIAbstractTimeline * | pTimeline | ) |
Sets the child of this loop to pTimeline. Replaces a previous timeline. Set to nullptr to remove the timeline.
| CYISignal CYITimelineLoop::TimelineLooped |
called whenever a loop completes and the next loop starts