RenderMan API  23.0
RixEventCallbacks Class Referenceabstract

#include <RixEventCallbacks.h>

Inheritance diagram for RixEventCallbacks:
RixInterface

Public Types

enum  Event { k_Scene, k_Render, k_Progress, k_Iteration }
 
typedef void(* Callback) (Event event, void const *eventData, void *clientData)
 
- Public Types inherited from RixInterface
enum  Type {
  k_Float, k_Integer, k_StringV, k_Color,
  k_Normal, k_Vector, k_Point, k_HPoint,
  k_MPoint, k_Matrix
}
 

Public Member Functions

virtual bool RegisterCallback (Event event, Callback cb, void *clientData)=0
 
virtual bool UnregisterCallback (Event event, Callback cb, void *clientData)=0
 
- Public Member Functions inherited from RixInterface
virtual int GetVersion () const
 

Protected Member Functions

 RixEventCallbacks ()
 
- Protected Member Functions inherited from RixInterface
 RixInterface (int version)
 Interfaces should not be constructed by users. More...
 
virtual ~RixInterface ()
 Interfaces should not be deleted by users. More...
 

Additional Inherited Members

- Protected Attributes inherited from RixInterface
int m_version
 Version number of this interface. More...
 

Detailed Description

Definition at line 51 of file RixEventCallbacks.h.

Member Typedef Documentation

◆ Callback

typedef void(* RixEventCallbacks::Callback) (Event event, void const *eventData, void *clientData)

Definition at line 61 of file RixEventCallbacks.h.

Member Enumeration Documentation

◆ Event

Enumerator
k_Scene 
k_Render 

data is integer, 1=create, 0=destroy

k_Progress 

data is integer, 1=begin, 0=end

k_Iteration 

data is integer range 0 to 100

Definition at line 54 of file RixEventCallbacks.h.

Constructor & Destructor Documentation

◆ RixEventCallbacks()

RixEventCallbacks::RixEventCallbacks ( )
inlineprotected

Definition at line 72 of file RixEventCallbacks.h.

Member Function Documentation

◆ RegisterCallback()

virtual bool RixEventCallbacks::RegisterCallback ( Event  event,
Callback  cb,
void *  clientData 
)
pure virtual

Register an event callback returns true on success

◆ UnregisterCallback()

virtual bool RixEventCallbacks::UnregisterCallback ( Event  event,
Callback  cb,
void *  clientData 
)
pure virtual

Un-register an event callback returns true on success


The documentation for this class was generated from the following file: