Detailed Description

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>

Inheritance diagram for CYITimelineLoop:

[legend]

Public Member Functions
	CYITimelineLoop ()

virtual	~CYITimelineLoop ()

uint64_t	GetInterval () const

uint64_t	GetRepeatCount () const

CYIAbstractTimeline *	GetTimeline () const

void	SetInterval (uint16_t millis)

void	SetRepeatCount (uint16_t count)

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 percentage)

void	SeekToTime (uint64_t millis)

void	Abort ()

void	SetDisablesInput (bool disablesInput)

void	Track ()

void	Untrack ()

void	StartForward ()

void	StartReverse ()

void	ContinueForward ()

void	ContinueReverse ()

void	SetDirectionForward ()

void	SetDirectionReverse ()

void	SetFrameModes (FrameMode startFrameMode, FrameMode endFrameMode)

bool	SetSourcePositions (CYISceneNode *pNode, const glm::vec3 &position)

bool	ClearSourcePositions (CYISceneNode *pNode)

bool	SetTargetPositions (CYISceneNode *pNode, const glm::vec3 &position)

bool	ClearTargetPositions (CYISceneNode *pNode)

bool	SetSourceScales (CYISceneNode *pNode, const glm::vec3 &scale)

bool	ClearSourceScales (CYISceneNode *pNode)

void	SetLooping (bool isLooping)

bool	GetLooping () const

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 *)

Additional Inherited Members
Public Types inherited from CYIAbstractTimeline
enum	FrameMode : uint8_t { FrameMode::Absolute, FrameMode::Relative }

enum	Status : uint8_t { Status::Stopped, Status::Playing }

enum	Direction : uint8_t { Direction::Forward, Direction::Reverse }

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	TimelineLooped
	called whenever a loop completes and the next loop starts 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...

Protected Member Functions inherited from CYIAbstractTimeline
	CYIAbstractTimeline (std::unique_ptr< CYIAbstractTimelinePriv > pPriv)

Protected Attributes inherited from CYIAbstractTimeline
std::unique_ptr< CYIAbstractTimelinePriv >	m_pPriv

Constructor & Destructor Documentation

◆ CYITimelineLoop()

CYITimelineLoop::CYITimelineLoop ( )

◆ ~CYITimelineLoop()

virtual CYITimelineLoop::~CYITimelineLoop ( )

virtual

Member Function Documentation

◆ GetInterval()

uint64_t CYITimelineLoop::GetInterval ( ) const

See also: SetInterval

◆ GetRepeatCount()

uint64_t CYITimelineLoop::GetRepeatCount ( ) const

See also: SetRepeatCount

◆ GetTimeline()

CYIAbstractTimeline* CYITimelineLoop::GetTimeline ( ) const

Returns the child of this loop.

◆ SetInterval()

void CYITimelineLoop::SetInterval ( uint16_t millis )

Set the delay between repetitions to millis.

◆ SetRepeatCount()

void CYITimelineLoop::SetRepeatCount ( uint16_t count )

Set the repetition count to count. This is the total number of times the timeline will play. A timeline loop cannot have zero repetitions, therefore a count of zero is treated as meaning one repetition.

◆ SetTimeline()

void CYITimelineLoop::SetTimeline ( CYIAbstractTimeline * pTimeline )

Sets the child of this loop to pTimeline. Replaces a previous timeline. Set to nullptr to remove the timeline.

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

animation/YiTimelineLoop.h