rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Charts Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvCircularChartCursor Class Reference

Cursor subclass for ordinate scales of polar charts. More...

#include <ilviews/charts/cursor.h>

Inheritance diagram for IlvCircularChartCursor:
IlvAbstractChartCursor

List of all members.

Public Member Functions

 IlvCircularChartCursor (IlDouble value, IlvCircularScaleDisplayer *ref, IlvPalette *palette=0)
 Constructor.
virtual void delimiterBBox (const IlvSingleScaleDisplayer *scale, const IlvPoint &cursorPoint, IlDouble cursorAngle, const IlvRect &scaleDataDisplayArea, IlvRect &bbox) const
 Returns the bounding box of the delimiter.
virtual void drawDelimiter (const IlvSingleScaleDisplayer *scale, const IlvPoint &cursorPoint, IlDouble cursorAngle, const IlvRect &scaleDataDisplayArea, IlvPort *dst, const IlvRegion *clip) const
 Draws the cursor delimiter.

Detailed Description

Cursor subclass for ordinate scales of polar charts.

Library: ilvcharts

This class is a subclass of IlvAbstractChartCursor that allows you to define a circular cursor. This kind of cursor is used only for polar charts. A polar chart displays data expressed in polar coordinates with an abscissa scale that is circular and ordinate scales that are radial. A circular cursor is designed to be added to a radial scale of a polar chart. It draws an arc intersecting this scale at the corresponding value of the cursor. The drawn arc and the abscissa scale are concentric.

You can see an example of a circular cursor on the figure below where a cursor is added to the ordinate scale of the displayed chart. You can notice that the cursor line is drawn by using the same range as the circular abscissa scale.

img_circular_cursor.gif
See also:
IlvAbstractChartCursor.

Constructor & Destructor Documentation

IlvCircularChartCursor::IlvCircularChartCursor ( IlDouble  value,
IlvCircularScaleDisplayer ref,
IlvPalette palette = 0 
)

Constructor.

Initializes a new IlvCircularChartCursor object. The opposite scale of the chart (that is, the abscissa scale) must be provided as a reference.

Parameters:
value The cursor value.
ref The reference scale.
palette The palette used to draw the cursor.

Member Function Documentation

virtual void IlvCircularChartCursor::delimiterBBox ( const IlvSingleScaleDisplayer scale,
const IlvPoint cursorPoint,
IlDouble  cursorAngle,
const IlvRect scaleDataDisplayArea,
IlvRect bbox 
) const [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.

Implements IlvAbstractChartCursor.

virtual void IlvCircularChartCursor::drawDelimiter ( const IlvSingleScaleDisplayer scale,
const IlvPoint cursorPoint,
IlDouble  cursorAngle,
const IlvRect scaleDataDisplayArea,
IlvPort dst,
const IlvRegion clip 
) const [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.

Implements IlvAbstractChartCursor.


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