NVIDIA Iray API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::neuraylib::ICluster_property_callback Class Referenceabstract

Abstract interface for signaling changed cluster properties. More...

Inheritance diagram for mi::neuraylib::ICluster_property_callback:
Inheritance graph
[legend]

Public Member Functions

virtual void  property_callback (const ICluster_descriptor *cluster_descriptor, const char *changed_property_name)=0
  This function is called when a cluster property change was communicated. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x36a1317b, 0xfbc1, 0x4ef5, 0xbf, 0x38, 0x57, 0x1a, 0xca, 0x6d, 0x22, 0x9f >
typedef Interface_declare< id1,
id2, id3, id4, id5, id6, id7,
id8, id9, id10, id11,
IInterface
Self
  Own type. More...
 
typedef Uuid_t< id1, id2, id3,
id4, id5, id6, id7, id8, id9,
id10, id11 > 
IID
  Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x36a1317b, 0xfbc1, 0x4ef5, 0xbf, 0x38, 0x57, 0x1a, 0xca, 0x6d, 0x22, 0x9f >
static bool  compare_iid (const Uuid &iid)
  Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 

Detailed Description

Abstract interface for signaling changed cluster properties.

Its aim is to be derived from by the application writer. The concrete implementation can then be registered with the Iray API and will after that be used by the Iray library.

Note
Instances of this interface should not be created on the stack, since this might lead to premature destruction of such instances while still being in use by Iray.
See Also
mi::neuraylib::INode_manager_cluster

Member Function Documentation

virtual void mi::neuraylib::ICluster_property_callback::property_callback ( const ICluster_descriptor cluster_descriptor,
const char *  changed_property_name 
)
pure virtual

This function is called when a cluster property change was communicated.

It should return as soon as possible because it may block further network operations.

Parameters
cluster_descriptor The descriptor of the cluster, containing all properties.
changed_property_name The name of the changed property. This value is NULL if the callback is triggered to communicate the current set of properties instead of a property change.