IlvChartDefaultColors Class Reference

Repository of predefined colors. More...

#include <ilviews/charts/display.h>

Public Member Functions
	IlvChartDefaultColors (IlvDisplay *display)
	Constructor. More...
IlvColor *	getColor (IlUInt colNb)
	Returns a predefined color by its number. More...
IlUInt	getNbColors () const
	Returns the number of predefined colors. More...

Detailed Description

Repository of predefined colors.

Library: ilvcharts

This class is used to hold some predefined colors that the displayers can use.

Constructor & Destructor Documentation

IlvChartDefaultColors()

IlvChartDefaultColors::IlvChartDefaultColors

(

IlvDisplay *

display

)

Constructor.

Creates and initializes an instance of IlvChartDefaultColors.

Parameters

display

The display where the predefined colors are allocated.

Member Function Documentation

getColor()

IlvColor* IlvChartDefaultColors::getColor

(

IlUInt

colNb

)

Returns a predefined color by its number.

The result will never be 0 even if colNb is larger than the number of colors: colNb is reduced to its value modulo the number of colors.

Note that the returned IlvColor is not locked.

Parameters

colNb

the index number of the color

Returns

An IlvColor.

getNbColors()

IlUInt IlvChartDefaultColors::getNbColors

(

)

const

Returns the number of predefined colors.

Returns

The number of predefined colors.