neuray API Programmer's Manual

mi::neuraylib::IBsdf_measurement Class Reference

[Miscellaneous]

Description

A scene element that stores measured BSDF data. The measured BSDF is split into the two components for reflection and transmission. Currently, only isotropic data is supported (see the abstract interface mi::neuraylib::IBsdf_isotropic_data). The data can be imported from file or can be passed via the API.

A BSDF measurement appears in the scene as an argument of an MDL function call (see mi::neuraylib::IMdl_function_call) or default argument of an MDL function definition (see mi::neuraylib::IMdl_function_definition). The type of such an argument is "Attachable<Ref<Bsdf_measurement>>" (see mi::IRef and mi::IAttachable).

See also:

mi::neuraylib::IBsdf_isotropic_data, mi::neuraylib::IBsdf_buffer

mi::base::Interface_declare\< ..., neuraylib::IScene_element \>Mixin class template for deriving new interface declarations. Common base interface for all scene elements.Common base interface for all scene elements. mi::base::Interface_declare\< ..., neuraylib::IAttribute_set \>Mixin class template for deriving new interface declarations. The attribute set comprises all attributes attached to a database element.The attribute set comprises all attributes attached to a database element. mi::base::Interface_declare\< ... \>Mixin class template for deriving new interface declarations. The basic extensible interface.The basic extensible interface.

Public Member Functions

virtual const char* get_filename() const =0
Returns the resolved file name of the file containing the BSDF measurement. More...
virtual const char* get_original_filename() const =0
Returns the unresolved file name as passed to reset_file(). More...
virtual const base::​IInterface* get_reflection() const =0
Returns the BSDF data for the reflection. More...
template< class T>const T* get_reflection() const
Returns the BSDF data for reflection. More...
virtual const base::​IInterface* get_transmission() const =0
Returns the BSDF data for transmission. More...
template< class T>const T* get_transmission() const
Returns the BSDF data for transmission. More...
virtual Sint32 reset_file( const char* filename) =0
Resets the underlying file to a new file given by filename. More...
virtual Sint32 set_reflection( const IBsdf_isotropic_data* bsdf_data) =0
Sets the BSDF data for the reflection. More...
virtual Sint32 set_transmission( const IBsdf_isotropic_data* bsdf_data) =0
Sets the BSDF data for transmission. More...

Member Functions

virtual const char* mi::​neuraylib::​IBsdf_measurement::get_filename() const [pure virtual]

Returns the resolved file name of the file containing the BSDF measurement. The method returns NULL if there is no file associated with the BSDF measurement, e.g., after default construction, calls to set_reflection() or set_transmission(), or failures to resolves the file name passed to reset_file().

See also:

get_original_filename()

virtual const char* mi::​neuraylib::​IBsdf_measurement::get_original_filename() const [pure virtual]

Returns the unresolved file name as passed to reset_file(). The method returns NULL after default construction or calls to set_reflection() or set_transmission().

See also:

get_filename()

virtual const base::​IInterface* mi::​neuraylib::​IBsdf_measurement::get_reflection() const [pure virtual]

Returns the BSDF data for the reflection. Note that it is not possible to manipulate the BSDF data.

Returns

The BSDF data for reflection, or NULL if there is none.

template< class T>

const T* mi::​neuraylib::​IBsdf_measurement::get_reflection() const [inline]

Returns the BSDF data for reflection. Note that it is not possible to manipulate the BSDF data.

This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to call mi::base::IInterface::get_interface( const Uuid &) on the returned pointer, since the return type already is a const pointer to the type T specified as template parameter.

Returns

The BSDF data for reflection, or NULL on failure (no BSDF data available or if T does not match the element's type).

virtual const base::​IInterface* mi::​neuraylib::​IBsdf_measurement::get_transmission() const [pure virtual]

Returns the BSDF data for transmission. Note that it is not possible to manipulate the BSDF data.

Returns

The BSDF data for transmission, or NULL if there is none.

template< class T>

const T* mi::​neuraylib::​IBsdf_measurement::get_transmission() const [inline]

Returns the BSDF data for transmission. Note that it is not possible to manipulate the BSDF data.

This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to call mi::base::IInterface::get_interface( const Uuid &) on the returned pointer, since the return type already is a const pointer to the type T specified as template parameter.

Returns

The BSDF data for transmission, or NULL on failure (no BSDF data available or if T does not match the element's type).

virtual Sint32 mi::​neuraylib::​IBsdf_measurement::reset_file( const char* filename) [pure virtual]

Resets the underlying file to a new file given by filename.

Returns

  • 0: Success.
  • -1: Invalid parameters (NULL pointer).
  • -2: Failure to resolve the given filename, e.g., the file does not exist.
  • -3: Invalid file format or invalid filename extension (only .mbsdf is supported).
virtual Sint32 mi::​neuraylib::​IBsdf_measurement::set_reflection( const IBsdf_isotropic_data* bsdf_data) [pure virtual]

Sets the BSDF data for the reflection.

Parameters

bsdf_data
The BSDF data to be used by this BSDF measurement. The value NULL can be used to remove the BSDF data for reflection.

Returns

  • 0: Success.
  • -2: The resolution or type of bsdf_data is invalid.
virtual Sint32 mi::​neuraylib::​IBsdf_measurement::set_transmission( const IBsdf_isotropic_data* bsdf_data) [pure virtual]

Sets the BSDF data for transmission.

Parameters

bsdf_data
The BSDF data to be used by this BSDF measurement. The value NULL can be used to remove the BSDF data for transmission.

Returns

  • 0: Success.
  • -2: The resolution or type of bsdf_data is invalid.