rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Charts Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends
IlvScaleStepsUpdater Class Referenceabstract

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

#include <ilviews/charts/scaledis.h>

Inheritance diagram for IlvScaleStepsUpdater:
IlvNamedProperty IlvConstantScaleStepsUpdater IlvLogScaleStepsUpdater IlvTimeScaleStepsUpdater IlvZoomScaleStepsUpdater IlvAutoScaleStepsUpdater

Public Member Functions

virtual IlBoolean checkRange (IlvCoordInterval &range) const
 Checks whether an interval is valid with respect to the step definition. More...
 
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...
 
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. More...
 

Static Public Member Functions

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

 IlvScaleStepsUpdater (IlvSingleScaleDisplayer *scale)
 Constructor. More...
 

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
scaleThe 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
rangeThe range to check.
Returns
IlFalse if the range was not correct and had to be modified, and IlTrue otherwise.

Reimplemented in IlvLogScaleStepsUpdater, and IlvConstantScaleStepsUpdater.

virtual char* IlvScaleStepsUpdater::computeStepLabel ( IlDouble  value) const
virtual

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

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

Reimplemented in IlvZoomScaleStepsUpdater, IlvLogScaleStepsUpdater, and IlvTimeScaleStepsUpdater.

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
scaleThe scale on which the returned scale steps updater is set.
IlvCoordinateInfo* IlvScaleStepsUpdater::getCoordinateInfo ( ) const
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
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.

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

static IlvScaleStepsUpdater* IlvScaleStepsUpdater::Remove ( IlvSingleScaleDisplayer scale)
static

Removes the scale steps updater set on a given scale.

Parameters
scaleThe 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
scaleThe scale on which the scale steps updater updater is set.
updaterThe new scale steps updater that is set on the scale scale.

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.