mi::neuraylib::IMdl_resolved_resource Class Reference

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

#include <imdl_entity_resolver.h>

Inheritance diagram for mi::neuraylib::IMdl_resolved_resource:

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 absolute 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. More...
Public Member Functions inherited from mi::base::IInterface
virtual Uint32	retain () const =0
	Increments the reference count. More...
virtual Uint32	release () const =0
	Decrements the reference count. More...
virtual const IInterface *	get_interface (const Uuid &interface_id) const =0
	Acquires a const interface from another. More...
template<class T>
const T *	get_interface () const
	Acquires a const interface from another. More...
virtual IInterface *	get_interface (const Uuid &interface_id)=0
	Acquires a mutable interface from another. More...
template<class T>
T *	get_interface ()
	Acquires a mutable interface from another. More...
virtual Uuid	get_iid () const =0
	Returns the interface ID of the most derived interface. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x650cbe23, ... >
using	Self = Interface_declare< id1, ... >
	Own type. More...
using	IID = Uuid_t< id1, ... >
	Declares the interface ID (IID) of this interface. More...
Public Types inherited from mi::base::IInterface
using	IID = Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>
	Declares the interface ID (IID) of this interface. More...
Static Public Member Functions inherited from mi::base::Interface_declare< 0x650cbe23, ... >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
Static Public Member Functions inherited from mi::base::IInterface
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface. More...

Detailed Description

Describes an ordered set of resolved resource elements.

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

get_count()

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

pure virtual

Returns the number of elements of the resolved resource.

Returns

The number of frames for animated textures. Always 1 for non-animated textures, and for light profiles and BSDF measurements.

get_element()

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.

Resource elements are sorted by increasing frame numbers.

Parameters

i	The index of the requested resource element (from 0 to get_count()-1).

Returns

The requested resource element, or nullptr if i is out of bounds.

get_filename_mask()

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 frame sequence marker instead of specific frame number (if has_sequence_marker() returns true), and
• the uvtile marker instead of specific uv-coordinates (if get_uvtile_mode() does not return 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(), has_sequence_marker()

get_mdl_file_path_mask()

virtual const char * mi::neuraylib::IMdl_resolved_resource::get_mdl_file_path_mask ( ) const

pure virtual

Returns the absolute MDL file path mask for this resource.

The MDL file path mask is identical to the MDL file path, except that it contains

• the frame sequence marker instead of specific frame number (if has_sequence_marker() returns true), and
• the uvtile marker instead of specific uv-coordinates (if get_uvtile_mode() does not return mi::neuraylib::UVTILE_MODE_NONE).

See also

mi::neuraylib::IMdl_resolved_resource_element::get_mdl_file_path(), get_uvtile_mode(), has_sequence_marker()

get_uvtile_mode()

virtual Uvtile_mode mi::neuraylib::IMdl_resolved_resource::get_uvtile_mode ( ) const

pure virtual

Returns the uvtile mode for this resource.

Returns

Always mi::neuraylib::UVTILE_MODE_NONE non-uvtile textures, and for light profiles and BSDF measurements. The return value mi::neuraylib::UVTILE_MODE_NONE implies that mi::neuraylib::IMdl_resolved_resource_element::get_count() returns 1 for all resource elements of this resource, i.e., there is a single resource entity per resource element.

has_sequence_marker()

virtual bool mi::neuraylib::IMdl_resolved_resource::has_sequence_marker ( ) const

pure virtual

Indicates whether this resource has a sequence marker.

Returns

Always false for non-animated textures, and for light profiles and BSDF measurements. The return value false implies that get_count() returns 1, i.e., there is a single resource element.