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
IlvCircularScaleDisplayer Class Reference

Implementation of circular scales. More...

#include <ilviews/charts/scaledis.h>

Inheritance diagram for IlvCircularScaleDisplayer:
IlvSingleScaleDisplayer IlvAbstractScaleDisplayer

Public Member Functions

 IlvCircularScaleDisplayer (IlvCoordinateInfo *coordInfo, IlvPalette *defaultPalette)
 Constructor. More...
 
 IlvCircularScaleDisplayer (IlvCoordinateInfo *coordInfo, IlUInt stepsCount, const char *const *stepLabels, IlUInt subStepsCount, IlvPalette *defaultPalette)
 Constructor. More...
 
virtual IlvAbstractChartCursorcreateCursor (const IlvSingleScaleDisplayer *scaleRef=0) const
 Factory method to create a default cursor. More...
 
virtual IlvAbstractGridDisplayercreateGridDisplayer (const IlvSingleScaleDisplayer *scaleRef=0) const
 Factory method to create a default grid. More...
 
- Public Member Functions inherited from IlvSingleScaleDisplayer
virtual ~IlvSingleScaleDisplayer ()
 Destructor. More...
 
void addCursor (IlvAbstractChartCursor *cursor, IlUInt position=IlvLastPositionIndex)
 Adds a cursor to the scale. More...
 
IlBoolean areMajorTicksVisible () const
 Indicates whether the major ticks are visible. More...
 
IlBoolean areMinorTicksVisible () const
 Indicates whether the minor ticks are visible. More...
 
IlBoolean areStepLabelsVisible () const
 Indicates whether the step labels are visible. More...
 
virtual char * computeStepLabel (IlDouble value) const
 Computes and returns the label associated with a data value. More...
 
virtual void drawLabelOnCrossings (IlBoolean b)
 Indicates whether the labels should be drawn where the axes intersect. More...
 
virtual void drawOverlappingLabels (IlBoolean b)
 Sets whether overlapping labels are allowed. More...
 
IlvDim getArrowLength () const
 Returns the arrow length. More...
 
IlvDim getArrowWidth () const
 Returns the arrow width. More...
 
const char * getAxisLabel () const
 Returns the label of the axis. More...
 
IlvDim getAxisLabelOffset () const
 Returns the offset between the scale axis and its label. More...
 
IlvPalettegetAxisLabelPalette () const
 Returns the palette used to draw the axis label. More...
 
void getAxisLabelSizes (IlvDim &width, IlvDim &height, IlvDim &descent) const
 Returns the sizes of the axis label. More...
 
IlvPalettegetAxisPalette () const
 Returns the palette used to draw the axis. More...
 
IlvConstantScaleStepsUpdatergetConstantStepsUpdater () const
 Returns the constant scale steps updater (if any) used by the current scale. More...
 
virtual IlvCoordinateInfogetCoordinateInfo (IlUInt index=0) const
 Deprecated More...
 
virtual IlvCoordinateType getCoordinateType () const
 Returns the type of the coordinate represented by the current scale. More...
 
IlvAbstractChartCursorgetCursor (IlUInt index) const
 Returns the cursor at a given index. More...
 
IlvAbstractChartCursorgetCursorByName (const char *name) const
 Returns a cursor with a given name. More...
 
IlUInt getCursorsCount () const
 Returns the number of cursors connected to the scale. More...
 
IlvAbstractGridDisplayergetGridDisplayer () const
 Deprecated Returns the associated grid. More...
 
LabelLayout getLabelLayout () const
 Returns the label layout on the scale axis. More...
 
IlvDim getMajorTickSize () const
 Returns the size of the major ticks. More...
 
IlvDim getMinorTickSize () const
 Returns the size of the minor ticks. More...
 
IlvDim getOffset () const
 Returns the offset between the steps and the step labels. More...
 
const char * getStepLabel (IlUInt iStep) const
 Returns the label of a given step. More...
 
IlDouble getStepLabelAngle () const
 Returns the angle of the step labels. More...
 
void getStepLabelBBox (const IlvProjectorArea &dataArea, IlUInt iStep, IlvRect &bbox) const
 Returns the bounding box of a step label. More...
 
const char * getStepLabelFormat () const
 Returns the format used to draw the step labels. More...
 
const char *const * getStepLabels (IlUInt &labelsCount) const
 Returns the labels of the major steps. More...
 
IlUInt getStepLabelsCount () const
 Returns the number of step labels. More...
 
void getStepLabelSizes (IlUInt iStep, IlvDim &width, IlvDim &height, IlvDim &descent) const
 Returns the sizes of a given step label. More...
 
IlvPalettegetStepLabelsPalette () const
 Returns the palette used to draw the step labels. More...
 
IlUInt getStepsCount () const
 Returns the number of major steps. More...
 
void getStepSubStepValues (IlUInt &stepsCount, const IlDouble *&stepValues, const char *const *&stepLabels, IlUInt &subStepsCount, const IlDouble *&subStepValues) const
 Returns the values and labels associated with the scale steps. More...
 
IlvScaleStepsUpdatergetStepsUpdater () const
 Returns the scale steps updater used by the current scale. More...
 
IlDouble getStepUnit () const
 Returns the step unit. More...
 
IlDouble getStepValue (IlUInt iStep) const
 Returns the value associated with a major step. More...
 
const IlDoublegetStepValues (IlUInt &count) const
 Returns the values associated with the major steps. More...
 
IlUInt getSubStepsCount () const
 Returns the number of minor steps between two major steps. More...
 
IlDouble getSubStepUnit () const
 Returns the substep unit. More...
 
IlDouble getSubStepValue (IlUInt iSubStep) const
 Returns the value associated with a minor step. More...
 
const IlDoublegetSubStepValues (IlUInt &count) const
 Returns the values associated with the minor steps. More...
 
TickLayout getTickLayout () const
 Returns the tick layout on the scale axis. More...
 
IlUInt getTotalSubStepsCount () const
 Returns the total number of minor steps. More...
 
IlvValueToLabelCB getValueToLabelCB () const
 Returns the conversion callback between data values and step labels. More...
 
IlAny getValueToLabelCBData () const
 Returns the information parameter associated with the conversion callback between data values and step labels. More...
 
IlBoolean hasCursor (const IlvAbstractChartCursor *cursor) const
 Checks whether a given cursor is connected to the scale. More...
 
IlBoolean isAxisOriented () const
 Indicates whether the axis is oriented. More...
 
IlBoolean isAxisVisible () const
 Indicates whether the axis is visible. More...
 
IlBoolean isDrawingLabelOnCrossings () const
 Sets whether the step labels are drawn where the axes intersect. More...
 
IlBoolean isDrawingOverlappingLabels () const
 Indicates whether overlapping labels should be drawn. More...
 
virtual IlBoolean isOnAbscissa () const
 Indicates whether the scale is connected to the abscissa coordinate system. More...
 
virtual IlBoolean isOnOrdinate () const
 Indicates whether the scale is connected to an ordinate coordinate system. More...
 
IlvAbstractChartCursorremoveCursor (IlvAbstractChartCursor *cursor)
 Removes a cursor from the scale. More...
 
void removeCursors ()
 Removes and deletes all the associated cursors.
 
virtual void setArrowLength (IlvDim length)
 Sets the arrow length. More...
 
virtual void setArrowWidth (IlvDim width)
 Sets the arrow width. More...
 
void setAxisLabel (const char *label)
 Sets the label of the axis. More...
 
virtual void setAxisLabelOffset (IlvDim offset)
 Sets the offset between the scale axis and its label. More...
 
virtual void setAxisLabelPalette (IlvPalette *pal)
 Sets the palette used to draw the axis label. More...
 
virtual void setAxisOriented (IlBoolean o)
 Indicates whether the scale should be oriented. More...
 
virtual void setAxisPalette (IlvPalette *pal)
 Sets the palette used to draw the axis. More...
 
void setAxisVisible (IlBoolean visible)
 Sets the visibility of the axis. More...
 
void setGridDisplayer (IlvAbstractGridDisplayer *grid)
 Deprecated Sets the associated grid. More...
 
virtual void setGridDrawOrder (IlvDrawOrder drawOrder)
 Sets the drawing order for the associated grid. More...
 
virtual void setLabelZoomFactor (IlDouble scale)
 Set the scaling (zooming) factor to be applied on labels.
 
virtual void setMajorTickSize (IlvDim val)
 Sets the size of the major ticks. More...
 
void setMajorTicksVisible (IlBoolean visible)
 Sets the visibility of the major ticks. More...
 
virtual void setMinorTickSize (IlvDim val)
 Sets the size of the minor ticks. More...
 
void setMinorTicksVisible (IlBoolean visible)
 Sets the visibility of the minor ticks. More...
 
virtual void setOffset (IlvDim dim)
 Sets the offset between the ticks and the step labels. More...
 
virtual void setStepLabel (IlUInt labelIndex, const char *label)
 Sets the label for a given step by hand. More...
 
virtual void setStepLabelAngle (IlDouble angle)
 Sets the angle of the step labels. More...
 
virtual void setStepLabelFormat (const char *format, IlBoolean invalidate=IlTrue)
 Sets the format used to translate data values into step labels. More...
 
virtual void setStepLabels (IlUInt count, const char *const *labels=0)
 Sets the step labels by hand. More...
 
virtual void setStepLabelsPalette (IlvPalette *pal)
 Sets the palette used to draw the step labels. More...
 
void setStepLabelsVisible (IlBoolean visible)
 Sets the visibility of the step labels. More...
 
virtual void setTickLayout (TickLayout layout)
 Sets the tick layout on the scale axis. More...
 
virtual void setValueToLabelCB (IlvValueToLabelCB cb, IlAny cbData=0)
 Sets a conversion callback between data values and step labels. More...
 
virtual void write (IlvOutputFile &) const
 Writes the attributes of the current object in a file. More...
 
- Public Member Functions inherited from IlvAbstractScaleDisplayer
virtual ~IlvAbstractScaleDisplayer ()
 Destructor. More...
 
virtual IlvAbstractScaleDisplayercopy () const =0
 Virtual copy constructor. More...
 
IlBoolean getCrossingValue (IlDouble &dataValue) const
 Returns the data value to which the scale is actually fixed. More...
 
IlvDrawOrder getDrawOrder () const
 Returns the drawing order for the current scale. More...
 
IlvCoordinateInfogetInfoForCrossingValue () const
 Returns the coordinate information used to position the scale. More...
 
const char * getName () const
 Returns the name of the scale. More...
 
IlBoolean getRelativePosition (IlvAxisPosition &relPos, IlvPos &offset) const
 Returns the relative position to which the scale is fixed. More...
 
IlDouble getStoredCrossingValue () const
 Returns the stored value to which the scale is fixed. More...
 
IlBoolean isAlwaysVisible () const
 Indicates whether the current scale must always appear on the screen. More...
 
IlBoolean isFixedToPosition () const
 Indicates whether the scale is fixed to a position. More...
 
IlBoolean isInVisibleDataArea () const
 Indicates whether the scale is in the visible data area. More...
 
IlBoolean isVisible () const
 Indicates whether the scale is visible. More...
 
IlvOutputFilesave (IlvOutputFile &file) const
 Writes a complete description of the current object in a file. More...
 
virtual void setAlwaysVisible (IlBoolean b)
 Specifies whether the current scale must always appear on the screen. More...
 
virtual IlBoolean setCrossingValue (IlDouble dataValue, const IlvSingleScaleDisplayer *refScale)
 Sets the data value to which this scale is fixed. More...
 
virtual void setDrawOrder (IlvDrawOrder drawOrder)
 Sets the drawing order for the current scale. More...
 
virtual void setLabelLayout (LabelLayout layout)=0
 Sets the label layout on the scale axis. More...
 
void setName (const char *name)
 Sets the name of the scale. More...
 
virtual void setRelativePosition (IlvAxisPosition relPos, IlvPos offset=0)
 Sets the position to which this scale is fixed. More...
 
void setVisible (IlBoolean visible)
 Sets the visibility of the scale. More...
 

Additional Inherited Members

- Public Types inherited from IlvAbstractScaleDisplayer
enum  LabelLayout { LabelInside, LabelOutside }
 This enumeration type defines the label layout on the scale axis. More...
 
enum  TickLayout { TickInside, TickOutside, TickCross }
 This enumeration type defines the tick layout on the scale axis. More...
 
- Static Public Member Functions inherited from IlvAbstractScaleDisplayer
static IlvAbstractScaleDisplayerLoad (IlvInputFile &file)
 Reads a scale object from a file. More...
 
- Protected Member Functions inherited from IlvSingleScaleDisplayer
 IlvSingleScaleDisplayer (IlvCoordinateInfo *coordInfo, IlvPalette *defaultPalette)
 Constructor. More...
 
 IlvSingleScaleDisplayer (IlvCoordinateInfo *coordInfo, IlUInt nbSteps, const char *const *stepLabels, IlUInt nbSubStepsBetween, IlvPalette *defaultPalette)
 Constructor. More...
 
 IlvSingleScaleDisplayer (const IlvSingleScaleDisplayer &src)
 Constructor. More...
 
 IlvSingleScaleDisplayer (IlvInputFile &file)
 Constructor. More...
 
IlDouble getStepDataMax () const
 Returns the data value associated with the last step of the scale. More...
 
IlDouble getStepDataMin () const
 Returns the data value associated with the first step of the scale. More...
 

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
coordInfoThe coordinate information to which the scale is connected.
defaultPaletteThe 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
coordInfoThe coordinate information to which the scale is connected.
stepsCountThe number of major steps.
stepLabelsThe labels of the major steps.
subStepsCountThe number of minor steps between two major steps.
defaultPaletteThe 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 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
scaleRefThe 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
scaleRefThe 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.


© 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.