IlvCircularScaleDisplayer Class Reference

Implementation of circular scales. More...

#include <ilviews/charts/scaledis.h>

Inheritance diagram for IlvCircularScaleDisplayer:

List of all members.

Public Member Functions
	IlvCircularScaleDisplayer (IlvCoordinateInfo *coordInfo, IlUInt stepsCount, const char *const *stepLabels, IlUInt subStepsCount, IlvPalette *defaultPalette)
	Constructor.
	IlvCircularScaleDisplayer (IlvCoordinateInfo *coordInfo, IlvPalette *defaultPalette)
	Constructor.
virtual IlvAbstractScaleDisplayer *	copy () const
	Virtual copy constructor.
virtual IlvAbstractChartCursor *	createCursor (const IlvSingleScaleDisplayer *scaleRef=0) const
	Factory method to create a default cursor.
virtual IlvAbstractGridDisplayer *	createGridDisplayer (const IlvSingleScaleDisplayer *scaleRef=0) const
	Factory method to create a default grid.

---

Detailed Description

Implementation of circular scales.

Library: ilvcharts

This class is a subclass of IlvSingleScaleDisplayer that allows you to display a scale with a circular axis.

Warning:

[note] A circular scale can only be used with a polar projector.

See also:

IlvSingleScaleDisplayer.

---

Constructor & Destructor Documentation

IlvCircularScaleDisplayer::IlvCircularScaleDisplayer	(	IlvCoordinateInfo *	coordInfo,
		IlvPalette *	defaultPalette
	)

Constructor.

Initializes a new IlvCircularScaleDisplayer object.

Parameters:

	coordInfo	The coordinate information to which the scale is connected.
	defaultPalette	The default palette used to draw the various parts of the scale (axis, step labels, axis label). Each individual part can be assigned a different palette afterwards.

IlvCircularScaleDisplayer::IlvCircularScaleDisplayer	(	IlvCoordinateInfo *	coordInfo,
		IlUInt	stepsCount,
		const char *const *	stepLabels,
		IlUInt	subStepsCount,
		IlvPalette *	defaultPalette
	)

Constructor.

Initializes a new IlvCircularScaleDisplayer object.

Parameters:

	coordInfo	The coordinate information to which the scale is connected.
	stepsCount	The number of major steps.
	stepLabels	The labels of the major steps.
	subStepsCount	The number of minor steps between two major steps.
	defaultPalette	The default palette used to draw the various parts of the scale (axis, step labels, axis label). Each individual part can be assigned a different palette afterwards.

See also:

IlvAbstractScaleDisplayer::setStepLabels.

---

Member Function Documentation

virtual IlvAbstractScaleDisplayer* IlvCircularScaleDisplayer::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 DeclareScaleDisplayerTypeInfo macro. The IlvPredefinedScaleDisplayerIOMembers macro lets you define a default implementation, which returns an instance initialized with the copy constructor.

Returns:

A copy of the current object.

Implements IlvAbstractScaleDisplayer.

virtual IlvAbstractChartCursor* IlvCircularScaleDisplayer::createCursor

(

const IlvSingleScaleDisplayer *

scaleRef = 0

)

const [virtual]

Factory method to create a default cursor.

The default implementation returns an instance of IlvRadialChartCursor.

Parameters:

scaleRef

The scale that can be used as a reference for the created cursor to indicate where the cursor line must stop.

Returns:

The created cursor.

Warning:

[note] The reference scale is used by default only for circular cursors.

Implements IlvSingleScaleDisplayer.

virtual IlvAbstractGridDisplayer* IlvCircularScaleDisplayer::createGridDisplayer

(

const IlvSingleScaleDisplayer *

scaleRef = 0

)

const [virtual]

Factory method to create a default grid.

The default implementation returns an instance of IlvRadialGridDisplayer.

Parameters:

scaleRef

The scale that can be used as a reference for the created grid to indicate where the grid lines must stop.

Returns:

The created grid.

Warning:

[note] The reference scale is used by default only for circular grids.

Implements IlvSingleScaleDisplayer.