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

Detailed Description

Vlk action sink. {DispatchWrapper}.

Public Member Functions

virtual ni::tBool OnVlkActionSink_Initialize (iVlkAction *apAction)=0
 Initialize the action. More...
 
virtual ni::tBool OnVlkActionSink_Start (iVlkAction *apAction)=0
 The action is started. {Optional}. More...
 
virtual void OnVlkActionSink_End (iVlkAction *apAction)=0
 The action is ended. {Optional}. More...
 
virtual void OnVlkActionSink_Update (iVlkAction *apAction)=0
 Action update. {Optional}. More...
 
virtual void OnVlkActionSink_UpdateFrame (iVlkAction *apAction)=0
 Action update frame. {Optional}. More...
 
virtual ni::tBool OnVlkActionSink_Serialize (iVlkAction *apAction, ni::iDataTable *apDT, ni::tSerializeFlags aFlags)=0
 Serialize the action. {Optional}. More...
 
virtual ni::tBool OnVlkActionSink_AddKey (iVlkAction *apAction, ni::tF32 afKeyTime)=0
 Capture the key at the specified index. {Optional}. 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 ni::tBool OnVlkActionSink_Initialize ( iVlkAction apAction)
pure virtual

Initialize the action.

Remarks
Return false if the action is invalid. {Optional}
virtual ni::tBool OnVlkActionSink_Start ( iVlkAction apAction)
pure virtual

The action is started. {Optional}.

Returns
eFalse if the action has finished and don't need to be updated, else eTrue.
Remarks
Start notification could be requested any time for the action to update its observer status.
virtual void OnVlkActionSink_End ( iVlkAction apAction)
pure virtual

The action is ended. {Optional}.

virtual void OnVlkActionSink_Update ( iVlkAction apAction)
pure virtual

Action update. {Optional}.

virtual void OnVlkActionSink_UpdateFrame ( iVlkAction apAction)
pure virtual

Action update frame. {Optional}.

virtual ni::tBool OnVlkActionSink_Serialize ( iVlkAction apAction,
ni::iDataTable apDT,
ni::tSerializeFlags  aFlags 
)
pure virtual

Serialize the action. {Optional}.

virtual ni::tBool OnVlkActionSink_AddKey ( iVlkAction apAction,
ni::tF32  afKeyTime 
)
pure virtual

Capture the key at the specified index. {Optional}.