Iray SDK API nvidia_logo_transpbg.gif Up
mi::neuraylib::ICluster_filter Class Referenceabstract

A filter used to decide whether a cluster is eligible to be joined. More...

#include <inode_manager.h>

Inheritance diagram for mi::neuraylib::ICluster_filter:

Public Member Functions

virtual bool is_eligible (const ICluster_descriptor *cluster_descriptor)=0
 Indicates whether a cluster is eligible to be joined. 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 IInterfaceget_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 IInterfaceget_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< 0x63a3ced9, ... >
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< 0x63a3ced9, ... >
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

A filter used to decide whether a cluster is eligible to be joined.

Member Function Documentation

 is_eligible()

virtual bool mi::neuraylib::ICluster_filter::is_eligible ( const ICluster_descriptor cluster_descriptor)
pure virtual

Indicates whether a cluster is eligible to be joined.

Parameters
cluster_descriptorProvides information about the cluster.
Returns
true, if the cluster should be joined, or false otherwise.