Views
Charts Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvChartPointsFilter Class Reference

Utility class for displaying data points. More...

#include <ilviews/charts/display.h>

Inheritance diagram for IlvChartPointsFilter:
IlvChartDisplayerPoints

Public Member Functions

 IlvChartPointsFilter (const IlvChartGraphic *chart, const IlvSingleChartDisplayer *displayer, IlvDim clusterSize=2)
 Constructor. More...
 
IlvDim getClusterSize () const
 Returns the minimum distance between two consecutive displayed points. More...
 
virtual IlBoolean init (IlUInt count, const IlvDoublePoint *dataPoints, const IlUInt *dataPtIdxes, const IlvCoordInterval &abscissaRange, IlBoolean shiftOfCycleLength, const IlvTransformer *t)
 Initializes the current object with a set of data points to project. More...
 
void setClusterSize (IlvDim size)
 Sets the minimum distance between two consecutive displayed points. More...
 
- Public Member Functions inherited from IlvChartDisplayerPoints
 IlvChartDisplayerPoints (const IlvChartDisplayerPoints &displayerPoints)
 Constructor. More...
 
 IlvChartDisplayerPoints (const IlvChartGraphic *chart, const IlvSingleChartDisplayer *displayer, IlBoolean outOfRange=IlTrue)
 Constructor. More...
 
virtual ~IlvChartDisplayerPoints ()
 Destructor. More...
 
void addPoint (const IlvPoint &point, IlUInt dataPtIdx=IlvBadIndex)
 Adds a projected point and its corresponding data point index. More...
 
IlDouble averageSpaceBetweenDataPoints () const
 Returns the average space between points. More...
 
void boundingBoxOfPoints (IlvRect &bbox) const
 Returns the bounding box of the projected points stored in this object. More...
 
virtual IlvChartDisplayerPointscopy () const
 Virtual copy constructor. More...
 
const IlvChartGraphicgetChartGraphic () const
 Returns the associated chart. More...
 
void getDataPoint (IlUInt index, IlvDoublePoint &point) const
 Returns a data point. More...
 
IlUInt getDataPointIndex (IlUInt index) const
 Returns the corresponding data point index of a projected point. More...
 
const IlvSingleChartDisplayergetDisplayer () const
 Returns the associated displayer. More...
 
const IlUIntgetInternalPointIndexes (IlUInt &count) const
 Returns the data point indexes stored in this object. More...
 
const IlvPointgetInternalPoints (IlUInt &count) const
 Returns the projected points stored in this object. More...
 
void getPoint (IlUInt index, IlvPoint &point) const
 Returns a data point. More...
 
void getPoint (IlUInt index, IlvPoint &point, IlUInt &dataPtIdx) const
 Returns a projected point and its corresponding data point index. More...
 
virtual IlvPalettegetPointPalette (IlUInt index, IlBoolean usePointInfo=IlTrue, IlvPalette *defaultPalette=0) const
 Returns the palette that must be used to draw a projected point. More...
 
IlvPointgetPoints (IlUInt &count) const
 Returns a copy of the projected points. More...
 
IlUInt getPointsCount () const
 Returns the number of projected points stored in this object. More...
 
void handleOutOfRangePoints (IlBoolean b)
 Specifies whether specific computations are done for out-of-range points. More...
 
void insertPoint (const IlvPoint &point, IlUInt dataPtIdx=IlvBadIndex, IlUInt position=0)
 Inserts a projected point and its corresponding data point index. More...
 
virtual void insertPoints (IlUInt count, const IlvPoint *points, const IlUInt *dataPtIdxes=0, IlUInt position=0)
 Inserts an array of projected points and their corresponding data point indexes. More...
 
IlBoolean isCyclic () const
 Indicates whether specific computations are done for out-of-range points.
 
IlBoolean isHandlingOutOfRangePoints () const
 Indicates whether specific computations are done for out-of-range points. More...
 
IlBoolean isProjectedOnLimits (IlUInt index) const
 Indicates whether a projected point has been projected on the boundary of the data display area. More...
 
virtual IlBoolean removePoint (IlUInt index)
 Removes a projected point. More...
 
virtual void removePoints ()
 Removes all the projected points stored in this object. More...
 
void setChartGraphic (const IlvChartGraphic *chart)
 Sets the associated chart. More...
 
void setDisplayer (const IlvSingleChartDisplayer *displayer)
 Sets the associated displayer. More...
 
virtual void setPoint (IlUInt index, const IlvPoint &point, IlUInt dataPtIdx=IlvBadIndex)
 Modifies a projected point and its corresponding data point index. More...
 
void setProjectedOnLimits (IlUInt index, IlBoolean flag)
 Specifies whether a projected point has been projected on the boundary of the data display area. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IlvChartDisplayerPoints
virtual void projectOutOfBoundOnLimits (const IlvTransformer *t=0)
 Projects the projected points on the boundary when these points are out-of-bounds. More...
 

Detailed Description

Utility class for displaying data points.

Library: ilvcharts

This class is a subclass of IlvChartDisplayerPoints that allows you to filter the points to display.

See also
IlvChartDisplayerPoints.

Constructor & Destructor Documentation

◆ IlvChartPointsFilter()

IlvChartPointsFilter::IlvChartPointsFilter ( const IlvChartGraphic chart,
const IlvSingleChartDisplayer displayer,
IlvDim  clusterSize = 2 
)

Constructor.

Initializes a new IlvChartPointsFilter instance.

Parameters
chartThe associated chart.
displayerThe associated displayer.
clusterSizeThe minimum distance between two consecutive displayed points.

Member Function Documentation

◆ getClusterSize()

IlvDim IlvChartPointsFilter::getClusterSize ( ) const

Returns the minimum distance between two consecutive displayed points.

Returns
The minimum distance between two consecutive displayed points.

◆ init()

virtual IlBoolean IlvChartPointsFilter::init ( IlUInt  count,
const IlvDoublePoint dataPoints,
const IlUInt dataPtIdxes,
const IlvCoordInterval abscissaRange,
IlBoolean  shiftOfCycleLength,
const IlvTransformer t 
)
virtual

Initializes the current object with a set of data points to project.

This method performs the projection of the data points dataPoints and stores in the current object the resulting points and their corresponding data point indexes given by dataPtIdxes.

Parameters
countThe number of data points.
dataPointsThe data points to project.
dataPtIdxesThe indexes of the data points in the data set.
abscissaRangeThe range of the abscissa coordinate that is currently used by the chart.
shiftOfCycleLengthA Boolean value indicating whether the data points are shifted by the cycle length.
tThe transformer applied to the chart graphic.

Reimplemented from IlvChartDisplayerPoints.

◆ setClusterSize()

void IlvChartPointsFilter::setClusterSize ( IlvDim  size)

Sets the minimum distance between two consecutive displayed points.

Parameters
sizeThe new minimum distance between two consecutive displayed points.