IlvRadarGridDisplayer Class Reference

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

#include <ilviews/charts/grid.h>

Inheritance diagram for IlvRadarGridDisplayer:

List of all members.

Public Member Functions
	IlvRadarGridDisplayer (IlvCircularScaleDisplayer *ref, IlvPalette *major=0, IlvPalette *minor=0)
	Constructor.
virtual IlvAbstractGridDisplayer *	copy () const
	Virtual copy constructor.
virtual void	drawTick (IlUInt tickIdx, const IlvPoint &tickPoint, IlDouble tickAngle, IlBoolean major, IlvPort *dst, const IlvRegion *givenClip) const
	Draws the grid line for a given tick of the scale with which the grid is associated.

---

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 IlvAbstractGridDisplayer* IlvRadarGridDisplayer::copy

(

)

const [virtual]

Virtual copy constructor.

Creates and returns a copy of the current object. This method must be overloaded in subclasses. It is automatically declared by the DeclareGridDisplayerTypeInfo macro. The IlvPredefinedGridDisplayerIOMembers macro lets you define a default implementation, which returns an instance initialized with the copy constructor.

Returns:

A copy of the current object.

Implements IlvAbstractGridDisplayer.

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.

Warning:

[note] This method is called inside the IlvSingleScaleDisplayer::drawTick method. Therefore, the grid line is drawn when the scale tick is drawn.

[note] 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.