MDL SDK API nvidia_logo_transpbg.gif Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::neuraylib::IMdl_resolved_resource Class Referenceabstract

Describes an ordered set of resolved resources (or a failed attempt). More...

Inheritance diagram for mi::neuraylib::IMdl_resolved_resource:
mi::base::Interface_declare< 0x650cbe23, 0xed44, 0x4c2f, 0x9f, 0xbc, 0x3b, 0x64, 0x4a, 0x08, 0x15, 0xa1 > mi::base::IInterface

Public Member Functions

virtual bool has_sequence_marker () const =0
 Indicates whether this resource has a sequence marker. More...
 
virtual Uvtile_mode get_uvtile_mode () const =0
 Returns the uvtile mode for this resource. More...
 
virtual const char * get_mdl_file_path_mask () const =0
 Returns the MDL file path mask for this resource. More...
 
virtual const char * get_filename_mask () const =0
 Returns the absolute resolved filename mask for this resource. More...
 
virtual Size get_count () const =0
 Returns the number of elements of the resolved resource. More...
 
virtual const
IMdl_resolved_resource_element
get_element (Size i) const =0
 Returns the i -th element of the resolved resource, or NULL if i is out of bounds. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x650cbe23, 0xed44, 0x4c2f, 0x9f, 0xbc, 0x3b, 0x64, 0x4a, 0x08, 0x15, 0xa1 >
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< 0x650cbe23, 0xed44, 0x4c2f, 0x9f, 0xbc, 0x3b, 0x64, 0x4a, 0x08, 0x15, 0xa1 >
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

Describes an ordered set of resolved resources (or a failed attempt).

While most resources in MDL can be mapped to exactly one element, some resources like animated textures are mapped to a set of elements.

Member Function Documentation

virtual Size mi::neuraylib::IMdl_resolved_resource::get_count ( ) const
pure virtual

Returns the number of elements of the resolved resource.

virtual const IMdl_resolved_resource_element* mi::neuraylib::IMdl_resolved_resource::get_element ( Size  i) const
pure virtual

Returns the i -th element of the resolved resource, or NULL if i is out of bounds.

Resource elements are sorted by increasing frame numbers.

virtual const char* mi::neuraylib::IMdl_resolved_resource::get_filename_mask ( ) const
pure virtual

Returns the absolute resolved filename mask for this resource.

The filename mask is identical to the filename, except that it contains the uvtile marker if the uvtile mode is not mi::neuraylib::UVTILE_MODE_NONE.

Note
If this resource is located inside a container (an MDL archive or MDLE), the returned string is a concatenation of the container filename, a colon, and the container member name.
See Also
mi::neuraylib::IMdl_resolved_resource_element::get_filename(), get_uvtile_mode()
virtual const char* mi::neuraylib::IMdl_resolved_resource::get_mdl_file_path_mask ( ) const
pure virtual

Returns the MDL file path mask for this resource.

The MDL file path mask is identical to the MDL file path, except that it contains the uvtile marker if the uvtile mode is not mi::neuraylib::UVTILE_MODE_NONE.

See Also
mi::neuraylib::IMdl_resolved_resource_element::get_mdl_file_path(), get_uvtile_mode()
virtual Uvtile_mode mi::neuraylib::IMdl_resolved_resource::get_uvtile_mode ( ) const
pure virtual

Returns the uvtile mode for this resource.

The return value false implies that there is a single uv-tile (per frame) with u- and v- coordinates of 0.

Returns
Always mi::neuraylib::UVTILE_MODE_NONE for light profiles and BSDF measurements.
virtual bool mi::neuraylib::IMdl_resolved_resource::has_sequence_marker ( ) const
pure virtual

Indicates whether this resource has a sequence marker.

The return value false implies that there is a single frame with frame number 0.