IlvAbstractScaleDisplayer Class Reference

Base class for scales. More...

#include <ilviews/charts/scaledis.h>

Inheritance diagram for IlvAbstractScaleDisplayer:

Public Types
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...

Public Member Functions
virtual	~IlvAbstractScaleDisplayer ()
	Destructor. More...
virtual IlvAbstractScaleDisplayer *	copy () const =0
	Virtual copy constructor. More...
virtual void	drawLabelOnCrossings (IlBoolean b)=0
	Indicates whether the labels should be drawn where the axes intersect. More...
virtual void	drawOverlappingLabels (IlBoolean b)=0
	Sets whether overlapping labels are allowed. More...
virtual IlvCoordinateInfo *	getCoordinateInfo (IlUInt index=0) const =0
	Deprecated Returns the coordinate information associated with the scale. More...
virtual IlvCoordinateType	getCoordinateType () const =0
	Returns the type of the coordinate represented by the current scale. 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...
IlvCoordinateInfo *	getInfoForCrossingValue () 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...
virtual IlBoolean	isOnAbscissa () const =0
	Indicates whether the scale is connected to the abscissa coordinate system. More...
virtual IlBoolean	isOnOrdinate () const =0
	Indicates whether the scale is connected to an ordinate coordinate system. More...
IlBoolean	isVisible () const
	Indicates whether the scale is visible. More...
IlvOutputFile &	save (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 void	setArrowLength (IlvDim length)=0
	Sets the arrow length. More...
virtual void	setArrowWidth (IlvDim width)=0
	Sets the arrow width. More...
virtual void	setAxisLabelOffset (IlvDim offset)=0
	Sets the offset between the scale axis and its label. More...
virtual void	setAxisLabelPalette (IlvPalette *pal)=0
	Sets the palette used to draw the axis label. More...
virtual void	setAxisOriented (IlBoolean oriented)=0
	Indicates whether the scale should be oriented. More...
virtual void	setAxisPalette (IlvPalette *pal)=0
	Sets the palette used to draw the axis. 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	setGridDrawOrder (IlvDrawOrder drawOrder)=0
	Sets the drawing order for the associated grid. More...
virtual void	setLabelLayout (LabelLayout layout)=0
	Sets the label layout on the scale axis. More...
virtual void	setLabelZoomFactor (IlDouble scale)=0
	Sets the label scale factor. More...
virtual void	setMajorTickSize (IlvDim size)=0
	Sets the size of the major ticks. More...
virtual void	setMinorTickSize (IlvDim val)=0
	Sets the size of the minor ticks. More...
void	setName (const char *name)
	Sets the name of the scale. More...
virtual void	setOffset (IlvDim dim)=0
	Sets the offset between the ticks and the step labels. More...
virtual void	setRelativePosition (IlvAxisPosition relPos, IlvPos offset=0)
	Sets the position to which this scale is fixed. More...
virtual void	setStepLabel (IlUInt labelIndex, const char *label)=0
	Sets the label for a given step by hand. More...
virtual void	setStepLabelAngle (IlDouble angle)=0
	Sets the angle of the step labels. More...
virtual void	setStepLabelFormat (const char *format, IlBoolean invalidate=IlTrue)=0
	Sets the format used to translate data values into step labels. More...
virtual void	setStepLabels (IlUInt count, const char *const *labels=0)=0
	Sets the step labels by hand. More...
virtual void	setStepLabelsPalette (IlvPalette *pal)=0
	Sets the palette used to draw the step labels. More...
virtual void	setTickLayout (TickLayout layout)=0
	Sets the tick layout on the scale axis. More...
virtual void	setValueToLabelCB (IlvValueToLabelCB cb, IlAny cbData=0)=0
	Sets a conversion callback between data values and step labels. More...
void	setVisible (IlBoolean visible)
	Sets the visibility of the scale. More...
virtual void	write (IlvOutputFile &file) const
	Writes the attributes of the current object in a file. More...

Static Public Member Functions
static IlvAbstractScaleDisplayer *	Load (IlvInputFile &file)
	Reads a scale object from a file. More...

Protected Member Functions
	IlvAbstractScaleDisplayer ()
	Constructor. More...
	IlvAbstractScaleDisplayer (const IlvAbstractScaleDisplayer &scaleDisplayer)
	Constructor. More...
	IlvAbstractScaleDisplayer (IlvInputFile &file)
	Constructor. More...

Friends
class	IlvAbscissaAxisElement
class	IlvAxisElement

Detailed Description

Base class for scales.

Library: ilvcharts

IlvAbstractScaleDisplayer is an abstract base class that allows you to display a scale. It provides an API for customizing the general scale layout and its appearance.

This class consists mostly of pure virtual methods. In single-scale subclasses, these methods are implemented to handle the various requests for scales representing a single coordinate.

See Also

IlvSingleScaleDisplayer.

Member Enumeration Documentation

enum IlvAbstractScaleDisplayer::LabelLayout

This enumeration type defines the label layout on the scale axis.

Enumerator
LabelInside	The labels will expand inside the data display area.
LabelOutside	The labels will expand outside the data display area.

enum IlvAbstractScaleDisplayer::TickLayout

This enumeration type defines the tick layout on the scale axis.

Ticks along the scales can have several aspects. This type indicates which aspect you want to use.

Enumerator
TickInside	The ticks will expand inside the data display area.
TickOutside	The ticks will expand outside the data display area.
TickCross	The ticks will expand both inside and outside the data display area.

Constructor & Destructor Documentation

virtual IlvAbstractScaleDisplayer::~IlvAbstractScaleDisplayer ( )

virtual

Destructor.

If the scale is fixed to the value of another coordinate, the associated coordinate information is unlocked.

IlvAbstractScaleDisplayer::IlvAbstractScaleDisplayer ( )

protected

Constructor.

Initializes a new IlvAbstractScaleDisplayer object. By default, the created scale is visible and fixed relatively to the position where the minimum data is displayed, with a relative offset equal to 0. The Boolean value indicating whether the scale must be always visible is set to IlFalse (see the IlvAbstractScaleDisplayer::setAlwaysVisible method) and the drawing order is set to IlvDrawAbove (see the IlvAbstractScaleDisplayer::setDrawOrder method).

IlvAbstractScaleDisplayer::IlvAbstractScaleDisplayer ( const IlvAbstractScaleDisplayer &  scaleDisplayer )

protected

Constructor.

Initializes a new IlvAbstractScaleDisplayer object as a copy of scaleDisplayer.

Parameters

scaleDisplayer

The object used to initialize the current one.

IlvAbstractScaleDisplayer::IlvAbstractScaleDisplayer ( IlvInputFile &  file )

protected

Constructor.

Initializes a new IlvAbstractScaleDisplayer object from the description read in the input file named file.

Parameters

file	The file used to initialize the current scale displayer.

Member Function Documentation

virtual IlvAbstractScaleDisplayer* IlvAbstractScaleDisplayer::copy ( ) const

pure virtual

Virtual copy constructor.

Creates and returns a copy of the current object. This method must be overloaded in subclasses. It is automatically declared by the DeclareScaleDisplayerTypeInfo macro. The IlvPredefinedScaleDisplayerIOMembers macro lets you define a default implementation, which returns an instance initialized with the copy constructor.

Returns

A copy of the current object.

virtual void IlvAbstractScaleDisplayer::drawLabelOnCrossings ( IlBoolean  b )

pure virtual

Indicates whether the labels should be drawn where the axes intersect.

Parameters

b	The new value of the Boolean indicating whether the labels should be drawn where the axes intersect. This Boolean is equal to IlTrue if the labels should be drawn where the axes intersect and IlFalse otherwise.

Implemented in IlvSingleScaleDisplayer.

virtual void IlvAbstractScaleDisplayer::drawOverlappingLabels ( IlBoolean  b )

pure virtual

Sets whether overlapping labels are allowed.

If labels are not allowed to overlap (b is equal to IlFalse), the IlvSingleScaleDisplayer::getNumberOfSkippedSteps method will be called to compute the number of steps to skip when drawing the labels.

Parameters

b	The new value of the Boolean indicating whether the labels can be overlapped. This Boolean is equal to IlTrue if overlapping labels are allowed and IlFalse otherwise.

Implemented in IlvSingleScaleDisplayer.

virtual IlvCoordinateInfo* IlvAbstractScaleDisplayer::getCoordinateInfo ( IlUInt  index = 0 ) const

pure virtual

Deprecated Returns the coordinate information associated with the scale.

Parameters

index

The index of the returned coordinate information object among the coordinate information objects associated with the scale.

Warning

[note] The index index is set to 0 by default since only one coordinate information object is associated with a scale by default.

Returns

A pointer to the associated coordinate information.

See Also

IlvChartGraphic::getOrdinateInfo, IlvChartGraphic::getAbscissaInfo

Implemented in IlvSingleScaleDisplayer.

virtual IlvCoordinateType IlvAbstractScaleDisplayer::getCoordinateType ( ) const

pure virtual

Returns the type of the coordinate represented by the current scale.

Returns

IlvAbscissaCoordinate if the coordinate represented by the current scale is the abscissa coordinate and IlvOrdinateCoordinate if the coordinate represented by the current scale is an ordinate coordinate.

Implemented in IlvSingleScaleDisplayer.

IlBoolean IlvAbstractScaleDisplayer::getCrossingValue

(

IlDouble &

dataValue

)

const

Returns the data value to which the scale is actually fixed.

The returned value can be different from the one specified by the IlvAbstractScaleDisplayer::setCrossingValue method, as it takes into account the actual coordinate range of the other scale.

To retrieve the specified crossing value, use the IlvAbstractScaleDisplayer::getStoredCrossingValue method.

Parameters

dataValue

The data value to which the scale is actually fixed.

Returns

IlTrue if the scale is fixed to a data value and IlFalse otherwise.

Warning

[note] The returned value is meaningful only if the current scale is fixed to a data value on another scale (see the IlvAbstractScaleDisplayer::isFixedToPosition method).

IlvDrawOrder IlvAbstractScaleDisplayer::getDrawOrder

(

)

const

Returns the drawing order for the current scale.

The drawing order enables the scale to be drawn either above (IlvDrawAbove) or below (IlvDrawBelow) other graphical representations.

Returns

The drawing order for the current scale.

IlvCoordinateInfo* IlvAbstractScaleDisplayer::getInfoForCrossingValue

(

)

const

Returns the coordinate information used to position the scale.

Returns

A pointer to the coordinate information object associated with the scale to which the current scale is fixed.

const char* IlvAbstractScaleDisplayer::getName

(

)

const

Returns the name of the scale.

Returns

The name of the scale.

IlBoolean IlvAbstractScaleDisplayer::getRelativePosition	(	IlvAxisPosition &	relPos,
		IlvPos &	offset
	)		const

Returns the relative position to which the scale is fixed.

Parameters

relPos	The parameter used to return the position relative to which the scale is fixed.
offset	The parameter used to return the offset from the position relPos to which the scale is fixed.

Returns

IlTrue if the scale is fixed to a position and IlFalse otherwise.

See Also

isFixedToPosition.

Warning

[note] The returned values are meaningful only if the current scale is fixed to a position (see the IlvAbstractScaleDisplayer::isFixedToPosition method).

IlDouble IlvAbstractScaleDisplayer::getStoredCrossingValue

(

)

const

Returns the stored value to which the scale is fixed.

This value is the one that has been set with the IlvAbstractScaleDisplayer::setCrossingValue method.

Returns

The stored value to which the scale is fixed.

See Also

getCrossingValue.

Warning

[note] The returned value is meaningful only if the current scale is fixed to a data value on another scale (see the IlvAbstractScaleDisplayer::isFixedToPosition method).

IlBoolean IlvAbstractScaleDisplayer::isAlwaysVisible

(

)

const

Indicates whether the current scale must always appear on the screen.

Returns

IlTrue if the current scale must always appear on the screen and IlFalse otherwise. If this method returns IlTrue and if the current scale is fixed to a data value that does not belong to the range of visible data, this range will be modified so that the scale can appear on the screen.

IlBoolean IlvAbstractScaleDisplayer::isFixedToPosition

(

)

const

Indicates whether the scale is fixed to a position.

A scale can be either fixed to a position (see the IlvAbstractScaleDisplayer::setRelativePosition method) or to a value from another scale (see the IlvAbstractScaleDisplayer::setCrossingValue method).

Returns

IlTrue if the scale is fixed to a position and IlFalse if it is fixed to a data value.

IlBoolean IlvAbstractScaleDisplayer::isInVisibleDataArea

(

)

const

Indicates whether the scale is in the visible data area.

If the current scale is fixed to the data value of another scale, this method indicates whether this value belongs to the range of visible data. If this is not the case, the current scale does not appear and the method returns IlFalse.

Returns

IlTrue if the scale appears in the visible data area and IlFalse otherwise.

virtual IlBoolean IlvAbstractScaleDisplayer::isOnAbscissa ( ) const

pure virtual

Indicates whether the scale is connected to the abscissa coordinate system.

Returns

IlTrue if the scale represents the abscissa coordinate and IlFalse if it represents an ordinate coordinate.

Implemented in IlvSingleScaleDisplayer.

virtual IlBoolean IlvAbstractScaleDisplayer::isOnOrdinate ( ) const

pure virtual

Indicates whether the scale is connected to an ordinate coordinate system.

Returns

IlTrue if the scale represents an ordinate coordinate and IlFalse if it represents the abscissa coordinate.

Implemented in IlvSingleScaleDisplayer.

IlBoolean IlvAbstractScaleDisplayer::isVisible

(

)

const

Indicates whether the scale is visible.

Returns

IlTrue if the scale is visible and IlFalse if it is hidden.

static IlvAbstractScaleDisplayer* IlvAbstractScaleDisplayer::Load ( IlvInputFile &  file )

static

Reads a scale object from a file.

Creates a scale instance from the description stored in the file file. The object description must have been written with the IlvAbstractScaleDisplayer::save method.

Parameters

file	The file where the object description is stored.

Returns

A pointer to the created object.

IlvOutputFile& IlvAbstractScaleDisplayer::save

(

IlvOutputFile &

file

)

const

Writes a complete description of the current object in a file.

Writes the complete object description in a file. This description contains all the information necessary to read back this object with the IlvAbstractScaleDisplayer::Load member function. This method first writes information regarding the type of the object and calls the IlvAbstractScaleDisplayer::write method.

Parameters

file	The file where the complete object description is written.

virtual void IlvAbstractScaleDisplayer::setAlwaysVisible ( IlBoolean  b )

virtual

Specifies whether the current scale must always appear on the screen.

Parameters

b

The new value of the Boolean indicating whether the current scale must always appear on the screen. If this Boolean is set to IlTrue and if the current scale is fixed to a data value that does not belong to the range of visible data, this range will be modified so that the scale can appear on the screen.

virtual void IlvAbstractScaleDisplayer::setArrowLength ( IlvDim  length )

pure virtual

Sets the arrow length.

Parameters

length

The new length of the arrow.

See Also

setAxisOriented.

Implemented in IlvSingleScaleDisplayer.

virtual void IlvAbstractScaleDisplayer::setArrowWidth ( IlvDim  width )

pure virtual

Sets the arrow width.

Parameters

width

The new width of the arrow.

See Also

setAxisOriented.

Implemented in IlvSingleScaleDisplayer.

virtual void IlvAbstractScaleDisplayer::setAxisLabelOffset ( IlvDim  offset )

pure virtual

Sets the offset between the scale axis and its label.

Parameters

offset

The new offset between the scale axis and its label.

Implemented in IlvSingleScaleDisplayer.

virtual void IlvAbstractScaleDisplayer::setAxisLabelPalette ( IlvPalette *  pal )

pure virtual

Sets the palette used to draw the axis label.

This method locks the new palette and unlocks the previous one.

Parameters

pal	The new palette.

Implemented in IlvSingleScaleDisplayer.

virtual void IlvAbstractScaleDisplayer::setAxisOriented ( IlBoolean  oriented )

pure virtual

Indicates whether the scale should be oriented.

An oriented scale is drawn with an arrow at the end.

Parameters

oriented

The new value of the Boolean indicating whether the scale should be oriented.

See Also

setArrowWidth, setArrowLength.

Implemented in IlvSingleScaleDisplayer.

virtual void IlvAbstractScaleDisplayer::setAxisPalette ( IlvPalette *  pal )

pure virtual

Sets the palette used to draw the axis.

This method locks the new palette and unlocks the previous one.

Parameters

pal	The new palette.

Implemented in IlvSingleScaleDisplayer.

virtual IlBoolean IlvAbstractScaleDisplayer::setCrossingValue ( IlDouble  dataValue, const IlvSingleScaleDisplayer *  refScale  )

virtual

Sets the data value to which this scale is fixed.

This method is used to attach the current scale to another one defined by refScale. The dataValue parameter is used to specify the data value on refScale to which the current scale is fixed.

Warning

[note] If dataValue is less than 1 and if a logarithmic transformer is applied to the corresponding coordinate, the value that will be actually stored will be 1. Otherwise, the stored value will be dataValue.

Parameters

dataValue	The new data value to which the scale is fixed.
refScale	The new scale to which the current scale is attached.

Returns

IlTrue if the scale was successfully fixed IlFalse otherwise.

virtual void IlvAbstractScaleDisplayer::setDrawOrder ( IlvDrawOrder  drawOrder )

virtual

Sets the drawing order for the current scale.

Parameters

drawOrder

The new drawing order.

See Also

getDrawOrder.

virtual void IlvAbstractScaleDisplayer::setGridDrawOrder ( IlvDrawOrder  drawOrder )

pure virtual

Sets the drawing order for the associated grid.

The drawing order enables the grid to be drawn either above (IlvDrawAbove) or below (IlvDrawBelow) other graphical representations. The grid and the scale can have different drawing orders. If no associated grid is defined, this method has no effect.

Parameters

drawOrder

The new drawing order for the associated grid.

Implemented in IlvSingleScaleDisplayer.

virtual void IlvAbstractScaleDisplayer::setLabelLayout ( LabelLayout  layout )

pure virtual

Sets the label layout on the scale axis.

This layout applies to the step labels and the axis label. The actual result on the screen depends on the projector used and on the position of the axis.

Parameters

layout

The new layout of the labels.

virtual void IlvAbstractScaleDisplayer::setLabelZoomFactor ( IlDouble  scale )

pure virtual

Sets the label scale factor.

(for internal use)

Implemented in IlvSingleScaleDisplayer.

virtual void IlvAbstractScaleDisplayer::setMajorTickSize ( IlvDim  size )

pure virtual

Sets the size of the major ticks.

Parameters

size	The new size of the major ticks.

Implemented in IlvSingleScaleDisplayer.

virtual void IlvAbstractScaleDisplayer::setMinorTickSize ( IlvDim  val )

pure virtual

Sets the size of the minor ticks.

Parameters

size	The new size of the minor ticks.

Implemented in IlvSingleScaleDisplayer.

void IlvAbstractScaleDisplayer::setName

(

const char *

name

)

Sets the name of the scale.

Parameters

name	The new name of the scale. The name passed as a parameter is copied.

virtual void IlvAbstractScaleDisplayer::setOffset ( IlvDim  dim )

pure virtual

Sets the offset between the ticks and the step labels.

Parameters

dim	The new offset between the ticks and the step labels.

Implemented in IlvSingleScaleDisplayer.

virtual void IlvAbstractScaleDisplayer::setRelativePosition ( IlvAxisPosition  relPos, IlvPos  offset = 0  )

virtual

Sets the position to which this scale is fixed.

The scale is fixed at the offset offset relative to the position relPos. The resulting position in screen coordinates depends on the projector used and on the data display area.

Parameters

offset	The new offset of the scale.
relPos	The new position relative to which the scale is fixed.

virtual void IlvAbstractScaleDisplayer::setStepLabel ( IlUInt  labelIndex, const char *  label  )

pure virtual

Sets the label for a given step by hand.

Parameters

labelIndex	The step index. If the index is invalid, the method does nothing.
label	The new label for the step. This label is copied before being set and the old one is freed.

Implemented in IlvSingleScaleDisplayer.

virtual void IlvAbstractScaleDisplayer::setStepLabelAngle ( IlDouble  angle )

pure virtual

Sets the angle of the step labels.

Parameters

angle

The new angle of the step labels.

Implemented in IlvSingleScaleDisplayer.

virtual void IlvAbstractScaleDisplayer::setStepLabelFormat ( const char *  format, IlBoolean  invalidate = IlTrue  )

pure virtual

Sets the format used to translate data values into step labels.

Parameters

format	The new format. The format parameter is copied and follows the same convention as the string formats used by the C primitives, such as printf.
invalidate	A Boolean value indicating whether the layout of the scale should be recomputed.

Warning

[note] The format is used in the IlvSingleScaleDisplayer::computeStepLabel method.

Implemented in IlvSingleScaleDisplayer.

virtual void IlvAbstractScaleDisplayer::setStepLabels ( IlUInt  count, const char *const *  labels = 0  )

pure virtual

Sets the step labels by hand.

The step labels can either be computed from their associated data values or manually specified by this method. The number of steps drawn by the scale is modified to match the count parameter.

Parameters

count	The number of labels.
labels	The new labels. Each label of this array is copied before being set. Each label previously defined is freed.

See Also

computeStepLabel.

Implemented in IlvSingleScaleDisplayer.

virtual void IlvAbstractScaleDisplayer::setStepLabelsPalette ( IlvPalette *  pal )

pure virtual

Sets the palette used to draw the step labels.

This method locks the new palette and unlocks the previous one.

Parameters

pal	The new palette.

Implemented in IlvSingleScaleDisplayer.

virtual void IlvAbstractScaleDisplayer::setTickLayout ( TickLayout  layout )

pure virtual

Sets the tick layout on the scale axis.

This layout applies to both major and minor ticks. The actual result on the screen depends on the projector used and on the position of the axis.

Parameters

layout

The new layout of the ticks.

Implemented in IlvSingleScaleDisplayer.

virtual void IlvAbstractScaleDisplayer::setValueToLabelCB ( IlvValueToLabelCB  cb, IlAny  cbData = 0  )

pure virtual

Sets a conversion callback between data values and step labels.

This method lets you specify a function that gives for a data value associated with a step the actual label that will be displayed for this step. The conversion callback is used by the IlvSingleScaleDisplayer::computeStepLabel method.

Parameters

cb	The conversion callback.
cbData	An optional parameter used to pass additional information to the callback.

Implemented in IlvSingleScaleDisplayer.

void IlvAbstractScaleDisplayer::setVisible

(

IlBoolean

visible

)

Sets the visibility of the scale.

Parameters

visible

The new value of the Boolean indicating whether the scale is visible (IlTrue) or hidden (IlFalse).

virtual void IlvAbstractScaleDisplayer::write ( IlvOutputFile &  file ) const

virtual

Writes the attributes of the current object in a file.

Called by the IlvAbstractScaleDisplayer::save method. This method can be overloaded in subclasses that define new attributes. The information written by the write method is read by the IO constructor, which takes an IlvInputFile as its only argument. Both this method and the IO constructor can be automatically declared by using the DeclareScaleDisplayerTypeInfo macro within the class declaration.

Parameters

file	The file where the attributes of the current object are written.

Reimplemented in IlvSingleScaleDisplayer.