Abstract base class for chart cursors. More...

#include <ilviews/charts/cursor.h>

Inheritance diagram for IlvAbstractChartCursor:

Public Member Functions
virtual	~IlvAbstractChartCursor ()
	Destructor. More...

virtual void	axisMarkBBox (const IlvSingleScaleDisplayer *scale, const IlvPoint &cursorPoint, IlDouble cursorAngle, IlvRect &bbox) const
	Returns the bounding box of the axis mark. More...

virtual void	boundingBox (const IlvSingleScaleDisplayer *scale, const IlvPoint &cursorPoint, IlDouble cursorAngle, const IlvRect &scaleDataDisplayArea, IlvRect &bbox) const
	Returns the bounding box of the cursor. More...

virtual void	delimiterBBox (const IlvSingleScaleDisplayer *scale, const IlvPoint &cursorPoint, IlDouble cursorAngle, const IlvRect &scaleDataDisplayArea, IlvRect &bbox) const =0
	Returns the bounding box of the delimiter. More...

virtual void	draw (const IlvSingleScaleDisplayer scale, const IlvPoint &cursorPoint, IlDouble cursorAngle, const IlvRect &scaleDataDisplayArea, IlvPort dst, const IlvRegion *clip) const
	Draws the cursor. More...

virtual void	drawAxisMark (const IlvSingleScaleDisplayer scale, const IlvPoint &cursorPoint, IlDouble cursorAngle, IlvPort dst, const IlvRegion *clip) const
	Draws the axis mark. More...

void	drawAxisMark (IlBoolean draw)
	Specifies whether the cursor draws an axis mark. More...

virtual void	drawDelimiter (const IlvSingleScaleDisplayer scale, const IlvPoint &cursorPoint, IlDouble cursorAngle, const IlvRect &scaleDataDisplayArea, IlvPort dst, const IlvRegion *clip) const =0
	Draws the cursor delimiter. More...

void	drawDelimiter (IlBoolean draw)
	Specifies whether the cursor draws a delimiter. More...

void	drawGhost (IlBoolean ghost)
	Specifies whether the delimiter is drawn is XOR mode. More...

IlvDrawOrder	getDrawOrder () const
	Returns the drawing order of the cursor. More...

const char *	getLabel () const
	Returns the label associated with the cursor. More...

const char *	getName () const
	Returns the name of the cursor. More...

IlvPalette *	getPalette () const
	Returns the palette used to draw the cursor. More...

IlDouble	getValue () const
	Returns the value associated with the cursor. More...

IlBoolean	isDrawingAxisMark () const
	Indicates whether the cursor draws an axis mark. More...

IlBoolean	isDrawingDelimiter () const
	Indicates whether the cursor draws a delimiter. More...

IlBoolean	isDrawingGhost () const
	Indicates whether the delimiter is drawn in XOR mode. More...

IlBoolean	isVisible () const
	Returns the visibility state of the cursor. More...

void	setDrawOrder (IlvDrawOrder drawOrder)
	Sets the drawing order of the cursor. More...

void	setLabel (const char *label)
	Sets the label of the cursor. More...

void	setName (const char *name)
	Sets the name of the cursor. More...

void	setPalette (IlvPalette *palette)
	Sets the palette used to draw the cursor. More...

void	setValue (IlDouble value)
	Sets the value of the cursor. More...

void	setVisible (IlBoolean visible)
	Sets the visibility state of the cursor. More...

Protected Member Functions
	IlvAbstractChartCursor (const IlvAbstractChartCursor &cursor)
	Constructor. More...

	IlvAbstractChartCursor (IlDouble value, IlvPalette *palette=0)
	Constructor. More...

	IlvAbstractChartCursor (IlvInputFile &file)
	Constructor. More...

Detailed Description

Abstract base class for chart cursors.

Library: ilvcharts

A chart cursor is a graphical indicator of a data value. The chart cursor is associated with a given scale and indicates the value of a data item on this scale. It is composed of two distinct items:

A delimiter that crosses the data display area at the position of the data value.
An axis mark located on the scale.

The axis mark indicates the data value on the scale. The axis mark displays the defined cursor label if it exists (see the IlvAbstractChartCursor::setLabel method) or the data value.

In order to speed up the drawing process when the cursor is used as a dynamic mark (for example, a crosshair), you can specify that the delimiter is to be drawn in XOR mode by using the IlvAbstractChartCursor::drawGhost method.

See also: IlvCircularChartCursor, IlvRadialChartCursor, IlvRectangularChartCursor.

Constructor & Destructor Documentation

◆ ~IlvAbstractChartCursor()

virtual IlvAbstractChartCursor::~IlvAbstractChartCursor ( )

virtual

Destructor.

The destructor unlocks the drawing palette if it was defined.

◆ IlvAbstractChartCursor() [1/3]

IlvAbstractChartCursor::IlvAbstractChartCursor	(	IlDouble	value,
		IlvPalette *	palette = `0`
	)

protected

Constructor.

Initializes a new IlvAbstractChartCursor object.

Parameters

value	The cursor value.
palette	The palette used to draw the cursor.

◆ IlvAbstractChartCursor() [2/3]

IlvAbstractChartCursor::IlvAbstractChartCursor ( const IlvAbstractChartCursor & cursor )

protected

Constructor.

Initializes a new IlvAbstractChartCursor object as a copy of cursor.

Parameters

cursor The object used to initialize the current one.

◆ IlvAbstractChartCursor() [3/3]

IlvAbstractChartCursor::IlvAbstractChartCursor ( IlvInputFile & file )

protected

Constructor.

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

Parameters

file	The file used to initialize the current cursor.

Member Function Documentation

◆ axisMarkBBox()

virtual void IlvAbstractChartCursor::axisMarkBBox	(	const IlvSingleScaleDisplayer *	scale,
		const IlvPoint &	cursorPoint,
		IlDouble	cursorAngle,
		IlvRect &	bbox
	)		const

virtual

Returns the bounding box of the axis mark.

Parameters

scale	The scale to which the cursor is attached.
cursorPoint	The point in view coordinates on the scale axis.
cursorAngle	The direction angle of the cursor from the scale axis.
bbox	The returned bounding box.

◆ boundingBox()

virtual void IlvAbstractChartCursor::boundingBox	(	const IlvSingleScaleDisplayer *	scale,
		const IlvPoint &	cursorPoint,
		IlDouble	cursorAngle,
		const IlvRect &	scaleDataDisplayArea,
		IlvRect &	bbox
	)		const

virtual

Returns the bounding box of the cursor.

This method returns the bounding rectangle containing both the delimiter and the axis mark. If the delimiter is drawn in ghost mode (see IlvAbstractChartCursor::isDrawingGhost), the delimiter is not taken into account. Also, the visibility of the two items is considered for the computation.

Parameters

scale	The scale to which the cursor is attached.
cursorPoint	The point in view coordinates on the scale axis.
cursorAngle	The direction angle of the cursor from the scale axis.
scaleDataDisplayArea	The data display area of the corresponding scale.
bbox	The returned bounding box.

◆ delimiterBBox()

virtual void IlvAbstractChartCursor::delimiterBBox	(	const IlvSingleScaleDisplayer *	scale,
		const IlvPoint &	cursorPoint,
		IlDouble	cursorAngle,
		const IlvRect &	scaleDataDisplayArea,
		IlvRect &	bbox
	)		const

pure virtual

Returns the bounding box of the delimiter.

This method must be defined in subclasses.

Parameters

scale	The scale to which the cursor is attached.
cursorPoint	The point in view coordinates on the scale axis.
cursorAngle	The direction angle of the cursor from the scale axis.
scaleDataDisplayArea	The data display area of the corresponding scale.
bbox	The returned bounding box.

Implemented in IlvRadialChartCursor, IlvCircularChartCursor, and IlvRectangularChartCursor.

◆ draw()

virtual void IlvAbstractChartCursor::draw	(	const IlvSingleScaleDisplayer *	scale,
		const IlvPoint &	cursorPoint,
		IlDouble	cursorAngle,
		const IlvRect &	scaleDataDisplayArea,
		IlvPort *	dst,
		const IlvRegion *	clip
	)		const

virtual

Draws the cursor.

This method draws the cursor. To do this, it checks whether the delimiter and the axis mark should be drawn, and calls the IlvAbstractChartCursor::drawDelimiter and IlvAbstractChartCursor::drawAxisMark methods accordingly.

Parameters

scale	The scale to which the cursor is attached.
cursorPoint	The point in view coordinates on the scale axis.
cursorAngle	The direction angle of the cursor from the scale axis.
scaleDataDisplayArea	The data display area of the corresponding scale.
dst	The drawing port.
clip	The drawing clip.

◆ drawAxisMark() [1/2]

virtual void IlvAbstractChartCursor::drawAxisMark	(	const IlvSingleScaleDisplayer *	scale,
		const IlvPoint &	cursorPoint,
		IlDouble	cursorAngle,
		IlvPort *	dst,
		const IlvRegion *	clip
	)		const

virtual

Draws the axis mark.

The default implementation of this method draws an image string containing the cursor label if it is defined (see the IlvAbstractChartCursor::getLabel method) or the cursor value (see the IlvAbstractChartCursor::getValue method) with the format defined for the scale (see the IlvAbstractScaleDisplayer::setStepLabelFormat method).

Parameters

scale	The scale to which the cursor is attached.
cursorPoint	The point in view coordinates on the scale axis.
cursorAngle	The direction angle of the cursor from the scale axis.
dst	The drawing port.
clip	The drawing clip.

◆ drawAxisMark() [2/2]

void IlvAbstractChartCursor::drawAxisMark ( IlBoolean draw )

Specifies whether the cursor draws an axis mark.

Parameters

draw	A Boolean value indicating whether the axis mark is drawn.

See also: isDrawingAxisMark.

◆ drawDelimiter() [1/2]

virtual void IlvAbstractChartCursor::drawDelimiter	(	const IlvSingleScaleDisplayer *	scale,
		const IlvPoint &	cursorPoint,
		IlDouble	cursorAngle,
		const IlvRect &	scaleDataDisplayArea,
		IlvPort *	dst,
		const IlvRegion *	clip
	)		const

pure virtual

Draws the cursor delimiter.

This method must be defined in subclasses. The defined method should take into account the ghost drawing property of the delimiter (see the IlvAbstractChartCursor::isDrawingGhost method).

Parameters

scale	The scale to which the cursor is attached.
cursorPoint	The point in view coordinates on the scale axis.
cursorAngle	The direction angle of the cursor from the scale axis.
scaleDataDisplayArea	The data display area of the corresponding scale.
dst	The drawing port.
clip	The drawing clip.

Implemented in IlvRadialChartCursor, IlvCircularChartCursor, and IlvRectangularChartCursor.

◆ drawDelimiter() [2/2]

void IlvAbstractChartCursor::drawDelimiter ( IlBoolean draw )

Specifies whether the cursor draws a delimiter.

Parameters

draw	A Boolean value indicating whether the delimiter is drawn.

See also: isDrawingDelimiter.

◆ drawGhost()

void IlvAbstractChartCursor::drawGhost ( IlBoolean ghost )

Specifies whether the delimiter is drawn is XOR mode.

This method lets you specify that the delimiter must be drawn in XOR mode when ghost is equal to IlTrue. This is useful when the cursor value is updated frequently since it enables you to avoid expensive redraw operations.

Parameters

ghost A Boolean value indicating whether the delimiter should be drawn in XOR mode.

See also: IlvChartGraphic::moveCursor, isDrawingGhost.

◆ getDrawOrder()

IlvDrawOrder IlvAbstractChartCursor::getDrawOrder ( ) const

Returns the drawing order of the cursor.

Returns: IlvDrawBelow if the cursor is drawn below the data and IlvDrawAbove if it is drawn above.

See also: setDrawOrder, IlvDrawOrder.

◆ getLabel()

const char* IlvAbstractChartCursor::getLabel ( ) const

Returns the label associated with the cursor.

Returns: The label associated with the cursor.

◆ getName()

const char* IlvAbstractChartCursor::getName ( ) const

virtual

Returns the name of the cursor.

Returns: The name of the cursor.

Reimplemented from IlvValueInterface.

◆ getPalette()

IlvPalette* IlvAbstractChartCursor::getPalette ( ) const

Returns the palette used to draw the cursor.

Returns: The palette used to draw the cursor.

See also: setPalette.

◆ getValue()

IlDouble IlvAbstractChartCursor::getValue ( ) const

Returns the value associated with the cursor.

Returns: The value associated with the cursor.

◆ isDrawingAxisMark()

IlBoolean IlvAbstractChartCursor::isDrawingAxisMark ( ) const

Indicates whether the cursor draws an axis mark.

Returns: IlTrue if the cursor draws an axis mark and IlFalse otherwise.

See also: drawAxisMark(IlBoolean).

◆ isDrawingDelimiter()

IlBoolean IlvAbstractChartCursor::isDrawingDelimiter ( ) const

Indicates whether the cursor draws a delimiter.

Returns: IlTrue if the cursor draws a delimiter and IlFalse otherwise.

See also: drawDelimiter(IlBoolean).

◆ isDrawingGhost()

IlBoolean IlvAbstractChartCursor::isDrawingGhost ( ) const

Indicates whether the delimiter is drawn in XOR mode.

Returns: IlTrue if the delimiter is drawn in XOR mode and IlFalse otherwise.

See also: drawGhost.

◆ isVisible()

IlBoolean IlvAbstractChartCursor::isVisible ( ) const

Returns the visibility state of the cursor.

Returns: IlTrue if the cursor is visible and IlFalse otherwise.

◆ setDrawOrder()

void IlvAbstractChartCursor::setDrawOrder ( IlvDrawOrder drawOrder )

Sets the drawing order of the cursor.

The drawing order determines whether the cursor is drawn above or below the displayed data.

Parameters

drawOrder The new drawing order.

See also: IlvDrawOrder.

◆ setLabel()

void IlvAbstractChartCursor::setLabel ( const char * label )

Sets the label of the cursor.

The label will be drawn on the axis if it is defined. Otherwise, the value associated with the cursor will be drawn.

Parameters

label The new label. The label passed as a parameter is copied.

See also: drawAxisMark.

◆ setName()

void IlvAbstractChartCursor::setName ( const char * name )

Sets the name of the cursor.

Parameters

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

◆ setPalette()

void IlvAbstractChartCursor::setPalette ( IlvPalette * palette )

Sets the palette used to draw the cursor.

The new palette is locked. If the palette is 0, the cursor will use the axis palette of the scale to draw itself.

Parameters

palette The new palette used to draw the cursor.

◆ setValue()

void IlvAbstractChartCursor::setValue ( IlDouble value )

Sets the value of the cursor.

This value is used to compute the position of the cursor on the scale.

Parameters

value The new value of the cursor.

◆ setVisible()

void IlvAbstractChartCursor::setVisible ( IlBoolean visible )

Sets the visibility state of the cursor.

Parameters

visible A Boolean indicating whether the cursor is visible (IlTrue) or hidden (IlFalse).

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IlvAbstractChartCursor()

◆ IlvAbstractChartCursor() [1/3]

◆ IlvAbstractChartCursor() [2/3]

◆ IlvAbstractChartCursor() [3/3]

Member Function Documentation

◆ axisMarkBBox()

◆ boundingBox()

◆ delimiterBBox()

◆ draw()

◆ drawAxisMark() [1/2]

◆ drawAxisMark() [2/2]

◆ drawDelimiter() [1/2]

◆ drawDelimiter() [2/2]

◆ drawGhost()

◆ getDrawOrder()

◆ getLabel()

◆ getName()

◆ getPalette()

◆ getValue()

◆ isDrawingAxisMark()

◆ isDrawingDelimiter()

◆ isDrawingGhost()

◆ isVisible()

◆ setDrawOrder()

◆ setLabel()

◆ setName()

◆ setPalette()

◆ setValue()

◆ setVisible()