mi::IColor3 Class Reference

This interface represents RGB colors. More...

#include <icolor.h>

Inheritance diagram for mi::IColor3:

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...
virtual bool	get_value (Size row, Size column, bool &value) const=0
	Accesses the (row, column)-th element. More...
virtual bool	get_value (Size row, Size column, Sint32 &value) const=0
	Accesses the (row, column)-th element. More...
virtual bool	get_value (Size row, Size column, Uint32 &value) const=0
	Accesses the (row, column)-th element. More...
virtual bool	get_value (Size row, Size column, Float32 &value) const=0
	Accesses the (row, column)-th element. More...
virtual bool	get_value (Size row, Size column, Float64 &value) const=0
	Accesses the (row, column)-th element. More...
template<class T>
T	get_value (Size row, Size column) const
	Accesses the (row, column)-th element. More...
virtual bool	set_value (Size row, Size column, bool value)=0
	Sets the (row, column)-th element to value. More...
virtual bool	set_value (Size row, Size column, Sint32 value)=0
	Sets the (row, column)-th element to value. More...
virtual bool	set_value (Size row, Size column, Uint32 value)=0
	Sets the (row, column)-th element to value. More...
virtual bool	set_value (Size row, Size column, Float32 value)=0
	Sets the (row, column)-th element to value. More...
virtual bool	set_value (Size row, Size column, Float64 value)=0
	Sets the (row, column)-th element to value. More...
Public Member Functions inherited from mi::ICompound
virtual Size	get_number_of_rows () const =0
	Returns the number of rows of the represented matrix or vector. More...
virtual Size	get_number_of_columns () const =0
	Returns the number of columns of the represented matrix. More...
virtual Size	get_length () const =0
	Returns the total number of elements. More...
virtual const char *	get_element_type_name () const =0
	Returns the type name of elements of the compound. More...
virtual bool	get_value (Size row, Size column, bool &value) const =0
	Accesses the (row, column)-th element. More...
virtual bool	get_value (Size row, Size column, Sint32 &value) const =0
	Accesses the (row, column)-th element. More...
virtual bool	get_value (Size row, Size column, Uint32 &value) const =0
	Accesses the (row, column)-th element. More...
virtual bool	get_value (Size row, Size column, Float32 &value) const =0
	Accesses the (row, column)-th element. More...
virtual bool	get_value (Size row, Size column, Float64 &value) const =0
	Accesses the (row, column)-th element. More...
template<class T>
T	get_value (Size row, Size column) const
	Accesses the (row, column)-th element. More...
virtual bool	set_value (Size row, Size column, bool value)=0
	Sets the (row, column)-th element to value. More...
virtual bool	set_value (Size row, Size column, Sint32 value)=0
	Sets the (row, column)-th element to value. More...
virtual bool	set_value (Size row, Size column, Uint32 value)=0
	Sets the (row, column)-th element to value. More...
virtual bool	set_value (Size row, Size column, Float32 value)=0
	Sets the (row, column)-th element to value. More...
virtual bool	set_value (Size row, Size column, Float64 value)=0
	Sets the (row, column)-th element to value. More...
virtual void	get_values (bool *values) const =0
	Accesses the elements of the compound. More...
virtual void	get_values (Sint32 *values) const =0
	Accesses the elements of the compound. More...
virtual void	get_values (Uint32 *values) const =0
	Accesses the elements of the compound. More...
virtual void	get_values (Float32 *values) const =0
	Accesses the elements of the compound. More...
virtual void	get_values (Float64 *values) const =0
	Accesses the elements of the compound. More...
virtual void	set_values (const bool *values)=0
	Sets the elements of the compound. More...
virtual void	set_values (const Sint32 *values)=0
	Sets the elements of the compound. More...
virtual void	set_values (const Uint32 *values)=0
	Sets the elements of the compound. More...
virtual void	set_values (const Float32 *values)=0
	Sets the elements of the compound. More...
virtual void	set_values (const Float64 *values)=0
	Sets the elements of the compound. More...
virtual const base::IInterface *	get_value (const char *key) const=0
	Returns the value for key key. More...
template<class T>
const T *	get_value (const char *key) const
	Returns the value for key key. More...
virtual base::IInterface *	get_value (const char *key)=0
	Returns the value for key key. More...
template<class T>
T *	get_value (const char *key)
	Returns the value for key key. More...
virtual const base::IInterface *	get_value (Size index) const=0
	Returns the value for index index. More...
template<class T>
const T *	get_value (Size index) const
	Returns the value for index index. More...
virtual base::IInterface *	get_value (Size index)=0
	Returns the value for index index. More...
template<class T>
T *	get_value (Size index)
	Returns the value for index index. More...
virtual Sint32	set_value (const char *key, base::IInterface *value)=0
	Stores the value for key key. More...
virtual Sint32	set_value (Size index, base::IInterface *value)=0
	Stores the value for index index. More...
Public Member Functions inherited from mi::IData_collection
virtual Size	get_length () const =0
	Returns the number of values. More...
virtual const char *	get_key (Size index) const =0
	Returns the key corresponding to index. More...
virtual bool	has_key (const char *key) const =0
	Indicates whether the key key exists or not. More...
virtual const base::IInterface *	get_value (const char *key) const =0
	Returns the value for key key. More...
template<class T>
const T *	get_value (const char *key) const
	Returns the value for key key. More...
virtual base::IInterface *	get_value (const char *key)=0
	Returns the value for key key. More...
template<class T>
T *	get_value (const char *key)
	Returns the value for key key. More...
virtual const base::IInterface *	get_value (Size index) const =0
	Returns the value for index index. More...
template<class T>
const T *	get_value (Size index) const
	Returns the value for index index. More...
virtual base::IInterface *	get_value (Size index)=0
	Returns the value for index index. More...
template<class T>
T *	get_value (Size index)
	Returns the value for index index. More...
virtual Sint32	set_value (const char *key, base::IInterface *value)=0
	Stores the value for key key. More...
virtual Sint32	set_value (Size index, base::IInterface *value)=0
	Stores the value for index index. More...
Public Member Functions inherited from mi::IData
virtual const char *	get_type_name () const =0
	Returns the type name. 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< 0x1189e839, ... >
typedef Interface_declare< id1, ... >	Self
	Own type. More...
typedef Uuid_t< id1, ... >	IID
	Declares the interface ID (IID) of this interface. More...
Public Types inherited from mi::base::Interface_declare< 0x65437cd6, ... >
typedef Interface_declare< id1, ... >	Self
	Own type. More...
typedef Uuid_t< id1, ... >	IID
	Declares the interface ID (IID) of this interface. More...
Public Types inherited from mi::base::Interface_declare< 0x1bb2be0f, ... >
typedef Interface_declare< id1, ... >	Self
	Own type. More...
typedef Uuid_t< id1, ... >	IID
	Declares the interface ID (IID) of this interface. More...
Public Types inherited from mi::base::Interface_declare< 0x2e5f84bc, ... >
typedef Interface_declare< id1, ... >	Self
	Own type. More...
typedef Uuid_t< id1, ... >	IID
	Declares the interface ID (IID) of this interface. More...
Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>	IID
	Declares the interface ID (IID) of this interface. More...
Static Public Member Functions inherited from mi::base::Interface_declare< 0x1189e839, ... >
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::Interface_declare< 0x65437cd6, ... >
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::Interface_declare< 0x1bb2be0f, ... >
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::Interface_declare< 0x2e5f84bc, ... >
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

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

get_value() [1/8]

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.

get_value() [2/8]

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.

get_value() [3/8]

template<class T>

T mi::ICompound::get_value ( Size  row, Size  column  ) const

inline

Accesses the (row, column)-th element.

Precondition

row < get_number_of_rows(), column < get_number_of_columns()

get_value() [4/8]

virtual bool mi::ICompound::get_value ( Size  row, Size  column, bool &  value  ) const

virtual

Accesses the (row, column)-th element.

Precondition

row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.

get_value() [5/8]

virtual bool mi::ICompound::get_value ( Size  row, Size  column, Float32 &  value  ) const

virtual

Accesses the (row, column)-th element.

Precondition

row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.

get_value() [6/8]

virtual bool mi::ICompound::get_value ( Size  row, Size  column, Float64 &  value  ) const

virtual

Accesses the (row, column)-th element.

Precondition

row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.

get_value() [7/8]

virtual bool mi::ICompound::get_value ( Size  row, Size  column, Sint32 &  value  ) const

virtual

Accesses the (row, column)-th element.

Precondition

row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.

get_value() [8/8]

virtual bool mi::ICompound::get_value ( Size  row, Size  column, Uint32 &  value  ) const

virtual

Accesses the (row, column)-th element.

Precondition

row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.

set_value() [1/6]

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.

set_value() [2/6]

virtual bool mi::ICompound::set_value ( Size  row, Size  column, bool  value  )

virtual

Sets the (row, column)-th element to value.

Precondition

row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.

set_value() [3/6]

virtual bool mi::ICompound::set_value ( Size  row, Size  column, Float32  value  )

virtual

Sets the (row, column)-th element to value.

Precondition

row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.

set_value() [4/6]

virtual bool mi::ICompound::set_value ( Size  row, Size  column, Float64  value  )

virtual

Sets the (row, column)-th element to value.

Precondition

row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.

set_value() [5/6]

virtual bool mi::ICompound::set_value ( Size  row, Size  column, Sint32  value  )

virtual

Sets the (row, column)-th element to value.

Precondition

row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.

set_value() [6/6]

virtual bool mi::ICompound::set_value ( Size  row, Size  column, Uint32  value  )

virtual

Sets the (row, column)-th element to value.

Precondition

row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.