Material Definition Language API nvidia_logo_transpbg.gif Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::neuraylib::IAnnotation_block Class Referenceabstract

An annotation block is an array of annotations. More...

Inheritance diagram for mi::neuraylib::IAnnotation_block:
mi::base::Interface_declare< 0x57b0ae97, 0x0815, 0x41e8, 0x89, 0xe7, 0x16, 0xa1, 0x23, 0x86, 0x80, 0x6e > mi::base::IInterface

Public Member Functions

virtual Size get_size () const =0
 Returns the number of annotations in this block. More...
 
virtual const IAnnotationget_annotation (Size index) const =0
 Returns the annotation for index, or NULL if index is out of bounds. More...
 
virtual Sint32 set_annotation (Size index, const IAnnotation *annotation)=0
 Sets an annotation block at a given index. More...
 
virtual Sint32 add_annotation (IAnnotation *annotation)=0
 Adds an annotation at the end of the annotation block. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x57b0ae97, 0x0815, 0x41e8, 0x89, 0xe7, 0x16, 0xa1, 0x23, 0x86, 0x80, 0x6e >
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< 0x57b0ae97, 0x0815, 0x41e8, 0x89, 0xe7, 0x16, 0xa1, 0x23, 0x86, 0x80, 0x6e >
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

An annotation block is an array of annotations.

Annotation blocks can be created with mi::neuraylib::IExpression_factory::create_annotation_block().

Member Function Documentation

virtual Sint32 mi::neuraylib::IAnnotation_block::add_annotation ( IAnnotation annotation)
pure virtual

Adds an annotation at the end of the annotation block.

Returns
- 0: Success.
  • -1: Invalid parameter (NULL pointer).
virtual const IAnnotation* mi::neuraylib::IAnnotation_block::get_annotation ( Size  index) const
pure virtual

Returns the annotation for index, or NULL if index is out of bounds.

virtual Size mi::neuraylib::IAnnotation_block::get_size ( ) const
pure virtual

Returns the number of annotations in this block.

virtual Sint32 mi::neuraylib::IAnnotation_block::set_annotation ( Size  index,
const IAnnotation annotation 
)
pure virtual

Sets an annotation block at a given index.

Returns
- 0: Success.
  • -1: Invalid parameter (NULL pointer).
  • -2: index is out of bounds.