Views
Charts Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvChartDataGraphicInfo Class Reference

Allows you to draw an IlvGraphic object next to a data point. More...

#include <ilviews/charts/data.h>

Inheritance diagram for IlvChartDataGraphicInfo:
IlvChartDataPointInfo IlvChartDataPointLabel IlvPieSliceInfo

Public Member Functions

 IlvChartDataGraphicInfo (IlvGraphic *graphic, IlvPos dx=0, IlvPos dy=0, IlvPosition anchorPosition=IlvCenter, IlvPalette *palette=0)
 Initializes a new IlvChartDataGraphicInfo object. More...
 
virtual ~IlvChartDataGraphicInfo ()
 Destructor. More...
 
virtual IlBoolean boundingBox (const IlvPoint &point, const IlvChartDataSet *dataSet, IlUInt ptidx, const IlvChartGraphic *chart, IlvRect &bbox, const IlvTransformer *t=0) const
 Returns the bounding box of the graphical information drawn next to the representation of the data point. More...
 
virtual void draw (const IlvPoint &point, const IlvChartDataSet *dataSet, IlUInt ptidx, const IlvChartGraphic *chart, IlvPort *dst, const IlvTransformer *t=0, const IlvRegion *clip=0) const
 Draws some graphical information next to the representation of the data point. More...
 
IlvPosition getAnchorPosition () const
 Returns the anchor position of the graphic object. More...
 
IlvGraphicgetGraphic () const
 Returns the stored graphic object. More...
 
const IlvPointgetOffset () const
 Returns the offset that is used to draw the graphic object. More...
 
void setAnchorPosition (IlvPosition position)
 Sets the anchor position of the graphic object. More...
 
void setGraphic (IlvGraphic *graphic)
 Sets the graphic object that is drawn. More...
 
virtual void setMode (IlvDrawMode)
 Sets the drawing mode. More...
 
void setOffset (const IlvPoint &offset)
 Sets the offset that is used to draw the stored graphic object. More...
 
virtual void setOverwrite (IlBoolean)
 Sets the way the drawing member functions operate. More...
 
- Public Member Functions inherited from IlvChartDataPointInfo
 IlvChartDataPointInfo (const IlvChartDataPointInfo &pointInfo)
 Initializes a new IlvChartDataPointInfo object as a copy of another IlvChartDataPointInfo. More...
 
 IlvChartDataPointInfo (IlvInputFile &file)
 Initializes a new IlvChartDataPointInfo object from an input file. More...
 
 IlvChartDataPointInfo (IlvPalette *palette=0)
 Initializes a new IlvChartDataPointInfo object. More...
 
virtual ~IlvChartDataPointInfo ()
 Destructor. More...
 
virtual IlvChartDataPointInfocopy () const
 Creates and returns a copy of the current object. More...
 
IlvPalettegetPalette () const
 Returns the specific palette. More...
 
virtual IlBoolean getPalette (const IlvChartDataSet *dataSet, IlUInt idx, const IlvAbstractChartDisplayer *disp, const IlvPalette *defaultPalette, IlvPalette *returnPalette) const
 Gets the specific palette for a point in the same collection. More...
 
void lock ()
 Locks the current IlvChartDataPointInfo object. More...
 
IlvOutputFilesave (IlvOutputFile &file) const
 Writes a complete description of the current object in a file. More...
 
void setForeground (IlvColor *color)
 Sets the foreground color for the specific palette. More...
 
void setPalette (IlvPalette *pal)
 Sets the specific palette. More...
 
void unLock ()
 Unlocks the current IlvChartDataPointInfo object. More...
 
virtual void write (IlvOutputFile &file) const
 Writes the attributes of the current object in a file. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvChartDataPointInfo
static IlvChartDataPointInfoLoad (IlvInputFile &file)
 Reads a point information object from a file. More...
 
static IlvChartDataPointInfoRead (IlvInputFile &file)
 Reads the attributes of a point information object from a file. More...
 

Detailed Description

Allows you to draw an IlvGraphic object next to a data point.

Library: ilvcharts

This class is a subclass of IlvChartDataPointInfo that is used to draw any kind of graphic object (an instance of a subclass of the IlvGraphic class) next to the representation of a data point.

Each instance stores a graphic object and information specifying the location where the graphic object is drawn with respect to the location of the projected data point. This information includes:

See also
IlvChartDataPointInfo, IlvPointInfoCollection.

Constructor & Destructor Documentation

◆ IlvChartDataGraphicInfo()

IlvChartDataGraphicInfo::IlvChartDataGraphicInfo ( IlvGraphic graphic,
IlvPos  dx = 0,
IlvPos  dy = 0,
IlvPosition  anchorPosition = IlvCenter,
IlvPalette palette = 0 
)

Initializes a new IlvChartDataGraphicInfo object.

Parameters
graphicThe stored graphic object.
dxThe x-offset that is used to draw the graphic object from the projected data point.
dyThe y-offset that is used to draw the graphic object from the projected data point.
anchorPositionThe position that specifies which point of the bounding box of graphic will be positioned at the offset (dx, dy) from the projected data point.
paletteThe palette that is used to draw the data point.

◆ ~IlvChartDataGraphicInfo()

virtual IlvChartDataGraphicInfo::~IlvChartDataGraphicInfo ( )
virtual

Destructor.

The destructor deletes the stored graphic object.

Member Function Documentation

◆ boundingBox()

virtual IlBoolean IlvChartDataGraphicInfo::boundingBox ( const IlvPoint point,
const IlvChartDataSet dataSet,
IlUInt  ptidx,
const IlvChartGraphic chart,
IlvRect bbox,
const IlvTransformer t = 0 
) const
virtual

Returns the bounding box of the graphical information drawn next to the representation of the data point.

Returns the bounding box of the stored graphic object.

Parameters
pointThe coordinates of the projected data point.
dataSetThe data set holding the considered data point.
ptidxThe index of the considered data point in the dataSet dataSet.
chartThe chart object for which the graphical information is drawn.
bboxThe returned bounding box.
tThe applied transformer.
Returns
IlTrue if the bounding box has been successfully computed and IlFalse otherwise.

Reimplemented from IlvChartDataPointInfo.

Reimplemented in IlvChartDataPointLabel.

◆ draw()

virtual void IlvChartDataGraphicInfo::draw ( const IlvPoint point,
const IlvChartDataSet dataSet,
IlUInt  ptidx,
const IlvChartGraphic chart,
IlvPort dst,
const IlvTransformer t = 0,
const IlvRegion clip = 0 
) const
virtual

Draws some graphical information next to the representation of the data point.

Draws the stored graphic object with respect to the projected data point given by point.

Parameters
pointThe coordinates of the projected data point.
dataSetThe data set holding the considered data point.
ptidxThe index of the considered data point in the dataSet dataSet.
chartThe chart object for which the graphical information is drawn.
dstThe port where the graphical representation is drawn.
tThe transformer applied to dst.
clipThe clipping region.

Reimplemented from IlvChartDataPointInfo.

Reimplemented in IlvChartDataPointLabel.

◆ getAnchorPosition()

IlvPosition IlvChartDataGraphicInfo::getAnchorPosition ( ) const

Returns the anchor position of the graphic object.

The position determines the point on the bounding box of the graphic object that used as an anchor to compute where this object should be drawn. This point on the bounding box will be positioned at the offset returned by the IlvChartDataGraphicInfo::getOffset() method from the projected data point.

Returns
The anchor position of the graphic object.
See also
getOffset().

◆ getGraphic()

IlvGraphic* IlvChartDataGraphicInfo::getGraphic ( ) const

Returns the stored graphic object.

Returns
The stored graphic object.

◆ getOffset()

const IlvPoint& IlvChartDataGraphicInfo::getOffset ( ) const

Returns the offset that is used to draw the graphic object.

The offset is used in conjunction with the anchor position to determine the location where the graphic object is drawn with respect to the location of the projected data point.

Returns
The offset that is used to draw the graphic object.
See also
getAnchorPosition()

◆ setAnchorPosition()

void IlvChartDataGraphicInfo::setAnchorPosition ( IlvPosition  position)

Sets the anchor position of the graphic object.

Parameters
positionThe new anchor position.
See also
getAnchorPosition().

◆ setGraphic()

void IlvChartDataGraphicInfo::setGraphic ( IlvGraphic graphic)

Sets the graphic object that is drawn.

The previous graphic object is deleted and replaced with graphic.

Parameters
graphicThe new graphic object.

◆ setMode()

virtual void IlvChartDataGraphicInfo::setMode ( IlvDrawMode  mode)
virtual

Sets the drawing mode.

Sets the drawing mode for the current object. The information is passed to the palette stored by the object.

Parameters
modeThe new drawing mode for the current object.

Reimplemented from IlvChartDataPointInfo.

◆ setOffset()

void IlvChartDataGraphicInfo::setOffset ( const IlvPoint offset)

Sets the offset that is used to draw the stored graphic object.

Parameters
offsetThe new offset.
See also
getOffset()

◆ setOverwrite()

virtual void IlvChartDataGraphicInfo::setOverwrite ( IlBoolean  o)
virtual

Sets the way the drawing member functions operate.

Modifies the way the drawing member functions of the current object operate, when drawing on the root port. If the o parameter is set to IlFalse, the drawing operations are hidden by the windows stored on the top window. If the parameter is set to IlTrue, the drawing operations are performed on top of every window present on the screen, just as if the windows were part of the root window. The information is passed to the palette stored by the object.

Parameters
oThe new value of the Boolean indicating the way the drawing member functions operate.

Reimplemented from IlvChartDataPointInfo.