IlvScaleStepsUpdater Class Reference

Base class for computing the graduations of a scale. More...

#include <ilviews/charts/scaledis.h>

Inheritance diagram for IlvScaleStepsUpdater:

List of all members.

Public Member Functions
virtual IlBoolean	checkRange (IlvCoordInterval &range) const
	Checks whether an interval is valid with respect to the step definition.
virtual char *	computeStepLabel (IlDouble value) const
	Computes and returns the label displayed for a given data value.
IlvCoordinateInfo *	getCoordinateInfo () const
	Deprecated
IlvSingleScaleDisplayer *	getScale () const
	Returns the scale associated with the current scale steps updater.
virtual void	getStepSubStepValues (const IlvProjectorArea &area, IlUInt &stepsCount, IlDouble *&stepValues, IlUInt &subStepsCount, IlDouble *&subStepValues) const =0
	Computes and returns the step and substep values for the associated scale.
Static Public Member Functions
static IlvScaleStepsUpdater *	Get (const IlvSingleScaleDisplayer *scale)
	Returns the scale steps updater set on a given scale.
static IlvScaleStepsUpdater *	Remove (IlvSingleScaleDisplayer *scale)
	Removes the scale steps updater set on a given scale.
static IlvScaleStepsUpdater *	Set (IlvSingleScaleDisplayer *scale, IlvScaleStepsUpdater *updater)
	Sets a scale steps updater on a given scale.
Protected Member Functions
	IlvScaleStepsUpdater (IlvSingleScaleDisplayer *scale)
	Constructor.
Friends
class	IlvSingleScaleDisplayer

---

Detailed Description

Base class for computing the graduations of a scale.

Library: ilvcharts

IlvScaleStepsUpdater is an abstract base class that allows you to compute the steps and the substeps for a single scale.

See also:

IlvNamedProperty, IlvSingleScaleDisplayer.

---

Constructor & Destructor Documentation

IlvScaleStepsUpdater::IlvScaleStepsUpdater

(

IlvSingleScaleDisplayer *

scale

)

[protected]

Constructor.

Initializes a new IlvScaleStepsUpdater object.

Parameters:

scale

The scale associated with the current scale steps updater.

---

Member Function Documentation

virtual IlBoolean IlvScaleStepsUpdater::checkRange

(

IlvCoordInterval &

range

)

const [virtual]

Checks whether an interval is valid with respect to the step definition.

Called whenever the range of the coordinate associated with the current scale is modified. With this method, you can modify the interval range so that it becomes consistent with the steps definition. The default implementation simply returns IlTrue.

Parameters:

range

The range to check.

Returns:

IlFalse if the range was not correct and had to be modified, and IlTrue otherwise.

Reimplemented in IlvConstantScaleStepsUpdater, and IlvLogScaleStepsUpdater.

virtual char* IlvScaleStepsUpdater::computeStepLabel

(

IlDouble

value

)

const [virtual]

Computes and returns the label displayed for a given data value.

Parameters:

value

The data value for which the label to be displayed is computed.

Reimplemented in IlvTimeScaleStepsUpdater, IlvLogScaleStepsUpdater, and IlvZoomScaleStepsUpdater.

static IlvScaleStepsUpdater* IlvScaleStepsUpdater::Get

(

const IlvSingleScaleDisplayer *

scale

)

[static]

Returns the scale steps updater set on a given scale.

Returns:

A pointer to the scale steps updater set on a given scale. This scale steps updater is the one used to compute the graduations for the scale.

Parameters:

scale

The scale on which the returned scale steps updater is set.

Reimplemented in IlvAutoScaleStepsUpdater.

IlvCoordinateInfo* IlvScaleStepsUpdater::getCoordinateInfo

(

)

const

Deprecated

See also:

IlvChartGraphic::getOrdinateInfo, IlvChartGraphic::getAbscissaInfo

IlvSingleScaleDisplayer* IlvScaleStepsUpdater::getScale

(

)

const

Returns the scale associated with the current scale steps updater.

Returns:

The scale associated with the current scale steps updater.

virtual void IlvScaleStepsUpdater::getStepSubStepValues	(	const IlvProjectorArea &	area,
		IlUInt &	stepsCount,
		IlDouble *&	stepValues,
		IlUInt &	subStepsCount,
		IlDouble *&	subStepValues
	)			const [pure virtual]

Computes and returns the step and substep values for the associated scale.

Parameters:

	area	The data area definition. This data area definition can be retrieved with the IlvChartGraphic::getProjectorArea method.
	stepsCount	Returns the number of major steps.
	stepValues	Returns the values associated with the major steps.
	subStepsCount	Returns the number of minor steps.
	subStepValues	Returns the values associated with the minor steps.

Implemented in IlvTimeScaleStepsUpdater, IlvConstantScaleStepsUpdater, IlvAutoScaleStepsUpdater, IlvLogScaleStepsUpdater, and IlvZoomScaleStepsUpdater.

static IlvScaleStepsUpdater* IlvScaleStepsUpdater::Remove

(

IlvSingleScaleDisplayer *

scale

)

[static]

Removes the scale steps updater set on a given scale.

Parameters:

scale

The scale for which the scale steps updater is removed.

static IlvScaleStepsUpdater* IlvScaleStepsUpdater::Set	(	IlvSingleScaleDisplayer *	scale,
		IlvScaleStepsUpdater *	updater
	)			[static]

Sets a scale steps updater on a given scale.

The scale steps updater updater will be used to compute the graduations for the scale scale.

Parameters:

	scale	The scale on which the scale steps updater updater is set.
	updater	The new scale steps updater that is set on the scale scale.