Detailed Description

This kind of timeline group will play its children in parallel, possibly with specified offsets (delays) from the beginning.

Child timelines can be added to this group in any order, order does not matter for execution.

Offsets from the beginning of the group or from the start of another child can be specified. The timeline will start after that time.

#include <animation/YiParallelTimelineGroup.h>

Inheritance diagram for CYIParallelTimelineGroup:

[legend]

Public Member Functions
	CYIParallelTimelineGroup ()

virtual	~CYIParallelTimelineGroup ()

void	AddTimelineWithRelativeOffset (CYIAbstractTimeline pTimeline, const CYIAbstractTimeline pRelativeTimeline, uint64_t uMillis)

void	AddTimelineWithRelativePercentage (CYIAbstractTimeline pTimeline, const CYIAbstractTimeline pRelativeTimeline, float fPercentage)

void	UpdateRelativeOffsetOfTimeline (const CYIAbstractTimeline pTimeline, const CYIAbstractTimeline pRelativeTimeline, uint64_t uMillis)

void	UpdateRelativePercentageOfTimeline (const CYIAbstractTimeline pTimeline, const CYIAbstractTimeline pRelativeTimeline, float fPercentage)

Public Member Functions inherited from CYITimelineGroup
virtual	~CYITimelineGroup ()

void	AddTimeline (CYIAbstractTimeline *pTimeline)

void	AddTimelineWithOffset (CYIAbstractTimeline *pTimeline, uint64_t uMillis)

uint32_t	GetTimelineCount () const

std::vector< CYIAbstractTimeline * >	GetTimelines () const

std::vector< std::pair< CYIAbstractTimeline *, uint64_t > >	GetTimelinesWithOffsets (CYIAbstractTimeline::DIRECTION eDirection=CYIAbstractTimeline::FORWARD) const

uint64_t	GetTimelineOffset (CYIAbstractTimeline *pTimeline, CYIAbstractTimeline::DIRECTION eDirection=CYIAbstractTimeline::FORWARD) const

void	RemoveTimeline (CYIAbstractTimeline *pTimeline)

void	RemoveAllTimelines ()

void	RemoveTimelinesIf (const std::function< bool(CYIAbstractTimeline *)> &predicate)

void	UpdateOffsetOfTimeline (const CYIAbstractTimeline *pTimeline, uint64_t uMillis)

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)

Protected Member Functions
	CYIParallelTimelineGroup (CYIParallelTimelineGroupPriv *pPriv)

Protected Member Functions inherited from CYITimelineGroup
	CYITimelineGroup (CYITimelineGroupPriv *pPriv)

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

Additional Inherited Members
Public Types inherited from CYIAbstractTimeline
enum	YI_FRAME_MODE { YI_ABSOLUTE, YI_RELATIVE }

enum	STATUS { STOPPED, PLAYING }

enum	DIRECTION { FORWARD, REVERSE }

Public Attributes inherited from CYITimelineGroup
CYISignal< CYIAbstractTimeline * >	ChildTimelineCompleted
	called whenever execution of one of the contained timelines completes normally 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...

Protected Attributes inherited from CYIAbstractTimeline
CYIAbstractTimelinePriv *	m_pPriv

Constructor & Destructor Documentation

CYIParallelTimelineGroup::CYIParallelTimelineGroup ( )

virtual CYIParallelTimelineGroup::~CYIParallelTimelineGroup ( )

virtual

CYIParallelTimelineGroup::CYIParallelTimelineGroup ( CYIParallelTimelineGroupPriv * pPriv )

protected

Member Function Documentation

void CYIParallelTimelineGroup::AddTimelineWithRelativeOffset	(	CYIAbstractTimeline *	pTimeline,
		const CYIAbstractTimeline *	pRelativeTimeline,
		uint64_t	uMillis
	)

Finds pRelativeTimeline in the group, and calculates the offset for pTimeline as offset of pRelativeTimeline + uMillis. The offset for pRelativeTimeline is left unchanged.

Adds pTimeline to this group with the offset being this absolute calculated value. If the offset for pRelativeTimeline later changes it will not affect the offset of pTimeline in this group.

If pRelativeTimeline is not found, pTimeline is not added to this group.

void CYIParallelTimelineGroup::AddTimelineWithRelativePercentage	(	CYIAbstractTimeline *	pTimeline,
		const CYIAbstractTimeline *	pRelativeTimeline,
		float	fPercentage
	)

Adds pTimeline with an offset specified as the percentage of the total time of pRelativeTimeline. Calculates the number of milliseconds and behaves exactly like CYIParallelTimelineGroup::AddTimelineWithRelativeOffset

void CYIParallelTimelineGroup::UpdateRelativeOffsetOfTimeline	(	const CYIAbstractTimeline *	pTimeline,
		const CYIAbstractTimeline *	pRelativeTimeline,
		uint64_t	uMillis
	)

Finds pRelativeTimeline in the group, and calculates the offset for pTimeline as offset of pRelativeTimeline + uMillis. The offset for pRelativeTimeline is left unchaged.

Updates the offset of pTimeline to this absolute calculated value. If the offset for pRelativeTimeline later chages it will not affect the offset of pTimeline in this group.

If pRelativeTimeline or pTimeline is not found, the offset of pTimeline is not changed.

void CYIParallelTimelineGroup::UpdateRelativePercentageOfTimeline	(	const CYIAbstractTimeline *	pTimeline,
		const CYIAbstractTimeline *	pRelativeTimeline,
		float	fPercentage
	)

Updates the offset of pTimeline to an offset specified as the percentage of the total time of pRelativeTimeline. Calculates the number of milliseconds and behaves exactly like CYIParallelTimelineGroup::UpdateRelativeOffsetOfTimeline

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

animation/YiParallelTimelineGroup.h

Detailed Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation