All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

Visualization Class CATVRDispatcher

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATVRDispatcher
 

Usage: you must use this class as is. You should never derive it.


public class CATVRDispatcher

Base class for creating device event dispatchers.

CATVRDispatcher supplies the methods to set/unset callbacks on specified device events. You should not directly instantiate this object.


Constructor and Destructor Index


o ~CATVRDispatcher()
Destruct the object.

Method Index


o AddDeviceCallback(CATBaseUnknown*,CATListOfCATVRDeviceEvent&,CATSubscriberMethod,CATSubscriberData)
Puts a Callback on given events.
o RemoveDeviceCallback(CATCallback)
Removes a callback.

Constructor and Destructor


o ~CATVRDispatcher
public virtual ~CATVRDispatcher()
Destruct the object. Deleting this object will remove all remaining callbacks.

Methods


o AddDeviceCallback
public CATCallback AddDeviceCallback(CATBaseUnknown* iClient,
CATListOfCATVRDeviceEvent& iDeviceEventList,
CATSubscriberMethod iMethod,
CATSubscriberData iData=NULL)
Puts a Callback on given events. When the @ref Dispatch method is called and at least one of the events specified in iDeviceEventList was generated by the device drivers since the last Dispatch call, the iMethod is called back with a CATVRNotification as argument. The CATVRNotification offers methods to iterate on all those generated events that had arrived between the current Dispatch and the previous one.
Parameters:
iClient
The object interested in the event
iDeviceEventList
The event types the
CATVRNotification will iterate on.
iMethod
The method to be called back.
iData
The data to sent with the
CATVRNotification. Default value is NULL
Returns:
The callback ID you may use to remove the callback. @see RemoveDeviceCallback.
o RemoveDeviceCallback
public void RemoveDeviceCallback(CATCallback iID)
Removes a callback.
Parameters:
iID
The callback ID. @see AddDeviceCallback.

This object is included in the file: CATVRDispatcher.h
If needed, your Imakefile.mk should include the module: CATVisVR

Copyright © 2003, Dassault Systèmes. All rights reserved.