.Simulation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
QCPlot::QCPItemTracer Class Reference

Item that sticks to QCPGraph data points. More...

Inheritance diagram for QCPlot::QCPItemTracer:
QCPlot::QCPAbstractItem QCPlot::QCPLayerable

Public Types

enum  TracerStyle {
  tsNone, tsPlus, tsCrosshair, tsCircle,
  tsSquare
}
 The different visual appearances a tracer item can have. More...
 

Public Member Functions

 QCPItemTracer (QCustomPlot *parentPlot)
 Creates a tracer item and sets default values. More...
 
QPen pen () const
 
QPen selectedPen () const
 
QBrush brush () const
 
QBrush selectedBrush () const
 
double size () const
 
TracerStyle style () const
 
QCPGraphgraph () const
 
double graphKey () const
 
bool interpolating () const
 
void setPen (const QPen &pen)
 Sets the pen that will be used to draw the line of the tracer. More...
 
void setSelectedPen (const QPen &pen)
 Sets the pen that will be used to draw the line of the tracer when selected. More...
 
void setBrush (const QBrush &brush)
 Sets the brush that will be used to draw any fills of the tracer. More...
 
void setSelectedBrush (const QBrush &brush)
 Sets the brush that will be used to draw any fills of the tracer, when selected. More...
 
void setSize (double size)
 Sets the size of the tracer in pixels, if the style supports setting a size (e.g. More...
 
void setStyle (TracerStyle style)
 Sets the style/visual appearance of the tracer. More...
 
void setGraph (QCPGraph *graph)
 Sets the QCPGraph this tracer sticks to. More...
 
void setGraphKey (double key)
 Sets the key of the graph's data point the tracer will be positioned at. More...
 
void setInterpolating (bool enabled)
 Sets whether the value of the graph's data points shall be interpolated, when positioning the tracer. More...
 
virtual double selectTest (const QPointF &pos) const
 This function is used to decide whether a click hits an item or not. More...
 
void updatePosition ()
 If the tracer is connected with a graph (setGraph), this function updates the tracer's position to reside on the graph data, depending on the configured key (setGraphKey). More...
 
- Public Member Functions inherited from QCPlot::QCPAbstractItem
 QCPAbstractItem (QCustomPlot *parentPlot)
 Base class constructor which initializes base class members.
 
bool clipToAxisRect () const
 
QCPAxisclipKeyAxis () const
 
QCPAxisclipValueAxis () const
 
bool selectable () const
 
bool selected () const
 
void setClipToAxisRect (bool clip)
 Sets whether the item shall be clipped to the axis rect or whether it shall be visible on the entire QCustomPlot. More...
 
void setClipAxes (QCPAxis *keyAxis, QCPAxis *valueAxis)
 Sets both clip axes. More...
 
void setClipKeyAxis (QCPAxis *axis)
 Sets the clip key axis. More...
 
void setClipValueAxis (QCPAxis *axis)
 Sets the clip value axis. More...
 
void setSelectable (bool selectable)
 Sets whether the user can (de-)select this item by clicking on the QCustomPlot surface. More...
 
void setSelected (bool selected)
 Sets whether this item is selected or not. More...
 
QList< QCPItemPosition * > positions () const
 Returns all positions of the item in a list. More...
 
QList< QCPItemAnchor * > anchors () const
 Returns all anchors of the item in a list. More...
 
QCPItemPositionposition (const QString &name) const
 Returns the QCPItemPosition with the specified name. More...
 
QCPItemAnchoranchor (const QString &name) const
 Returns the QCPItemAnchor with the specified name. More...
 
bool hasAnchor (const QString &name) const
 Returns whether this item has an anchor with the specified name. More...
 
- Public Member Functions inherited from QCPlot::QCPLayerable
 QCPLayerable (QCustomPlot *parentPlot)
 Creates a new QCPLayerable instance. More...
 
bool visible () const
 
QCustomPlotparentPlot () const
 
QCPLayerlayer () const
 
bool antialiased () const
 
void setVisible (bool on)
 Sets the visibility of this layerable object. More...
 
bool setLayer (QCPLayer *layer)
 Sets the layer of this layerable object. More...
 
bool setLayer (const QString &layerName)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets the layer of this layerable object by name. More...
 
void setAntialiased (bool enabled)
 Sets whether this object will be drawn antialiased or not. More...
 

Public Attributes

QCPItemPosition *const position
 

Protected Member Functions

virtual void draw (QCPPainter *painter)
 
QPen mainPen () const
 
QBrush mainBrush () const
 
- Protected Member Functions inherited from QCPlot::QCPAbstractItem
virtual QRect clipRect () const
 
virtual void applyDefaultAntialiasingHint (QCPPainter *painter) const
 
double distSqrToLine (const QPointF &start, const QPointF &end, const QPointF &point) const
 
double rectSelectTest (const QRectF &rect, const QPointF &pos, bool filledRect) const
 
virtual QPointF anchorPixelPoint (int anchorId) const
 
QCPItemPositioncreatePosition (const QString &name)
 
QCPItemAnchorcreateAnchor (const QString &name, int anchorId)
 
- Protected Member Functions inherited from QCPlot::QCPLayerable
bool moveToLayer (QCPLayer *layer, bool prepend)
 
void applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const
 

Protected Attributes

QPen mPen
 
QPen mSelectedPen
 
QBrush mBrush
 
QBrush mSelectedBrush
 
double mSize
 
TracerStyle mStyle
 
QCPGraphmGraph
 
double mGraphKey
 
bool mInterpolating
 
- Protected Attributes inherited from QCPlot::QCPAbstractItem
bool mClipToAxisRect
 
QCPAxismClipKeyAxis
 
QCPAxismClipValueAxis
 
bool mSelectable
 
bool mSelected
 
QList< QCPItemPosition * > mPositions
 
QList< QCPItemAnchor * > mAnchors
 
- Protected Attributes inherited from QCPlot::QCPLayerable
bool mVisible
 
QCustomPlotmParentPlot
 
QCPLayermLayer
 
bool mAntialiased
 

Additional Inherited Members

- Signals inherited from QCPlot::QCPAbstractItem
void selectionChanged (bool selected)
 This signal is emitted when the selection state of this item has changed, either by user interaction or by a direct call to setSelected.
 

Detailed Description

Item that sticks to QCPGraph data points.

QCPItemTracer.png
Tracer example. Blue dotted circles are anchors, solid blue discs are positions.

The tracer can be connected with a QCPGraph via setGraph. Then it will automatically adopt the coordinate axes of the graph and update its position to be on the graph's data. This means the key stays controllable via setGraphKey, but the value will follow the graph data. If a QCPGraph is connected, note that setting the coordinates directly via position will have no effect, i.e. be overriden in the next redraw (this is when the coodinate update happens).

If the specified key in setGraphKey is outside the key bounds of the graph, the tracer will stay at the respective end of the graph.

With setInterpolating you may specify whether the tracer may only stay exactly on data points or whether it interpolates data points linearly, if given a key that lies between two data points of the graph.

The tracer has different visual styles, see setStyle. It is also possible to make the tracer have no own visual appearance (set the style to tsNone), and just connect other item positions to the tracer position (used as an anchor) via QCPItemPosition::setParentAnchor.

Note
The tracer position is only automatically updated upon redraws. This means when, for example, the data of the graph changes and you immediately afterwards (without a redraw) read the position coordinates of the tracer, they will not reflect the updated data of the graph. In this case you should call updatePosition manually, prior to reading the tracer coordinates.

Member Enumeration Documentation

The different visual appearances a tracer item can have.

Some styles size may be controlled with setSize.

See Also
setStyle
Enumerator
tsNone 

The tracer is not visible.

tsPlus 

A plus shaped crosshair with limited size.

tsCrosshair 

A plus shaped crosshair which spans the complete axis rect.

tsCircle 

A circle.

tsSquare 

A square.

Constructor & Destructor Documentation

QCPlot::QCPItemTracer::QCPItemTracer ( QCustomPlot parentPlot)

Creates a tracer item and sets default values.

The constructed item can be added to the plot with QCustomPlot::addItem.

Member Function Documentation

double QCPlot::QCPItemTracer::selectTest ( const QPointF &  pos) const
virtual

This function is used to decide whether a click hits an item or not.

pos is a point in pixel coordinates on the QCustomPlot surface. This function returns the shortest pixel distance of this point to the item. If the item is either invisible or the distance couldn't be determined, -1.0 is returned. setSelectable has no influence on the return value of this function.

If the item is represented not by single lines but by an area like QCPItemRect or QCPItemText, a click inside the area returns a constant value greater zero (typically 99% of the selectionTolerance of the parent QCustomPlot). If the click lies outside the area, this function returns -1.0.

Providing a constant value for area objects allows selecting line objects even when they are obscured by such area objects, by clicking close to the lines (i.e. closer than 0.99*selectionTolerance).

The actual setting of the selection state is not done by this function. This is handled by the parent QCustomPlot when the mouseReleaseEvent occurs.

See Also
setSelected, QCustomPlot::setInteractions

Implements QCPlot::QCPAbstractItem.

void QCPlot::QCPItemTracer::setBrush ( const QBrush &  brush)

Sets the brush that will be used to draw any fills of the tracer.

See Also
setSelectedBrush, setPen
void QCPlot::QCPItemTracer::setGraph ( QCPGraph graph)

Sets the QCPGraph this tracer sticks to.

The tracer position will be set to type QCPItemPosition::ptPlotCoords and the axes will be set to the axes of graph.

To free the tracer from any graph, set graph to 0. The tracer position can then be placed freely like any other item position. This is the state the tracer will assume when its graph gets deleted while still attached to it.

See Also
setGraphKey
void QCPlot::QCPItemTracer::setGraphKey ( double  key)

Sets the key of the graph's data point the tracer will be positioned at.

This is the only free cordinate of a tracer when attached to a graph.

Depending on setInterpolating, the tracer will be either positioned on the data point closest to key, or will stay exactly at key and interpolate the value linearly.

See Also
setGraph, setInterpolating
void QCPlot::QCPItemTracer::setInterpolating ( bool  enabled)

Sets whether the value of the graph's data points shall be interpolated, when positioning the tracer.

If enabled is set to false and a key is given with setGraphKey, the tracer is placed on the data point of the graph which is closest to the key, but which is not necessarily exactly there. If enabled is true, the tracer will be positioned exactly at the specified key, and the appropriate value will be interpolated from the graph's data points linearly.

See Also
setGraph, setGraphKey
void QCPlot::QCPItemTracer::setPen ( const QPen &  pen)

Sets the pen that will be used to draw the line of the tracer.

See Also
setSelectedPen, setBrush
void QCPlot::QCPItemTracer::setSelectedBrush ( const QBrush &  brush)

Sets the brush that will be used to draw any fills of the tracer, when selected.

See Also
setBrush, setSelected
void QCPlot::QCPItemTracer::setSelectedPen ( const QPen &  pen)

Sets the pen that will be used to draw the line of the tracer when selected.

See Also
setPen, setSelected
void QCPlot::QCPItemTracer::setSize ( double  size)

Sets the size of the tracer in pixels, if the style supports setting a size (e.g.

tsSquare does, tsCrosshair does not).

void QCPlot::QCPItemTracer::setStyle ( QCPItemTracer::TracerStyle  style)

Sets the style/visual appearance of the tracer.

If you only want to use the tracer position as an anchor for other items, set style to tsNone.

void QCPlot::QCPItemTracer::updatePosition ( )

If the tracer is connected with a graph (setGraph), this function updates the tracer's position to reside on the graph data, depending on the configured key (setGraphKey).

It is called automatically on every redraw and normally doesn't need to be called manually. One exception is when you want to read the tracer coordinates via position and are not sure that the graph's data (or the tracer key with setGraphKey) hasn't changed since the last redraw. In that situation, call this function before accessing position, to make sure you don't get out-of-date coordinates.

If there is no graph set on this tracer, this function does nothing.


The documentation for this class was generated from the following files: