Views
Charts Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvAutoScaleStepsUpdater Class Reference

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

#include <ilviews/charts/scaledis.h>

Inheritance diagram for IlvAutoScaleStepsUpdater:
IlvConstantScaleStepsUpdater IlvScaleStepsUpdater IlvNamedProperty IlvValueInterface

Public Member Functions

 IlvAutoScaleStepsUpdater (IlvSingleScaleDisplayer *scale, IlDouble precision, IlvDim stepsSpacing=10, IlDouble precisionBase=10., IlBoolean autoSubSteps=IlTrue)
 Constructor. More...
 
 IlvAutoScaleStepsUpdater (IlvSingleScaleDisplayer *scale, IlvDim stepsSpacing=10, IlBoolean autoSubSteps=IlTrue, IlBoolean autoLabelFormat=IlTrue)
 Constructor. More...
 
IlBoolean getAutoLabelFormat () const
 Indicates whether the step label format is automatically computed. More...
 
IlBoolean getAutoPrecision () const
 Indicates whether the precision is automatically computed. More...
 
IlBoolean getAutoSubSteps () const
 Indicates whether the substeps are automatically computed. More...
 
IlDouble getPrecision () const
 Returns the precision. More...
 
IlDouble getPrecisionBase () const
 Returns the precision base. More...
 
IlvDim getStepsSpacing () const
 Returns the steps spacing. More...
 
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. More...
 
void setAutoLabelFormat (IlBoolean autoLabelFormat)
 Specifies whether the step label format is automatically computed. More...
 
void setAutoPrecision (IlBoolean autoPrecision)
 Specifies whether the precision is automatically computed. More...
 
void setAutoSubSteps (IlBoolean autoSubSteps, IlUInt subStepsCount=0)
 Specifies whether the substeps are automatically computed. More...
 
void setPrecision (IlDouble precision, IlDouble precisionBase=10.)
 Sets the precision and the precision base. More...
 
void setStepsSpacing (IlvDim stepsSpacing)
 Sets the steps spacing. More...
 
- Public Member Functions inherited from IlvConstantScaleStepsUpdater
 IlvConstantScaleStepsUpdater (IlvSingleScaleDisplayer *scale)
 Constructor. More...
 
 IlvConstantScaleStepsUpdater (IlvSingleScaleDisplayer *scale, IlDouble stepUnit, IlDouble subStepUnit=0.)
 Constructor. More...
 
 IlvConstantScaleStepsUpdater (IlvSingleScaleDisplayer *scale, IlUInt stepsCount, IlUInt subStepsCount=0)
 Constructor. More...
 
virtual IlBoolean checkRange (IlvCoordInterval &range) const
 Checks whether an interval is valid with respect to the step definition. More...
 
void fixStepsCount (IlUInt stepsCount, IlUInt subStepsCount)
 Sets the number of steps and the number of substeps between two steps. More...
 
void fixStepUnit (IlDouble stepUnit, IlDouble subStepUnit)
 Sets the step unit and the substep unit. More...
 
IlDouble getFirstStepData () const
 Returns the data value associated with the first major step. More...
 
IlDouble getLastStepData () const
 Returns the data value associated with the last major step. More...
 
IlUInt getStepsCount () const
 Returns the number of major steps. More...
 
IlDouble getStepUnit () const
 Returns the step unit. More...
 
IlUInt getSubStepsCount () const
 Returns the number of minor steps between two major steps. More...
 
IlDouble getSubStepUnit () const
 Returns the substep unit. More...
 
IlBoolean isFirstStepDataDefined () const
 Indicates whether a data value is associated with the first major step. More...
 
IlBoolean isLastStepDataDefined () const
 Indicates whether a data value is associated with the last major step. More...
 
void setFirstStepData (IlDouble value)
 Sets the data value associated with the first major step. More...
 
void setLastStepData (IlDouble value)
 Sets the data value associated with the last major step. More...
 
- Public Member Functions inherited from IlvScaleStepsUpdater
virtual char * computeStepLabel (IlDouble value) const
 Computes and returns the label displayed for a given data value. More...
 
IlvCoordinateInfogetCoordinateInfo () const
 Deprecated More...
 
IlvSingleScaleDisplayergetScale () const
 Returns the scale associated with the current scale steps updater. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvScaleStepsUpdater
static IlvScaleStepsUpdaterGet (const IlvSingleScaleDisplayer *scale)
 Returns the scale steps updater set on a given scale. More...
 
static IlvScaleStepsUpdaterRemove (IlvSingleScaleDisplayer *scale)
 Removes the scale steps updater set on a given scale. More...
 
static IlvScaleStepsUpdaterSet (IlvSingleScaleDisplayer *scale, IlvScaleStepsUpdater *updater)
 Sets a scale steps updater on a given scale. More...
 
- Protected Member Functions inherited from IlvScaleStepsUpdater
 IlvScaleStepsUpdater (IlvSingleScaleDisplayer *scale)
 Constructor. More...
 

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() [1/2]

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
scaleThe scale associated with the current scale steps updater.
precisionThe precision used to compute the step values.
stepsSpacingThe minimum spacing that is left between two steps.
precisionBaseThe precision base used to compute the step values.
autoSubStepsThe Boolean value indicating whether the number of substeps is automatically computed.

◆ IlvAutoScaleStepsUpdater() [2/2]

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
scaleThe scale associated with the current scale steps updater.
stepsSpacingThe minimum spacing that is left between two steps.
autoSubStepsThe Boolean value indicating whether the number of substeps is automatically computed.
autoLabelFormatThe Boolean value indicating whether the step label format is automatically computed.

Member Function Documentation

◆ getAutoLabelFormat()

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.

◆ getAutoPrecision()

IlBoolean IlvAutoScaleStepsUpdater::getAutoPrecision ( ) const

Indicates whether the precision is automatically computed.

Returns
IlTrue if the precision is automatically computed and IlFalse otherwise.

◆ getAutoSubSteps()

IlBoolean IlvAutoScaleStepsUpdater::getAutoSubSteps ( ) const

Indicates whether the substeps are automatically computed.

Returns
IlTrue if the substeps are automatically computed and IlFalse otherwise.

◆ getPrecision()

IlDouble IlvAutoScaleStepsUpdater::getPrecision ( ) const

Returns the precision.

Returns
The precision used to compute automatically the step values.

◆ getPrecisionBase()

IlDouble IlvAutoScaleStepsUpdater::getPrecisionBase ( ) const

Returns the precision base.

Returns
The precision base used to compute automatically the step values.

◆ getStepsSpacing()

IlvDim IlvAutoScaleStepsUpdater::getStepsSpacing ( ) const

Returns the steps spacing.

Returns
The minimum spacing between two steps.

◆ getStepSubStepValues()

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
areaThe data area definition. This data area definition can be retrieved with the IlvChartGraphic::getProjectorArea() method.
stepsCountReturns the number of major steps.
stepValuesReturns the values associated with the major steps.
subStepsCountReturns the number of minor steps.
subStepValuesReturns the values associated with the minor steps.

Reimplemented from IlvConstantScaleStepsUpdater.

◆ setAutoLabelFormat()

void IlvAutoScaleStepsUpdater::setAutoLabelFormat ( IlBoolean  autoLabelFormat)

Specifies whether the step label format is automatically computed.

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

◆ setAutoPrecision()

void IlvAutoScaleStepsUpdater::setAutoPrecision ( IlBoolean  autoPrecision)

Specifies whether the precision is automatically computed.

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

◆ setAutoSubSteps()

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

Specifies whether the substeps are automatically computed.

Parameters
autoSubStepsThe new value of the flag indicating whether the substeps are automatically computed.
subStepsCountThe defined substeps count, if the substeps count is not automatically computed.

◆ setPrecision()

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

Sets the precision and the precision base.

Parameters
precisionThe new precision.
precisionBaseThe new precision base.

◆ setStepsSpacing()

void IlvAutoScaleStepsUpdater::setStepsSpacing ( IlvDim  stepsSpacing)

Sets the steps spacing.

Parameters
stepsSpacingThe new minimum spacing between two steps.