Represents the optional struct category for struct types. More...

#include <itype.h>

Inheritance diagram for mi::neuraylib::IStruct_category:

Public Types
enum	Predefined_id : Sint32 { CID_USER = -1 , CID_MATERIAL_CATEGORY = 0 }
	Identifiers of struct categories. More...

Public Types inherited from mi::base::Interface_declare< 0xdc79e614, ... >
using	Self = Interface_declare< id1, ... >
	Own type. More...

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

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

Public Member Functions
virtual const char *	get_symbol () const =0
	Returns the qualified name of this struct category. More...

virtual Predefined_id	get_predefined_id () const =0
	If this struct category is a predefined one, return its ID, else CID_USER. More...

virtual const IAnnotation_block *	get_annotations () const =0
	Returns the annotations of the struct category type. 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
Static Public Member Functions inherited from mi::base::Interface_declare< 0xdc79e614, ... >
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

Represents the optional struct category for struct types.

Member Enumeration Documentation

Identifiers of struct categories.

Enumerator
CID_USER	A user-defined struct category.
CID_MATERIAL_CATEGORY	The `"::material_category"` struct category.

virtual const IAnnotation_block * mi::neuraylib::IStruct_category::get_annotations ( ) const

pure virtual

Returns the annotations of the struct category type.

Returns: The annotations of the struct category type, or nullptr if there are no annotations for the struct category type.

virtual Predefined_id mi::neuraylib::IStruct_category::get_predefined_id ( ) const

pure virtual

If this struct category is a predefined one, return its ID, else CID_USER.

virtual const char * mi::neuraylib::IStruct_category::get_symbol ( ) const

pure virtual

Returns the qualified name of this struct category.