NVIDIA Iray API Home  Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::neuraylib::ILpe_check_result Class Referenceabstract

This interface represents the return value of mi::neuraylib::IRendering_configuration::check_light_path_expressions(). More...

Inheritance diagram for mi::neuraylib::ILpe_check_result:
Inheritance graph
[legend]

Public Member Functions

virtual Size  get_messages_length () const =0
  Returns the number of error messages represented by this interface. More...
 
virtual Size  get_index (Size i) const =0
  Returns the index of the light path expression in the input array that this error message applies to. More...
 
virtual bool  get_color_expression_flag (Size i) const =0
  Indicates whether the error message applies to the color or alpha expression. More...
 
virtual Size  get_position (Size i) const =0
  Returns the position of the offending character/token in the light path expression identified by get_index(). More...
 
virtual const char *  get_message (Size i) const =0
  Returns an error message describing why the light path expression identified by get_index() is invalid. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0xec3bc890, 0x4ea8, 0x4465, 0x9e, 0x83, 0xd8, 0x41, 0xa8, 0xb4, 0x77, 0x94 >
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< 0xec3bc890, 0x4ea8, 0x4465, 0x9e, 0x83, 0xd8, 0x41, 0xa8, 0xb4, 0x77, 0x94 >
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

This interface represents the return value of mi::neuraylib::IRendering_configuration::check_light_path_expressions().

Member Function Documentation

virtual bool mi::neuraylib::ILpe_check_result::get_color_expression_flag ( Size  i) const
pure virtual

Indicates whether the error message applies to the color or alpha expression.

virtual Size mi::neuraylib::ILpe_check_result::get_index ( Size  i) const
pure virtual

Returns the index of the light path expression in the input array that this error message applies to.

virtual const char* mi::neuraylib::ILpe_check_result::get_message ( Size  i) const
pure virtual

Returns an error message describing why the light path expression identified by get_index() is invalid.

virtual Size mi::neuraylib::ILpe_check_result::get_messages_length ( ) const
pure virtual

Returns the number of error messages represented by this interface.

virtual Size mi::neuraylib::ILpe_check_result::get_position ( Size  i) const
pure virtual

Returns the position of the offending character/token in the light path expression identified by get_index().