IlvMapColorModel Class Reference

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

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

Inheritance diagram for IlvMapColorModel:

List of all members.

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

---

Detailed Description

This class allows mapping from integer values to RGB colors.

See also:

IlvDefaultRasterRenderer Library: ilvmaps

---

Constructor & Destructor Documentation

IlvMapColorModel::IlvMapColorModel

(

)

[protected]

Creates an instance of the color model.

The constructor of this abstract class is protected.

---

Member Function Documentation

virtual IlvMapColorModel* IlvMapColorModel::copy

(

)

const [pure virtual]

Returns a copy of the object.

Returns:

The copy of the object.

Implemented in IlvIntervalColorModel.

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.

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.

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.

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.

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.

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.

void IlvMapColorModel::save

(

IlvOutputFile &

file

)

const

Saves the object to an IlvOutputFile.

Parameters:

file

The output file.

virtual void IlvMapColorModel::write

(

IlvOutputFile &

file

)

const [pure virtual]

Writes the color model to an IlvOutputFile.

Parameters:

file

The output file.

Implemented in IlvIntervalColorModel.