NVIDIA Iray API Home  Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::IColor3 Class Referenceabstract

This interface represents RGB colors. More...

Inheritance diagram for mi::IColor3:
Inheritance graph
[legend]

Public Member Functions

virtual Color_struct  get_value () const =0
  Returns the color represented by this interface. More...
 
virtual void  get_value (Color_struct &value) const =0
  Returns the color represented by this interface. More...
 
virtual void  set_value (const Color_struct &value)=0
  Sets the color represented by this interface. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x1189e839, 0x6d86, 0x4bac, 0xbc, 0x72, 0xb0, 0xc0, 0x2d, 0xa9, 0x3c, 0x6c, ICompound >
typedef Interface_declare< id1,
id2, id3, id4, id5, id6, id7,
id8, id9, id10, id11,
ICompound
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< 0x1189e839, 0x6d86, 0x4bac, 0xbc, 0x72, 0xb0, 0xc0, 0x2d, 0xa9, 0x3c, 0x6c, ICompound >
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

This interface represents RGB colors.

It can be used to represent colors by an interface derived from mi::base::IInterface.

See Also
mi::Color_struct

Member Function Documentation

virtual Color_struct mi::IColor3::get_value ( ) const
pure virtual

Returns the color represented by this interface.

The alpha component of the return value is set to 1.0.

virtual void mi::IColor3::get_value ( Color_struct value) const
pure virtual

Returns the color represented by this interface.

The alpha component of value is set to 1.0.

virtual void mi::IColor3::set_value ( const Color_struct value)
pure virtual

Sets the color represented by this interface.

The alpha component of value is ignored.