TalanSoft Toolkits  201707
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | List of all members
iVlkAction Struct Referenceabstract
Inheritance diagram for iVlkAction:
iUnknown

Detailed Description

Vlk action.

Public Member Functions

virtual vlk::iVlkEntityGetEntity () const =0
 Get the parent entity. {Property}. More...
 
virtual vlk::iVlkTimelineGetTimeline () const =0
 Get the time line to which the action is attached. {Property}. More...
 
virtual ni::iHStringGetName () const =0
 Get the action's name. {Property}. More...
 
virtual void SetDesc (ni::iHString *ahspName)=0
 Set the action description. {Property}. More...
 
virtual ni::iHStringGetDesc () const =0
 Get the action description. {Property}. More...
 
virtual ni::tBool SetIsEnabled (ni::tBool aVal)=0
 Set if the action is enabled. {Property}. More...
 
virtual ni::tBool GetIsEnabled () const =0
 Get if the action is enabled. {Property}. More...
 
virtual vlk::iVlkActionSinkGetSink () const =0
 Get action's sink. {Property}. More...
 
virtual ni::tBool SetStartTime (ni::tF32 aVal)=0
 Set action's start time. {Property}. More...
 
virtual ni::tF32 GetStartTime () const =0
 Get action's start time. {Property}. More...
 
virtual ni::tBool SetEndTime (ni::tF32 aVal)=0
 Set action's end time. {Property}. More...
 
virtual ni::tF32 GetEndTime () const =0
 Get action's end time. {Property}. More...
 
virtual ni::tF32 GetTimeLength () const =0
 Get the time length. {Property}. More...
 
virtual ni::tF32 GetCurrentTime () const =0
 Get the current time. {Property}. More...
 
virtual ni::tF32 GetCurrentTimeNormalized () const =0
 Get the current time normalized . {Property}. More...
 
virtual ni::tF32 GetCurrentTimeRelative () const =0
 Get the current time relative to the time block's start time. {Property}. More...
 
virtual void SetRestart (ni::tBool abRestart)=0
 Set whether the action should be restarted. {Property}. More...
 
virtual ni::tBool GetRestart () const =0
 Get whether the action should be restarted. {Property}. More...
 
virtual ni::tBool SetAnimationKeysSet (ni::iAnimationKeysSet *apKeysSet)=0
 Set the action's animation keys set. {Property}. More...
 
virtual ni::iAnimationKeysSetGetAnimationKeysSet () const =0
 Get the action's animation keys set. {Property}. More...
 
virtual ni::tBool GetIsStarted () const =0
 Get whether the action is started (currently playing). {Property}. More...
 
virtual ni::tBool GetIsUpdated () const =0
 Get whether the action is currently playing and updated. {Property}. 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 iUnknownQueryInterface (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 parent entity. {Property}.

virtual vlk::iVlkTimeline* GetTimeline ( ) const
pure virtual

Get the time line to which the action is attached. {Property}.

virtual ni::iHString* GetName ( ) const
pure virtual

Get the action's name. {Property}.

virtual void SetDesc ( ni::iHString ahspName)
pure virtual

Set the action description. {Property}.

virtual ni::iHString* GetDesc ( ) const
pure virtual

Get the action description. {Property}.

virtual ni::tBool SetIsEnabled ( ni::tBool  aVal)
pure virtual

Set if the action is enabled. {Property}.

virtual ni::tBool GetIsEnabled ( ) const
pure virtual

Get if the action is enabled. {Property}.

virtual vlk::iVlkActionSink* GetSink ( ) const
pure virtual

Get action's sink. {Property}.

virtual ni::tBool SetStartTime ( ni::tF32  aVal)
pure virtual

Set action's start time. {Property}.

virtual ni::tF32 GetStartTime ( ) const
pure virtual

Get action's start time. {Property}.

virtual ni::tBool SetEndTime ( ni::tF32  aVal)
pure virtual

Set action's end time. {Property}.

virtual ni::tF32 GetEndTime ( ) const
pure virtual

Get action's end time. {Property}.

virtual ni::tF32 GetTimeLength ( ) const
pure virtual

Get the time length. {Property}.

virtual ni::tF32 GetCurrentTime ( ) const
pure virtual

Get the current time. {Property}.

virtual ni::tF32 GetCurrentTimeNormalized ( ) const
pure virtual

Get the current time normalized . {Property}.

virtual ni::tF32 GetCurrentTimeRelative ( ) const
pure virtual

Get the current time relative to the time block's start time. {Property}.

virtual void SetRestart ( ni::tBool  abRestart)
pure virtual

Set whether the action should be restarted. {Property}.

Remarks
Once restart has been tried, restart is set to false.
virtual ni::tBool GetRestart ( ) const
pure virtual

Get whether the action should be restarted. {Property}.

virtual ni::tBool SetAnimationKeysSet ( ni::iAnimationKeysSet apKeysSet)
pure virtual

Set the action's animation keys set. {Property}.

virtual ni::iAnimationKeysSet* GetAnimationKeysSet ( ) const
pure virtual

Get the action's animation keys set. {Property}.

virtual ni::tBool GetIsStarted ( ) const
pure virtual

Get whether the action is started (currently playing). {Property}.

virtual ni::tBool GetIsUpdated ( ) const
pure virtual

Get whether the action is currently playing and updated. {Property}.