neuray API Programmer's Manual

mi::neuraylib::IValue_color Class Reference

[MDL type system]

Description

A value of type color.

mi::base::Interface_declare\< ..., neuraylib::IValue_compound \>Mixin class template for deriving new interface declarations. A compound value.A compound value. mi::base::Interface_declare\< ..., neuraylib::IValue \>Mixin class template for deriving new interface declarations. The interface to MDL values.The interface to MDL values. 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 IType_color* get_type() const =0
Returns the type of this value.
virtual const IValue_float* get_value( Size index) const =0
Returns the value at index, or NULL if index is out of bounds.
virtual IValue_float* get_value( Size index) =0
Returns the value at index, or NULL if index is out of bounds.
virtual Sint32 set_value( Size index, IValue_float* value) =0
Sets the value at index. More...

Static Public Variables

static const Kind s_kind = VK_COLOR
The kind of this subclass.

Member Functions

virtual const IType_color* mi::​neuraylib::​IValue_color::get_type() const [pure virtual]

Returns the type of this value.

virtual const IValue_float* mi::​neuraylib::​IValue_color::get_value( Size index) const [pure virtual]

Returns the value at index, or NULL if index is out of bounds.

virtual IValue_float* mi::​neuraylib::​IValue_color::get_value( Size index) [pure virtual]

Returns the value at index, or NULL if index is out of bounds.

virtual Sint32 mi::​neuraylib::​IValue_color::set_value( Size index, IValue_float* value) [pure virtual]

Sets the value at index.

Returns

  • 0: Success.
  • -1: Invalid parameter (NULL pointer).
  • -2: index is out of bounds.

Variables

const Kind mi::​neuraylib::​IValue_color::s_kind = VK_COLOR [static]

The kind of this subclass.