Functions

template< class T>

mi::​Sint32 mi::get_value( const mi::​IData* data, T& value) [inline]

Simplifies reading the value of mi::IData into the corresponding classes from the base and math API.

Note:

• If data is of the type "Attachable<String>" and value is of the type a const char*, the method will always read the value, and never the reference (there is not enough context from the types to decide which case is intended). If you want to read the reference you need to use mi::IAttachable::get_reference_name() directly (this case is very rare in practice).

• If data is of the type "Attachable<Ref>" and value is of the type a const char*, the method will always read the reference, and never the value (there is not enough context from the types to decide which case is intended). If you want to read the value you need to use mi::IAttachable::get_value() and then either use mi::get_value() on that pointer or use directly one of the methods offered by that pointer. Typically, this case occurs when getting material or function arguments that identify a texture or a light profile.

This general template handles mi::INumber, and expects one of the following types as second argument:

• bool,

• mi::Sint8, mi::Sint16, mi::Sint32, mi::Sint64,

• mi::Uint8, mi::Uint16, mi::Uint32, mi::Uint64,

• mi::Size, mi::Difference

• mi::Float32, or mi::Float64.

It also handles mi::IEnum and expects an mi::Sint32 argument in that case. Furthermore, it also handles mi::IParameter and mi::ITemporary and expects an mi::Uint32 argument in that case. Finally, it handles attachables.

Parameters

data

The instance of mi::IData to read.

value

The new value will be stored here.

Returns

• 0: Success.
• -1: The dynamic type of data does not match the static type of value.

mi::​Sint32 mi::get_value( const mi::​IData* data, const char*& value) [inline]

This specialization handles mi::IString and mi::IRef (and corresponding attachables). It expects a const char* argument. See mi::get_value() for details.

mi::​Sint32 mi::get_value( const mi::​IData* data, mi::​base::​Uuid& value) [inline]

This specialization handles mi::IUuid. It expects an mi::base::Uuid argument. See mi::get_value() for details.

template< class T, Size>

mi::​Sint32 mi::get_value( const mi::​IData* data, mi::​math::​Vector < T , DIM >& value) [inline]

This specialization handles the vector specializations of mi::ICompound (and corresponding attachables). It expects one of the following specializations of mi::math::Vector as its second argument:

• mi::Boolean_2, mi::Boolean_3, mi::Boolean_4

• mi::Sint32_2, mi::Sint32_3, mi::Sint32_4

• mi::Uint32_2, mi::Uint32_3, mi::Uint32_4

• mi::Float32_2, mi::Float32_3, mi::Float32_4

• mi::Float64_2, mi::Float64_3, mi::Float64_4

See mi::get_value() for details.

template< class T, Size, Size>

mi::​Sint32 mi::get_value( const mi::​IData* data, mi::​math::​Matrix < T , ROW , COL >& value) [inline]

This specialization handles the matrix specializations of mi::ICompound (and corresponding attachables). It expects one of the following specializations of mi::math::Matrix as its second argument:

• mi::Boolean_2_2, mi::Boolean_2_3, ..., mi::Boolean_4_4

• mi::Sint32_2_2, mi::Sint32_2_3, ..., mi::Sint32_4_4

• mi::Uint32_2_2, mi::Uint32_2_3, ..., mi::Uint32_4_4

• mi::Float32_2_2, mi::Float32_2_3,..., mi::Float32_4_4

• mi::Float64_2_2, mi::Float64_2_3,..., mi::Float64_4_4

See mi::get_value() for details.

mi::​Sint32 mi::get_value( const mi::​IData* data, mi::​Color& value) [inline]

This specialization handles mi::IColor and mi::IColor3 (and corresponding attachables). It expects an mi::Color argument. See mi::get_value() for details.

mi::​Sint32 mi::get_value( const mi::​IData* data, mi::​Spectrum& value) [inline]

This specialization handles mi::ISpectrum (and corresponding attachables). It expects an mi::Spectrum argument. See mi::get_value() for details.

mi::​Sint32 mi::get_value( const mi::​IData* data, mi::​Bbox3& value) [inline]

This specialization handles mi::IBbox3. It expects an mi::Bbox3 argument. See mi::get_value() for details.

template< class T>

mi::​Sint32 mi::get_value( const mi::​IData* data, mi::​Size index, T& value) [inline]

This variant handles elements of collections identified via an additional index.

Parameters

data

The instance of mi::IData to read.

index

The index of the affected collection element.

value

The new value will be stored here.

Returns

• 0: Success.
• -1: The dynamic type of data does not match the static type of value.
• -3: The index is not valid.

template< class T>

mi::​Sint32 mi::get_value( const mi::​IData* data, const char* key, T& value) [inline]

This variant handles elements of collections identified via an additional key.

Parameters

data

The instance of mi::IData to read.

key

The key of the affected collection element.

value

The new value will be stored here.

Returns

• 0: Success.
• -1: The dynamic type of data does not match the static type of value.
• -3: The key is not valid.

template< class T>

mi::​Sint32 mi::set_value( mi::​IData* data, const T& value) [inline]

Simplifies setting the value of mi::IData from the corresponding classes from the base and math API.

Note:

• If data is of the type "Attachable<String>" and value is of the type a const char*, the method will always set the value, and never the reference (there is not enough context from the types to decide which case is intended). If you want to set the reference you need to use mi::IAttachable::set_reference() directly (this case is very rare in practice).

• If data is of the type "Attachable<Ref>" and value is of the type a const char*, the method will always set the reference, and never the value (there is not enough context from the types to decide which case is intended). If you want to set the value you need to use mi::IAttachable::get_value() and then either use mi::set_value() on that pointer or use directly one of the methods offered by that pointer. Typically, this case occurs when setting material or function arguments that identify a texture or a light profile.

This general template handles mi::INumber and expects one of the following types as second argument:

• bool,

• mi::Sint8, mi::Sint16, mi::Sint32, mi::Sint64,

• mi::Uint8, mi::Uint16, mi::Uint32, mi::Uint64,

• mi::Size, mi::Difference

• mi::Float32, or mi::Float64.

It also handles mi::IEnum and expects an mi::Sint32 argument in that case. Furthermore, it also handles mi::IParameter and mi::ITemporary and expects an mi::Uint32 argument in that case. Finally, it handles attachables.

Parameters

data

The instance of mi::IData to modify.

value

The new value to be set.

Returns

• 0: Success.
• -1: The dynamic type of data does not match the static type of value.
• -2: The value of value is not valid.

mi::​Sint32 mi::set_value( mi::​IData* data, const char* value) [inline]

This specialization handles mi::IString and mi::IRef (and corresponding attachables). It expects a const char* argument. See mi::set_value() for details.

mi::​Sint32 mi::set_value( mi::​IData* data, const mi::​base::​Uuid& value) [inline]

This specialization handles mi::IUuid. It expects an mi::base::Uuid argument. See mi::set_value() for details.

template< class T, Size>

mi::​Sint32 mi::set_value( mi::​IData* data, const mi::​math::​Vector < T , DIM >& value) [inline]

This specialization handles the vector specializations of mi::ICompound (and corresponding attachables). It expects one of the following specializations of mi::math::Vector as its second argument:

• mi::Boolean_2, mi::Boolean_3, mi::Boolean_4

• mi::Sint32_2, mi::Sint32_3, mi::Sint32_4

• mi::Uint32_2, mi::Uint32_3, mi::Uint32_4

• mi::Float32_2, mi::Float32_3, mi::Float32_4

• mi::Float64_2, mi::Float64_3, mi::Float64_4

See mi::set_value() for details.

template< class T, Size, Size>

mi::​Sint32 mi::set_value( mi::​IData* data, const mi::​math::​Matrix < T , ROW , COL >& value) [inline]

This specialization handles the matrix specializations of mi::ICompound (and corresponding attachables). It expects one of the following specializations of mi::math::Matrix as its second argument:

• mi::Boolean_2_2, mi::Boolean_2_3, ..., mi::Boolean_4_4

• mi::Sint32_2_2, mi::Sint32_2_3, ..., mi::Sint32_4_4

• mi::Uint32_2_2, mi::Uint32_2_3, ..., mi::Uint32_4_4

• mi::Float32_2_2, mi::Float32_2_3,..., mi::Float32_4_4

• mi::Float64_2_2, mi::Float64_2_3,..., mi::Float64_4_4

See mi::set_value() for details.

mi::​Sint32 mi::set_value( mi::​IData* data, const mi::​Color& value) [inline]

This specialization handles mi::IColor and mi::IColor3 (and corresponding attachables). It expects an mi::Color argument. See mi::set_value() for details.

mi::​Sint32 mi::set_value( mi::​IData* data, const mi::​Spectrum& value) [inline]

This specialization handles mi::ISpectrum (and corresponding attachables). It expects an mi::Spectrum argument. See mi::set_value() for details.

mi::​Sint32 mi::set_value( mi::​IData* data, const mi::​Bbox3& value) [inline]

This specialization handles mi::IBbox3. It expects an mi::Bbox3 argument. See mi::set_value() for details.

template< class T>

mi::​Sint32 mi::set_value( mi::​IData* data, mi::​Size index, const T& value) [inline]

This variant handles elements of collections identified via an additional index.

Parameters

data

The instance of mi::IData to modify.

index

The index of the affected collection element.

value

The new value to be set.

Returns

• 0: Success.
• -1: The dynamic type of data does not match the static type of value.
• -2: The value of value is not valid.
• -3: The index or key is not valid for the collection.

template< class T>

mi::​Sint32 mi::set_value( mi::​IData* data, const char* key, const T& value) [inline]

This variant handles elements of collections identified via an additional key.

Parameters

data

The instance of mi::IData to modify.

key

The key of the affected collection element.

value

The new value to be set.

Returns

• 0: Success.
• -1: The dynamic type of data does not match the static type of value.
• -2: The value of value is not valid.
• -3: The key is not valid.