Inheritance diagram for iAnimationTime:

Detailed Description

Animation time interface.

Public Member Functions
virtual iAnimationTime *	Clone () const =0
	Clone the animation time. More...

virtual void	SetStartTime (tF32 fTime)=0
	Set the start time of the animation. {Property}. More...

virtual tF32	GetStartTime () const =0
	Get the start time of the animation. {Property}. More...

virtual void	SetEndTime (tF32 fTime)=0
	Set the end time of the animation. {Property}. More...

virtual tF32	GetEndTime () const =0
	Get the end time of the animation. {Property}. More...

virtual void	SetCurrentTime (tF32 afTime)=0
	Set the current animation time. More...

virtual tF32	GetCurrentTime () const =0
	Get the current animation time. {Property}. More...

virtual void	SetCurrentTimeNormalized (tF32 afTime)=0
	Set the current animation time. More...

virtual tF32	GetCurrentTimeNormalized () const =0
	Get the current animation time. {Property}. More...

virtual tBool	GetIsActive () const =0
	Check if the time is active. More...

virtual tF32	GetLength () const =0
	Get the length of the time, end-start. {Property}. More...

virtual void	SetSpeed (tF32 afSpeed)=0
	Set the time's speed. More...

virtual tF32	GetSpeed () const =0
	Get the time's speed. {Property}. More...

virtual void	SetLoop (ni::tBool abLoop)=0
	Set whether the animation should loop. {Property}. More...

virtual ni::tBool	GetLoop () const =0
	Get whether the animation should loop. {Property}. More...

virtual void	SetPingPongLoop (ni::tBool abPingPong)=0
	Set if the animation loop should ping-ping. {Property}. More...

virtual ni::tBool	GetPingPongLoop () const =0
	Get if the animation loop should ping-pong. {Property}. More...

virtual void	SetReversed (ni::tBool abReversed)=0
	Set if the animation is reversed, ie time going backward. {Property}. More...

virtual ni::tBool	GetReversed () const =0
	Get if the animation is reversed. {Property}. More...

virtual ni::tBool	UpdateTime (ni::tF32 afDeltaTime)=0
	Update the animation time with the specified delta time. More...

virtual tBool	SerializeDataTable (iDataTable *apDT, tSerializeFlags aFlags)=0
	Serialize the animation time to/from the specified datatable. 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 iAnimationTime* Clone ( ) const

pure virtual

Clone the animation time.

virtual void SetStartTime ( tF32 fTime )

pure virtual

Set the start time of the animation. {Property}.

virtual tF32 GetStartTime ( ) const

pure virtual

Get the start time of the animation. {Property}.

virtual void SetEndTime ( tF32 fTime )

pure virtual

Set the end time of the animation. {Property}.

virtual tF32 GetEndTime ( ) const

pure virtual

Get the end time of the animation. {Property}.

virtual void SetCurrentTime ( tF32 afTime )

pure virtual

Set the current animation time.

Parameters

afTime is the animation time to set. {Property}

virtual tF32 GetCurrentTime ( ) const

pure virtual

Get the current animation time. {Property}.

virtual void SetCurrentTimeNormalized ( tF32 afTime )

pure virtual

Set the current animation time.

Parameters

afTime is the animation time to set.

Remarks: Normalized time is specified between 0 (start time) and 1 (end time). {Property}

virtual tF32 GetCurrentTimeNormalized ( ) const

pure virtual

Get the current animation time. {Property}.

virtual tBool GetIsActive ( ) const

pure virtual

Check if the time is active.

Remarks: The time is considered active if the current time is between the start and ent time inclusive. {Property}

virtual tF32 GetLength ( ) const

pure virtual

Get the length of the time, end-start. {Property}.

virtual void SetSpeed ( tF32 afSpeed )

pure virtual

Set the time's speed.

Parameters

afSpeed is the speed to set, 1 is the original speed, 2 is twice faster, 0.5 half the original speed and so on. {Property}

virtual tF32 GetSpeed ( ) const

pure virtual

Get the time's speed. {Property}.

virtual void SetLoop ( ni::tBool abLoop )

pure virtual

Set whether the animation should loop. {Property}.

virtual ni::tBool GetLoop ( ) const

pure virtual

Get whether the animation should loop. {Property}.

virtual void SetPingPongLoop ( ni::tBool abPingPong )

pure virtual

Set if the animation loop should ping-ping. {Property}.

virtual ni::tBool GetPingPongLoop ( ) const

pure virtual

Get if the animation loop should ping-pong. {Property}.

virtual void SetReversed ( ni::tBool abReversed )

pure virtual

Set if the animation is reversed, ie time going backward. {Property}.

virtual ni::tBool GetReversed ( ) const

pure virtual

Get if the animation is reversed. {Property}.

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

pure virtual

Update the animation time with the specified delta time.

Returns: eFalse if the application should be stopped (is "at the end").

virtual tBool SerializeDataTable	(	iDataTable *	apDT,
		tSerializeFlags	aFlags
	)

pure virtual

Serialize the animation time to/from the specified datatable.

Detailed Description

Public Member Functions

Member Function Documentation