MDL SDK API nvidia_logo_transpbg.gif Up
mi::neuraylib::IMdl_module_info Class Referenceabstract

Interface for a graph node representing an MDL module. More...

#include <imdl_discovery_api.h>

Inheritance diagram for mi::neuraylib::IMdl_module_info:

Public Member Functions

virtual Size get_search_path_index () const =0
 Returns the index of the search path where this module has been found. More...
 
virtual const char * get_search_path () const =0
 Returns the search path in the local file system that contains this module. More...
 
virtual const IStringget_resolved_path () const =0
 Returns an absolute path to the module file in the local file system. More...
 
virtual Size get_shadows_count () const =0
 Returns the number of shadows of this module. More...
 
virtual const IMdl_module_infoget_shadow (Size index) const =0
 Returns one of the shadows this module has. More...
 
virtual bool in_archive () const =0
 Returns true if the module has been discovered inside of an archive, false if not. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x22, ... >
typedef Interface_declare< id1, ... > Self
 Own type. More...
 
typedef Uuid_t< id1, ... > IID
 Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x22, ... >
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

Interface for a graph node representing an MDL module.

Member Function Documentation

 get_resolved_path()

virtual const IString * mi::neuraylib::IMdl_module_info::get_resolved_path ( ) const
pure virtual

Returns an absolute path to the module file in the local file system.

 get_search_path()

virtual const char * mi::neuraylib::IMdl_module_info::get_search_path ( ) const
pure virtual

Returns the search path in the local file system that contains this module.

 get_search_path_index()

virtual Size mi::neuraylib::IMdl_module_info::get_search_path_index ( ) const
pure virtual

Returns the index of the search path where this module has been found.

 get_shadow()

virtual const IMdl_module_info * mi::neuraylib::IMdl_module_info::get_shadow ( Size  index) const
pure virtual

Returns one of the shadows this module has.

Parameters
indexIndex in the shadow list of this module.

 get_shadows_count()

virtual Size mi::neuraylib::IMdl_module_info::get_shadows_count ( ) const
pure virtual

Returns the number of shadows of this module.

 in_archive()

virtual bool mi::neuraylib::IMdl_module_info::in_archive ( ) const
pure virtual

Returns true if the module has been discovered inside of an archive, false if not.