IOnDemandInteractiveRenderingClient Class Referenceabstract
Is a client where you get the notifications on demand, they are stored until you ask for them. More...
#include <InteractiveRenderingAPI_Subscription.h>
Inheritance diagram for IOnDemandInteractiveRenderingClient:
Public Member Functions | |
| virtual | ~IOnDemandInteractiveRenderingClient () |
| Destructor. More... | |
| virtual size_t | NumberOfQueuedEvents ()=0 |
| Returns the number of events currently waiting to be processed. More... | |
| virtual void | ProcessEvents (IInteractiveRenderingCallback ¬ificationCallback)=0 |
| This function processes all events currently waiting in the queue. More... | |
| virtual bool | MonitorActiveShadeView (void *userData)=0 |
| Monitor the active view whatever it is : a camera, a viewport or a light. More... | |
| virtual bool | StopMonitoringActiveView (void *userData)=0 |
| Stop monitoring active view. More... | |
| Public Member Functions inherited from IInteractiveRenderingClient | |
| virtual | ~IInteractiveRenderingClient () |
| Destructor. More... | |
| virtual int | VersionNumber () const =0 |
| returns the version number of the notification client More... | |
| virtual void | DebugPrintToFile (FILE *theFile) const =0 |
| Print what's monitored inside the client (debugging purpose) More... | |
Detailed Description
Is a client where you get the notifications on demand, they are stored until you ask for them.
Constructor & Destructor Documentation
◆ ~IOnDemandInteractiveRenderingClient()
|
inlinevirtual |
Destructor.
Member Function Documentation
◆ NumberOfQueuedEvents()
|
pure virtual |
Returns the number of events currently waiting to be processed.
◆ ProcessEvents()
|
pure virtual |
This function processes all events currently waiting in the queue.
The queue is emptied in the process.
- Parameters
-
notificationCallback The callback through which the events are processed, one by one.
◆ MonitorActiveShadeView()
|
pure virtual |
Monitor the active view whatever it is : a camera, a viewport or a light.
This takes care of the lock/unlock view workflow for active shade. Also when the active view is changed to another view, the event is stored until you ask for the updates and the new view is monitored automatically
- Parameters
-
userData an arbitrary pointer which is passed back, with the event, through INotificationCallback.
- Returns
- true if the active view is now monitored, false there was a problem
◆ StopMonitoringActiveView()
|
pure virtual |
Stop monitoring active view.
- Parameters
-
userData the user data passed to the Monitor method.
- Returns
- true if the active view is no longer monitored now, false if there was a problem
