IlvRadarGridDisplayer Class Reference

Grid displayer subclass for ordinate scales of radar charts. More...

#include <ilviews/charts/grid.h>

Inheritance diagram for IlvRadarGridDisplayer:

Public Member Functions
	IlvRadarGridDisplayer (IlvCircularScaleDisplayer *ref, IlvPalette *major=0, IlvPalette *minor=0)
	Constructor. More...
virtual void	drawTick (IlUInt tickIdx, const IlvPoint &tickPoint, IlDouble tickAngle, IlBoolean major, IlvPort *dst, const IlvRegion *clip) const
	Draws the grid line for a given tick of the scale with which the grid is associated. More...
Public Member Functions inherited from IlvCircularGridDisplayer
	IlvCircularGridDisplayer (IlvCircularScaleDisplayer *ref, IlvPalette *major=0, IlvPalette *minor=0)
	Constructor. More...
virtual	~IlvCircularGridDisplayer ()
	Destructor. More...
virtual IlvRectangularGridDisplayer *	createRectangularGrid () const
	Creates and returns a rectangular grid instantiated with the current grid parameters. More...
const IlvCircularScaleDisplayer *	getReferenceScale () const
	Returns the reference scale. More...
void	setReferenceScale (const IlvCircularScaleDisplayer *scale)
	Sets the reference scale. More...
Public Member Functions inherited from IlvAbstractGridDisplayer
virtual	~IlvAbstractGridDisplayer ()
	Destructor. More...
virtual IlvAbstractGridDisplayer *	copy () const =0
	Virtual copy constructor. More...
void	drawMinorLines (IlBoolean flag)
	Specifies that the minor lines are drawn. More...
IlvPalette *	getDefaultPalette () const
	Returns the palette used by default. More...
IlvDrawOrder	getDrawOrder () const
	Returns the drawing order for the current grid. More...
IlvPalette *	getMajorPalette () const
	Returns the palette for the major lines. More...
IlvPalette *	getMinorPalette () const
	Returns the palette for the minor lines. More...
const IlvAbstractProjector *	getProjector () const
	Returns the object used to project the data into screen coordinates. More...
const IlvSingleScaleDisplayer *	getTickScale () const
	Returns the scale with which the current grid is associated. More...
IlBoolean	isDrawingMinorLines () const
	Indicates whether the minor lines are drawn. More...
IlBoolean	isVisible () const
	Indicates whether the current grid is visible. More...
IlvOutputFile &	save (IlvOutputFile &file) const
	Writes a complete description of the current object in a file. More...
void	setDrawOrder (IlvDrawOrder drawOrder)
	Sets the drawing order for the current grid. More...
void	setMajorPalette (IlvPalette *pal)
	Sets the palette for the major lines. More...
void	setMinorPalette (IlvPalette *pal)
	Sets the palette for the minor lines. More...
virtual void	setMode (IlvDrawMode mode)
	Sets the drawing mode. More...
virtual void	setOverwrite (IlBoolean o)
	Sets the way the drawing member functions operate. More...
void	setVisible (IlBoolean visible)
	Specifies whether the current grid is visible. More...
virtual void	write (IlvOutputFile &file) const
	Writes the attributes of the current object in a file. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvAbstractGridDisplayer
static IlvAbstractGridDisplayer *	Load (IlvInputFile &file)
	Reads a grid object from a file. More...
Protected Member Functions inherited from IlvAbstractGridDisplayer
	IlvAbstractGridDisplayer (IlvPalette *major=0, IlvPalette *minor=0)
	Constructor. More...
	IlvAbstractGridDisplayer (const IlvAbstractGridDisplayer &grid)
	Constructor. More...
	IlvAbstractGridDisplayer (IlvInputFile &file)
	Constructor. More...

Detailed Description

Grid displayer subclass for ordinate scales of radar charts.

Library: ilvcharts

This class is a subclass of IlvCircularGridDisplayer that allows you to define a dedicated grid for the ordinate scales of radar charts.

You can see an example of a radar grid in the figure below where a grid is set for the ordinate scale of the displayed chart.

See also

IlvCircularScaleDisplayer.

Constructor & Destructor Documentation

IlvRadarGridDisplayer::IlvRadarGridDisplayer	(	IlvCircularScaleDisplayer *	ref,
		IlvPalette *	major = 0,
		IlvPalette *	minor = 0
	)

Constructor.

Initializes a new IlvRadarGridDisplayer object. By default, the scale with which the current grid is associated is set to 0. The Boolean indicating that the grid is visible is set to IlTrue. The Boolean indicating that the minor lines are drawn is set to IlFalse, meaning that by default only the major lines will be drawn. The drawing order is set to IlvDrawAbove, specifying that the grid is drawn above the graphic representations of data in the chart.

Parameters

ref	The circular scale used as the reference scale to bound the grid lines.
major	The new palette that will be used to draw the major lines of the current grid.
minor	The new palette that will be used to draw the minor lines of the current grid.

Member Function Documentation

virtual void IlvRadarGridDisplayer::drawTick ( IlUInt  tickIdx, const IlvPoint &  tickPoint, IlDouble  tickAngle, IlBoolean  major, IlvPort *  dst, const IlvRegion *  clip  ) const

virtual

Draws the grid line for a given tick of the scale with which the grid is associated.

Draws the grid line for the scale tick of index tickIdx, defined by the point tickPoint, which is its position in pixels, and by its angle tickAngle.

The grid line is drawn in the given port named dst using the clipping region clip.

Parameters

tickIdx	The index of the tick on the scale to which the grid is attached.
tickPoint	The position in pixels of the scale tick for which the grid line is drawn. This point is already transformed.
tickAngle	The angle of the scale tick for which the grid line is drawn.
major	A Boolean value indicating whether the tick is a major step or a substep.
dst	The port where the grid line is drawn.
clip	The clipping region.

Note

This method is called inside the IlvSingleScaleDisplayer::drawTick() method. Therefore, the grid line is drawn when the scale tick is drawn.

The data display area is automatically set by the scale with the IlvAbstractGridDisplayer::setDataDisplayArea() method before the grid lines are drawn. This area can therefore be fetched with the IlvAbstractGridDisplayer::getDataDisplayArea() method.

Reimplemented from IlvCircularGridDisplayer.