IlvPieChartDataSet Class Reference

Class defining a combined data set used by pie displayers. More...

#include <ilviews/charts/pie.h>

Inheritance diagram for IlvPieChartDataSet:

List of all members.

Public Member Functions
virtual IlUInt	getIndexInCombined (const IlvChartDataSet *dataSet, IlUInt indexInDataSet) const
	Maps a point index in a component data set to an index in the combined data set.
virtual IlUInt	getIndexInDataSet (IlvChartDataSet *&dataSet, IlUInt indexInCombined) const
	Maps a point index in the current combined data set to an index in a component data set.
virtual void	getPoint (IlUInt i, IlvDoublePoint &point) const
	Returns a represented data point.
virtual IlBoolean	retrieveDataSetPoint (IlvChartDataSet *&dataSet, IlUInt ptidx, const IlvDoublePoint &point, IlUInt &dataSetPtIndex, IlvDoublePoint &dataSetPt) const
	Retrieves from a data point of the current combined data set the corresponding data point of a component data set.
virtual void	setDataCount (IlUInt count)
	Sets the number of considered data points from the number of data items considered in the component data sets.
Protected Member Functions
virtual void	computeMinMaxValues (IlvCoordInterval &xRange, IlvCoordInterval &yRange) const
	Computes the abscissa and ordinate bounding values of the managed data.

---

Detailed Description

Class defining a combined data set used by pie displayers.

Library: ilvcharts

This class is a subclass of IlvCombinedChartDataSet that is used by a pie displayer to put the data to be displayed into a format that the displayer can display. A pie-data-set is composed of data points expressed in polar coordinates (theta, rho) computed from the initial data points of the data set the pie displayer has to display. These computed data points lie on the extremities of the arcs of the slices of the pie.

The following example illustrates a pie-data-set. The real data set that is set on a pie displayer is shown in the left column and the pie-data-set that is constructed from this data set is shown in the right column. The starting angle is set to 0 degrees. The angle range is set to 360 degrees. The radius of the pie is set to radius. (See the IlvPieChartDisplayer class to have more information.)

Real data set Pie-data-set (0, 1) (0, radius) (1, 2) (90, radius) (2, 1) (270, radius) - (360, radius)

See also:

IlvCombinedChartDataSet, IlvPieChartDisplayer.

---

Member Function Documentation

virtual void IlvPieChartDataSet::computeMinMaxValues	(	IlvCoordInterval &	xRange,
		IlvCoordInterval &	yRange
	)			const [protected, virtual]

Computes the abscissa and ordinate bounding values of the managed data.

Computes and returns in xRange and yRange the abscissa and ordinate bounding values of the data managed by the current data set.

Parameters:

	xRange	The bounding values for the abscissa of the data managed by the current data set.
	yRange	The bounding values for the ordinate of the data managed by the current data set.

Warning:

[note] This method is called in the IlvChartDataSet::computeBoundingValues method.

Reimplemented from IlvChartDataSet.

virtual IlUInt IlvPieChartDataSet::getIndexInCombined	(	const IlvChartDataSet *	dataSet,
		IlUInt	indexInDataSet
	)			const [virtual]

Maps a point index in a component data set to an index in the combined data set.

Maps the point index indexInDataSet in the data set dataSet to an index in the current combined data set.

Parameters:

	dataSet	The data set considered in the combined data set.
	indexInDataSet	The index of the data point in the data set dataSet.

Warning:

[note] The default implementation returns the same index.

Reimplemented from IlvCombinedChartDataSet.

virtual IlUInt IlvPieChartDataSet::getIndexInDataSet	(	IlvChartDataSet *&	dataSet,
		IlUInt	indexInCombined
	)			const [virtual]

Maps a point index in the current combined data set to an index in a component data set.

Maps the point index indexInCombined in the current combined data set to an index in the corresponding data set among the data sets that make up the current combined data set.

Parameters:

	dataSet	This parameter is set to the corresponding data set in the combined data set.
	indexInCombined	The index of the point in the combined data set.

Warning:

[note] The default implementation returns the same index and set dataSet as the first data set in the combined data set.

Reimplemented from IlvCombinedChartDataSet.

virtual void IlvPieChartDataSet::getPoint	(	IlUInt	i,
		IlvDoublePoint &	point
	)			const [virtual]

Returns a represented data point.

Parameters:

	i	The index of the returned data point.
	point	The returned data point.

Implements IlvChartDataSet.

virtual IlBoolean IlvPieChartDataSet::retrieveDataSetPoint	(	IlvChartDataSet *&	dataSet,
		IlUInt	ptidx,
		const IlvDoublePoint &	point,
		IlUInt &	dataSetPointIndex,
		IlvDoublePoint &	dataSetPoint
	)			const [virtual]

Retrieves from a data point of the current combined data set the corresponding data point of a component data set.

Warning:

[note] If no data set is specified (dataSet is equal to 0), dataSet is set to a default data set which is one of the data sets that make up the current combined data set.

Parameters:

	dataSet	The component data set for which we want to retrieve a data point. This data set is one of the data sets that make up the current combined data set.
	ptidx	The index of the data point of the current combined data set from which we want to retrieve the corresponding point in dataSet.
	point	The point of the current combined data set from which we want to retrieve the corresponding point in dataSet.
	dataSetPointIndex	The index of the retrieved point in the data set dataSet.
	dataSetPoint	The retrieved point in the data set dataSet.

Returns:

IlTrue if the data point has been successfully retrieved and IlFalse otherwise.

Implements IlvCombinedChartDataSet.

virtual void IlvPieChartDataSet::setDataCount

(

IlUInt

count

)

[virtual]

Sets the number of considered data points from the number of data items considered in the component data sets.

Sets the number of data points considered for the current combined data set. This number is set to the number of data points that can be computed from the component data sets when count data items are considered in each component data set.

Parameters:

count

The number of data items considered in the data sets that make up the combined data set.

Reimplemented from IlvCombinedChartDataSet.