IlvMapColorModel Class Reference

This class allows mapping from integer values to RGB colors. More...

#include <ilviews/maps/rendering/cmodel.h>

Inheritance diagram for IlvMapColorModel:

Public Member Functions
virtual IlvMapColorModel *	copy () const =0
	Returns a copy of the object. More...
virtual IlUChar	getAlpha (IlInt pixel) const =0
	Returns the Alpha component for the specified pixel value. More...
virtual IlUChar	getBlue (IlInt pixel) const =0
	Returns the Blue component for the specified pixel value. More...
virtual IlUChar	getGreen (IlInt pixel) const =0
	Returns the Green component for the specified pixel value. More...
virtual IlUChar	getRed (IlInt pixel) const =0
	Returns the Red component for the specified pixel value. More...
virtual void	getRGBA (IlInt pixel, IlUChar &red, IlUChar &green, IlUChar &blue, IlUChar &alpha) const
	Returns the RGBA component for this pixel value. More...
virtual IlBoolean	isPersistent () const
	Returns IlTrue if the object can be saved. More...
void	save (IlvOutputFile &file) const
	Saves the object to an IlvOutputFile. More...
virtual void	write (IlvOutputFile &file) const =0
	Writes the color model to an IlvOutputFile. More...

Protected Member Functions
	IlvMapColorModel ()
	Creates an instance of the color model. More...

Detailed Description

This class allows mapping from integer values to RGB colors.

See also

IlvDefaultRasterRenderer Library: ilvmaps

Constructor & Destructor Documentation

IlvMapColorModel()

IlvMapColorModel::IlvMapColorModel ( )

protected

Creates an instance of the color model.

The constructor of this abstract class is protected.

Member Function Documentation

copy()

virtual IlvMapColorModel* IlvMapColorModel::copy ( ) const

pure virtual

Returns a copy of the object.

Returns

The copy of the object.

Implemented in IlvIntervalColorModel.

getAlpha()

virtual IlUChar IlvMapColorModel::getAlpha ( IlInt  pixel ) const

pure virtual

Returns the Alpha component for the specified pixel value.

Returns

The Alpha component for the pixel pixel.

Implemented in IlvIntervalColorModel.

getBlue()

virtual IlUChar IlvMapColorModel::getBlue ( IlInt  pixel ) const

pure virtual

Returns the Blue component for the specified pixel value.

Returns

The Blue component for the pixel pixel.

Implemented in IlvIntervalColorModel.

getGreen()

virtual IlUChar IlvMapColorModel::getGreen ( IlInt  pixel ) const

pure virtual

Returns the Green component for the specified pixel value.

Returns

The Green component for the pixel pixel.

Implemented in IlvIntervalColorModel.

getRed()

virtual IlUChar IlvMapColorModel::getRed ( IlInt  pixel ) const

pure virtual

Returns the Red component for the specified pixel value.

Returns

The Red component for the pixel pixel.

Implemented in IlvIntervalColorModel.

getRGBA()

virtual void IlvMapColorModel::getRGBA ( IlInt  pixel, IlUChar &  red, IlUChar &  green, IlUChar &  blue, IlUChar &  alpha  ) const

virtual

Returns the RGBA component for this pixel value.

Parameters

pixel	The pixel.
red	The returned red component.
green	The returned green component.
blue	The returned blue component.
alpha	The returned alpha component.

isPersistent()

virtual IlBoolean IlvMapColorModel::isPersistent ( ) const

virtual

Returns IlTrue if the object can be saved.

Returns

IlTrue if the object can be saved.

Reimplemented in IlvIntervalColorModel.

save()

void IlvMapColorModel::save

(

IlvOutputFile &

file

)

const

Saves the object to an IlvOutputFile.

Parameters

file	The output file.

write()

virtual void IlvMapColorModel::write ( IlvOutputFile &  file ) const

pure virtual

Writes the color model to an IlvOutputFile.

Parameters

file	The output file.