Inheritance diagram for iVlkTimeline:

Detailed Description

Timeline.

Public Member Functions
virtual vlk::iVlkEntity *	GetEntity () const =0
	Get the time line's entity. {Property}. More...

virtual void	SetName (ni::iHString *ahspName)=0
	Set the name of the timeline. {Property}. More...

virtual ni::iHString *	GetName () const =0
	Get the name of the timeline. {Property}. More...

virtual ni::iAnimationTime *	GetTime () const =0
	Get the timeline's animation time. {Property}. More...

virtual void	SetPlayback (vlk::eVlkPlayback aPlayback)=0
	Set the timeline's playback. {Property}. More...

virtual vlk::eVlkPlayback	GetPlayback () const =0
	Get the timeline's playback. {Property}. More...

virtual ni::tBool	Reset ()=0
	Reset the timeline. More...

virtual void	SetStopWhenReset (ni::tBool abStopWhenReset)=0
	Set whether the timeline should be stopped when reset. {Property}. More...

virtual ni::tBool	GetStopWhenReset () const =0
	Get whether the timeline should be stopped when reset. {Property}. More...

virtual ni::tBool	ClearActions ()=0
	Remove all actions. More...

virtual vlk::iVlkAction *	AddAction (ni::iDataTable *apDT)=0
	Add an action. More...

virtual vlk::iVlkAction *	AddActionBefore (ni::iDataTable *apDT, ni::tU32 anIndex)=0
	Add an action before the specified action. More...

virtual ni::tBool	RemoveAction (vlk::iVlkAction *apAction)=0
	Remove an action. More...

virtual ni::tU32	GetNumActions () const =0
	Get the number of actions. {Property}. More...

virtual vlk::iVlkAction *	GetAction (ni::tU32 anAction) const =0
	Get the action at the specified index. {Property}. More...

virtual ni::tU32	GetActionIndexFromDesc (const ni::iHString *ahspDesc) const =0
	Get an action index from description. {Property}. More...

virtual ni::tBool	MoveActionBefore (ni::tU32 anAction, ni::tU32 anIndex)=0
	Move the action at the specified index before the action with passed index. More...

virtual ni::tBool	Update (ni::tF32 afDeltaTime)=0
	Update the time line. More...

virtual ni::tBool	UpdateFrame ()=0
	Call frame update for all active actions. More...

virtual ni::tBool	Serialize (ni::iDataTable *apDT, ni::tSerializeFlags aFlags)=0
	Serialize the timeline. More...

virtual void	Trigger ()=0
	Trigger the timeline. More...

virtual ni::tBool	SetEventClass (iVlkEventClass *apClass)=0
	Set the timeline's event class. {Property}. More...

virtual iVlkEventClass *	GetEventClass () const =0
	Get the timeline's event class. {Property}. More...

virtual void	NotifyEntityMessage (ni::tU32 aMsg, const ni::Var &avarA, const ni::Var &avarB, ni::tBool abReset)=0
	Notify the event of a message received by the parent entity. More...

virtual ni::tBool	TimelineJumpTo (ni::tF32 afCurrentTime, ni::tI32 anPriority)=0
	Timeline JumpTo. More...

Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...

virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...

virtual tI32	Release ()=0
	Release a reference of the object. More...

virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...

virtual void	Invalidate ()=0
	Invalidate the object. More...

virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...

virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...

virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...

virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual vlk::iVlkEntity* GetEntity ( ) const

pure virtual

Get the time line's entity. {Property}.

virtual void SetName ( ni::iHString * ahspName )

pure virtual

Set the name of the timeline. {Property}.

virtual ni::iHString* GetName ( ) const

pure virtual

Get the name of the timeline. {Property}.

virtual ni::iAnimationTime* GetTime ( ) const

pure virtual

Get the timeline's animation time. {Property}.

virtual void SetPlayback ( vlk::eVlkPlayback aPlayback )

pure virtual

Set the timeline's playback. {Property}.

virtual vlk::eVlkPlayback GetPlayback ( ) const

pure virtual

Get the timeline's playback. {Property}.

virtual ni::tBool Reset ( )

pure virtual

Reset the timeline.

Remarks: Resets all action in the timeline by stopping them all. If SetStopWhenReset() is true the playback is stopped after all the actions are endeded.

virtual void SetStopWhenReset ( ni::tBool abStopWhenReset )

pure virtual

Set whether the timeline should be stopped when reset. {Property}.

virtual ni::tBool GetStopWhenReset ( ) const

pure virtual

Get whether the timeline should be stopped when reset. {Property}.

virtual ni::tBool ClearActions ( )

pure virtual

Remove all actions.

virtual vlk::iVlkAction* AddAction ( ni::iDataTable * apDT )

pure virtual

Add an action.

virtual vlk::iVlkAction* AddActionBefore	(	ni::iDataTable *	apDT,
		ni::tU32	anIndex
	)

pure virtual

Add an action before the specified action.

virtual ni::tBool RemoveAction ( vlk::iVlkAction * apAction )

pure virtual

Remove an action.

virtual ni::tU32 GetNumActions ( ) const

pure virtual

Get the number of actions. {Property}.

virtual vlk::iVlkAction* GetAction ( ni::tU32 anAction ) const

pure virtual

Get the action at the specified index. {Property}.

virtual ni::tU32 GetActionIndexFromDesc ( const ni::iHString * ahspDesc ) const

pure virtual

Get an action index from description. {Property}.

virtual ni::tBool MoveActionBefore	(	ni::tU32	anAction,
		ni::tU32	anIndex
	)

pure virtual

Move the action at the specified index before the action with passed index.

Remarks: The indices should be passed without taking in account the changes made by the move.

virtual ni::tBool Update ( ni::tF32 afDeltaTime )

pure virtual

Update the time line.

virtual ni::tBool UpdateFrame ( )

pure virtual

Call frame update for all active actions.

virtual ni::tBool Serialize	(	ni::iDataTable *	apDT,
		ni::tSerializeFlags	aFlags
	)

pure virtual

Serialize the timeline.

virtual void Trigger ( )

pure virtual

Trigger the timeline.

virtual ni::tBool SetEventClass ( iVlkEventClass * apClass )

pure virtual

Set the timeline's event class. {Property}.

virtual iVlkEventClass* GetEventClass ( ) const

pure virtual

Get the timeline's event class. {Property}.

virtual void NotifyEntityMessage	(	ni::tU32	aMsg,
		const ni::Var &	avarA,
		const ni::Var &	avarB,
		ni::tBool	abReset
	)

pure virtual

Notify the event of a message received by the parent entity.

virtual ni::tBool TimelineJumpTo	(	ni::tF32	afCurrentTime,
		ni::tI32	anPriority
	)

pure virtual

Timeline JumpTo.

Detailed Description

Public Member Functions

Member Function Documentation