neuray API Programmer's Manual

mi::neuraylib::IStruct_category Class Reference

[MDL type system]

Description

Represents the optional struct category for struct types.

Public Enumerations

enum Predefined_id{ CID_USER = -1, CID_MATERIAL_CATEGORY = 0, CID_FORCE_32_BIT = 0x7fffffff}
Identifiers of struct categories.

Public Member Functions

virtual const IAnnotation_blockget_annotations() const =0
Returns the annotations of the struct category type. More...
virtual Predefined_id get_predefined_id() const =0
If this struct category is a predefined one, return its ID, else CID_USER.
virtual const char* get_symbol() const =0
Returns the qualified name of this struct category.

Enums

enum mi::​neuraylib::​IStruct_category::Predefined_id

Identifiers of struct categories.

Enumerator:

CID_USER = -1
A user-defined struct category.
CID_MATERIAL_CATEGORY = 0
The "::material_category" struct category.
CID_FORCE_32_BIT = 0x7fffffff

Member Functions

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