IlvAutoScaleStepsUpdater Class Reference

Class for computing the graduations of a scale. More...

#include <ilviews/charts/scaledis.h>

Inheritance diagram for IlvAutoScaleStepsUpdater:

List of all members.

Public Member Functions
	IlvAutoScaleStepsUpdater (IlvSingleScaleDisplayer *scale, IlvDim stepsSpacing=10, IlBoolean autoSubSteps=IlTrue, IlBoolean autoLabelFormat=IlTrue)
	Constructor.
	IlvAutoScaleStepsUpdater (IlvSingleScaleDisplayer *scale, IlDouble precision, IlvDim stepsSpacing=10, IlDouble precisionBase=10., IlBoolean autoSubSteps=IlTrue)
	Constructor.
IlBoolean	getAutoLabelFormat () const
	Indicates whether the step label format is automatically computed.
IlBoolean	getAutoPrecision () const
	Indicates whether the precision is automatically computed.
IlBoolean	getAutoSubSteps () const
	Indicates whether the substeps are automatically computed.
IlDouble	getPrecision () const
	Returns the precision.
IlDouble	getPrecisionBase () const
	Returns the precision base.
IlvDim	getStepsSpacing () const
	Returns the steps spacing.
virtual void	getStepSubStepValues (const IlvProjectorArea &area, IlUInt &stepsCount, IlDouble *&stepValues, IlUInt &subStepsCount, IlDouble *&subStepValues) const
	Computes and returns the step and substep values for the associated scale.
void	setAutoLabelFormat (IlBoolean autoLabelFormat)
	Specifies whether the step label format is automatically computed.
void	setAutoPrecision (IlBoolean autoPrecision)
	Specifies whether the precision is automatically computed.
void	setAutoSubSteps (IlBoolean autoSubSteps, IlUInt subStepsCount=0)
	Specifies whether the substeps are automatically computed.
void	setPrecision (IlDouble precision, IlDouble precisionBase=10.)
	Sets the precision and the precision base.
void	setStepsSpacing (IlvDim stepsSpacing)
	Sets the steps spacing.
Static Public Member Functions
static IlvAutoScaleStepsUpdater *	Get (const IlvSingleScaleDisplayer *scale)
	Returns the scale steps updater set on a given scale.

---

Detailed Description

Class for computing the graduations of a scale.

Library: ilvcharts

IlvAutoScaleStepsUpdater is a subclass of IlvConstantScaleStepsUpdater that allows you to perform an automatic computation of the steps and the substeps of a scale.

See also:

IlvConstantScaleStepsUpdater, IlvSingleScaleDisplayer.

---

Constructor & Destructor Documentation

IlvAutoScaleStepsUpdater::IlvAutoScaleStepsUpdater	(	IlvSingleScaleDisplayer *	scale,
		IlDouble	precision,
		IlvDim	stepsSpacing = 10,
		IlDouble	precisionBase = 10.,
		IlBoolean	autoSubSteps = IlTrue
	)

Constructor.

Initializes a new IlvAutoScaleStepsUpdater object. By default, the step label format is not automatically computed.

Parameters:

	scale	The scale associated with the current scale steps updater.
	precision	The precision used to compute the step values.
	stepsSpacing	The minimum spacing that is left between two steps.
	precisionBase	The precision base used to compute the step values.
	autoSubSteps	The Boolean value indicating whether the number of substeps is automatically computed.

IlvAutoScaleStepsUpdater::IlvAutoScaleStepsUpdater	(	IlvSingleScaleDisplayer *	scale,
		IlvDim	stepsSpacing = 10,
		IlBoolean	autoSubSteps = IlTrue,
		IlBoolean	autoLabelFormat = IlTrue
	)

Constructor.

Initializes a new IlvAutoScaleStepsUpdater object. By default, the precision is automatically computed and the precision base is set to 10.

Parameters:

	scale	The scale associated with the current scale steps updater.
	stepsSpacing	The minimum spacing that is left between two steps.
	autoSubSteps	The Boolean value indicating whether the number of substeps is automatically computed.
	autoLabelFormat	The Boolean value indicating whether the step label format is automatically computed.

---

Member Function Documentation

static IlvAutoScaleStepsUpdater* IlvAutoScaleStepsUpdater::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 from IlvScaleStepsUpdater.

IlBoolean IlvAutoScaleStepsUpdater::getAutoLabelFormat

(

)

const

Indicates whether the step label format is automatically computed.

Returns:

IlTrue if the step label format is automatically computed and IlFalse otherwise.

IlBoolean IlvAutoScaleStepsUpdater::getAutoPrecision

(

)

const

Indicates whether the precision is automatically computed.

Returns:

IlTrue if the precision is automatically computed and IlFalse otherwise.

IlBoolean IlvAutoScaleStepsUpdater::getAutoSubSteps

(

)

const

Indicates whether the substeps are automatically computed.

Returns:

IlTrue if the substeps are automatically computed and IlFalse otherwise.

IlDouble IlvAutoScaleStepsUpdater::getPrecision

(

)

const

Returns the precision.

Returns:

The precision used to compute automatically the step values.

IlDouble IlvAutoScaleStepsUpdater::getPrecisionBase

(

)

const

Returns the precision base.

Returns:

The precision base used to compute automatically the step values.

IlvDim IlvAutoScaleStepsUpdater::getStepsSpacing

(

)

const

Returns the steps spacing.

Returns:

The minimum spacing between two steps.

virtual void IlvAutoScaleStepsUpdater::getStepSubStepValues	(	const IlvProjectorArea &	area,
		IlUInt &	stepsCount,
		IlDouble *&	stepValues,
		IlUInt &	subStepsCount,
		IlDouble *&	subStepValues
	)			const [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.

Reimplemented from IlvConstantScaleStepsUpdater.

void IlvAutoScaleStepsUpdater::setAutoLabelFormat

(

IlBoolean

autoLabelFormat

)

Specifies whether the step label format is automatically computed.

Parameters:

autoLabelFormat

The new value of the flag indicating whether the step label format is automatically computed.

void IlvAutoScaleStepsUpdater::setAutoPrecision

(

IlBoolean

autoPrecision

)

Specifies whether the precision is automatically computed.

Parameters:

autoPrecision

The new value of the flag indicating whether the precision is automatically computed.

void IlvAutoScaleStepsUpdater::setAutoSubSteps	(	IlBoolean	autoSubSteps,
		IlUInt	subStepsCount = 0
	)

Specifies whether the substeps are automatically computed.

Parameters:

	autoSubSteps	The new value of the flag indicating whether the substeps are automatically computed.
	subStepsCount	The defined substeps count, if the substeps count is not automatically computed.

void IlvAutoScaleStepsUpdater::setPrecision	(	IlDouble	precision,
		IlDouble	precisionBase = 10.
	)

Sets the precision and the precision base.

Parameters:

	precision	The new precision.
	precisionBase	The new precision base.

void IlvAutoScaleStepsUpdater::setStepsSpacing

(

IlvDim

stepsSpacing

)

Sets the steps spacing.

Parameters:

stepsSpacing

The new minimum spacing between two steps.