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

#include <inode_manager.h>

Inheritance diagram for mi::neuraylib::ICluster_property_callback:

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...

Public Member Functions inherited from mi::base::IInterface
virtual Uint32	retain () const =0
	Increments the reference count. More...

virtual Uint32	release () const =0
	Decrements the reference count. More...

virtual const IInterface *	get_interface (const Uuid &interface_id) const =0
	Acquires a const interface from another. More...

template<class T>
const T *	get_interface () const
	Acquires a const interface from another. More...

virtual IInterface *	get_interface (const Uuid &interface_id)=0
	Acquires a mutable interface from another. More...

template<class T>
T *	get_interface ()
	Acquires a mutable interface from another. More...

virtual Uuid	get_iid () const =0
	Returns the interface ID of the most derived interface. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x36a1317b, ... >
typedef Interface_declare< id1, ... >	Self
	Own type. More...

typedef Uuid_t< id1, ... >	IID
	Declares the interface ID (IID) of this interface. More...

Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>	IID
	Declares the interface ID (IID) of this interface. More...

Static Public Member Functions inherited from mi::base::Interface_declare< 0x36a1317b, ... >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID `iid` against the interface ID of this interface and of its ancestors. More...

Static Public Member Functions inherited from mi::base::IInterface
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID `iid` against the interface ID of this interface. 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 SDK 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 the Iray SDK.

See also: mi::neuraylib::INode_manager_cluster

Member Function Documentation

^◆ property_callback()

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.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ property_callback()

^◆ property_callback()