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_element Class Referenceabstract

Describes an ordered set of resolved resources elements. More...

Inheritance diagram for mi::neuraylib::IMdl_resolved_resource_element:
mi::base::Interface_declare< 0x0c49fcd6, 0xc675, 0x4ca5, 0xbf, 0xae, 0xb1, 0x59, 0xd9, 0x75, 0x5f, 0xe2 > mi::base::IInterface

Public Member Functions

virtual Size get_frame_number () const =0
 Returns the frame number of this element. More...
 
virtual Size get_count () const =0
 Returns the number of resources for this element. More...
 
virtual const char * get_mdl_file_path (Size i) const =0
 Returns the MDL file path of the i -th resource, or NULL if the index is out of range. More...
 
virtual const char * get_filename (Size i) const =0
 Returns the absolute resolved filename of the i -th resource, or NULL if the index is out of range. More...
 
virtual IReadercreate_reader (Size i) const =0
 Returns a reader for the i -th resource (or NULL if the index is out of range). More...
 
virtual base::Uuid get_resource_hash (Size i) const =0
 Returns the resource hash value for the i -th resource. More...
 
virtual bool get_uvtile_uv (Size i, Sint32 &u, Sint32 &v) const =0
 Returns the u and v tile indices for the i -th resource. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x0c49fcd6, 0xc675, 0x4ca5, 0xbf, 0xae, 0xb1, 0x59, 0xd9, 0x75, 0x5f, 0xe2 >
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< 0x0c49fcd6, 0xc675, 0x4ca5, 0xbf, 0xae, 0xb1, 0x59, 0xd9, 0x75, 0x5f, 0xe2 >
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 elements.

While most resources in MDL can be mapped to exactly one entity, some resources like uvtile textures are mapped to a set of entities.

Member Function Documentation

virtual IReader* mi::neuraylib::IMdl_resolved_resource_element::create_reader ( Size  i) const
pure virtual

Returns a reader for the i -th resource (or NULL if the index is out of range).

The reader needs to support absolute access.

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

Returns the number of resources for this element.

virtual const char* mi::neuraylib::IMdl_resolved_resource_element::get_filename ( Size  i) const
pure virtual

Returns the absolute resolved filename of the i -th resource, or NULL if the index is out of range.

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::get_filename_mask()
virtual Size mi::neuraylib::IMdl_resolved_resource_element::get_frame_number ( ) const
pure virtual

Returns the frame number of this element.

Returns
Always 0 for textures without frame index, and for light profiles and BSDF measurements.
virtual const char* mi::neuraylib::IMdl_resolved_resource_element::get_mdl_file_path ( Size  i) const
pure virtual

Returns the MDL file path of the i -th resource, or NULL if the index is out of range.

See Also
mi::neuraylib::IMdl_resolved_resource::get_mdl_file_path_mask()
virtual base::Uuid mi::neuraylib::IMdl_resolved_resource_element::get_resource_hash ( Size  i) const
pure virtual

Returns the resource hash value for the i -th resource.

Returns
The hash value of the i -th resource, or a zero-initialized value if the hash value is unknown or the index is out of range.
virtual bool mi::neuraylib::IMdl_resolved_resource_element::get_uvtile_uv ( Size  i,
Sint32 u,
Sint32 v 
) const
pure virtual

Returns the u and v tile indices for the i -th resource.

Parameters
[in]iThe index of the resource.
[out]uThe u coordinate of the resource.
[out]vThe v coordinate of the resource.
Returns
true if the uvtile mode is not mi::neuraylib::UVTILE_MODE_NONE and i is in range, false otherwise (and the output values are undefined).