Vespucci  1.0.0
QCPLayerable Class Referenceabstract

Base class for all drawable objects. More...

#include <qcustomplot.h>

Inheritance diagram for QCPLayerable:
QCPAbstractItem QCPAbstractPlottable QCPAxis QCPGrid QCPLayoutElement QCPItemBracket QCPItemCurve QCPItemEllipse QCPItemLine QCPItemPixmap QCPItemRect QCPItemStraightLine QCPItemText QCPItemTracer QCPBars QCPColorMap QCPCurve QCPFinancial QCPGraph QCPStatisticalBox QCPAbstractLegendItem QCPAxisRect QCPColorScale QCPLayout QCPPlotTitle


void layerChanged (QCPLayer *newLayer)

Public Member Functions

 QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=0)
 ~QCPLayerable ()
bool visible () const
QCustomPlotparentPlot () const
QCPLayerableparentLayerable () const
QCPLayerlayer () const
bool antialiased () const
void setVisible (bool on)
Q_SLOT bool setLayer (QCPLayer *layer)
bool setLayer (const QString &layerName)
void setAntialiased (bool enabled)
virtual double selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const
bool realVisibility () const

Protected Member Functions

virtual void parentPlotInitialized (QCustomPlot *parentPlot)
virtual QCP::Interaction selectionCategory () const
virtual QRect clipRect () const
virtual void applyDefaultAntialiasingHint (QCPPainter *painter) const =0
virtual void draw (QCPPainter *painter)=0
virtual void selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged)
virtual void deselectEvent (bool *selectionStateChanged)
void initializeParentPlot (QCustomPlot *parentPlot)
void setParentLayerable (QCPLayerable *parentLayerable)
bool moveToLayer (QCPLayer *layer, bool prepend)
void applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const

Protected Attributes

bool mVisible
QPointer< QCPLayerablemParentLayerable
bool mAntialiased


class QCustomPlot
class QCPAxisRect

Detailed Description

Base class for all drawable objects.

This is the abstract base class most visible objects derive from, e.g. plottables, axes, grid etc.

Every layerable is on a layer (QCPLayer) which allows controlling the rendering order by stacking the layers accordingly.

For details about the layering mechanism, see the QCPLayer documentation.

Definition at line 413 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPLayerable::QCPLayerable ( QCustomPlot plot,
QString  targetLayer = QString(),
QCPLayerable parentLayerable = 0 

Creates a new QCPLayerable instance.

Since QCPLayerable is an abstract base class, it can't be instantiated directly. Use one of the derived classes.

If plot is provided, it automatically places itself on the layer named targetLayer. If targetLayer is an empty string, it places itself on the current layer of the plot (see QCustomPlot::setCurrentLayer).

It is possible to provide 0 as plot. In that case, you should assign a parent plot at a later time with initializeParentPlot.

The layerable's parent layerable is set to parentLayerable, if provided. Direct layerable parents are mainly used to control visibility in a hierarchy of layerables. This means a layerable is only drawn, if all its ancestor layerables are also visible. Note that parentLayerable does not become the QObject-parent (for memory management) of this layerable, plot does.

Definition at line 936 of file qcustomplot.cpp.

QCPLayerable::~QCPLayerable ( )

Definition at line 953 of file qcustomplot.cpp.

Member Function Documentation

bool QCPLayerable::antialiased ( ) const

Definition at line 432 of file qcustomplot.h.

void QCPLayerable::applyAntialiasingHint ( QCPPainter painter,
bool  localAntialiased,
QCP::AntialiasedElement  overrideElement 
) const

Definition at line 1163 of file qcustomplot.cpp.

void QCPLayerable::applyDefaultAntialiasingHint ( QCPPainter painter) const
protectedpure virtual
QRect QCPLayerable::clipRect ( ) const

Reimplemented in QCPAbstractLegendItem, QCPAbstractItem, and QCPAbstractPlottable.

Definition at line 1219 of file qcustomplot.cpp.

void QCPLayerable::deselectEvent ( bool *  selectionStateChanged)
void QCPLayerable::initializeParentPlot ( QCustomPlot parentPlot)

Definition at line 1093 of file qcustomplot.cpp.

QCPLayer* QCPLayerable::layer ( ) const

Definition at line 431 of file qcustomplot.h.

void QCPLayerable::layerChanged ( QCPLayer newLayer)

This signal is emitted when the layer of this layerable changes, i.e. this layerable is moved to a different layer.

See also
bool QCPLayerable::moveToLayer ( QCPLayer layer,
bool  prepend 

Definition at line 1132 of file qcustomplot.cpp.

QCPLayerable * QCPLayerable::parentLayerable ( ) const

Returns the parent layerable of this layerable. The parent layerable is used to provide visibility hierarchies in conjunction with the method realVisibility. This way, layerables only get drawn if their parent layerables are visible, too.

Note that a parent layerable is not necessarily also the QObject parent for memory management. Further, a layerable doesn't always have a parent layerable, so this function may return 0.

A parent layerable is set implicitly with when placed inside layout elements and doesn't need to be set manually by the user.

Definition at line 430 of file qcustomplot.h.

QCustomPlot* QCPLayerable::parentPlot ( ) const

Definition at line 429 of file qcustomplot.h.

void QCPLayerable::parentPlotInitialized ( QCustomPlot parentPlot)

Reimplemented in QCPLegend, and QCPLayoutElement.

Definition at line 1189 of file qcustomplot.cpp.

bool QCPLayerable::realVisibility ( ) const

Returns whether this layerable is visible, taking the visibility of the layerable parent and the visibility of the layer this layerable is on into account. This is the method that is consulted to decide whether a layerable shall be drawn or not.

If this layerable has a direct layerable parent (usually set via hierarchies implemented in subclasses, like in the case of QCPLayoutElement), this function returns true only if this layerable has its visibility set to true and the parent layerable's realVisibility returns true.

If this layerable doesn't have a direct layerable parent, returns the state of this layerable's visibility.

Definition at line 1029 of file qcustomplot.cpp.

void QCPLayerable::selectEvent ( QMouseEvent *  event,
bool  additive,
const QVariant &  details,
bool *  selectionStateChanged 
QCP::Interaction QCPLayerable::selectionCategory ( ) const

Reimplemented in QCPLegend, QCPAbstractLegendItem, QCPAbstractItem, QCPAbstractPlottable, and QCPAxis.

Definition at line 1205 of file qcustomplot.cpp.

double QCPLayerable::selectTest ( const QPointF &  pos,
bool  onlySelectable,
QVariant *  details = 0 
) const

This function is used to decide whether a click hits a layerable object 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 object. If the object is either invisible or the distance couldn't be determined, -1.0 is returned. Further, if onlySelectable is true and the object is not selectable, -1.0 is returned, too.

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 the selectionTolerance of the parent QCustomPlot multiplied by 0.99). 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, and the finally selected object is notified via the selectEvent/deselectEvent methods.

details is an optional output parameter. Every layerable subclass may place any information in details. This information will be passed to selectEvent when the parent QCustomPlot decides on the basis of this selectTest call, that the object was successfully selected. The subsequent call to selectEvent will carry the details. This is useful for multi-part objects (like QCPAxis). This way, a possibly complex calculation to decide which part was clicked is only done once in selectTest. The result (i.e. the actually clicked part) can then be placed in details. So in the subsequent selectEvent, the decision which part was selected doesn't have to be done a second time for a single selection operation.

You may pass 0 as details to indicate that you are not interested in those selection details.

See also
selectEvent, deselectEvent, QCustomPlot::setInteractions

Reimplemented in QCPItemBracket, QCPItemTracer, QCPItemPixmap, QCPItemEllipse, QCPItemText, QCPItemRect, QCPItemCurve, QCPItemLine, QCPItemStraightLine, QCPFinancial, QCPColorMap, QCPStatisticalBox, QCPBars, QCPCurve, QCPGraph, QCPPlotTitle, QCPLegend, QCPAbstractLegendItem, QCPAbstractItem, QCPAbstractPlottable, QCPAxis, QCPLayoutInset, and QCPLayoutElement.

Definition at line 1068 of file qcustomplot.cpp.

void QCPLayerable::setAntialiased ( bool  enabled)

Sets whether this object will be drawn antialiased or not.

Note that antialiasing settings may be overridden by QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.

Definition at line 1011 of file qcustomplot.cpp.

bool QCPLayerable::setLayer ( QCPLayer layer)

Sets the layer of this layerable object. The object will be placed on top of the other objects already on layer.

Returns true on success, i.e. if layer is a valid layer.

Definition at line 978 of file qcustomplot.cpp.

bool QCPLayerable::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

Returns true on success, i.e. if layerName is a valid layer name.

Definition at line 988 of file qcustomplot.cpp.

void QCPLayerable::setParentLayerable ( QCPLayerable parentLayerable)

Definition at line 1119 of file qcustomplot.cpp.

void QCPLayerable::setVisible ( bool  on)

Sets the visibility of this layerable object. If an object is not visible, it will not be drawn on the QCustomPlot surface, and user interaction with it (e.g. click and selection) is not possible.

Definition at line 967 of file qcustomplot.cpp.

bool QCPLayerable::visible ( ) const

Definition at line 428 of file qcustomplot.h.

Friends And Related Function Documentation

friend class QCPAxisRect

Definition at line 477 of file qcustomplot.h.

friend class QCustomPlot

Definition at line 476 of file qcustomplot.h.

Member Data Documentation

bool QCPLayerable::mAntialiased

Definition at line 455 of file qcustomplot.h.

QCPLayer* QCPLayerable::mLayer

Definition at line 454 of file qcustomplot.h.

QPointer<QCPLayerable> QCPLayerable::mParentLayerable

Definition at line 453 of file qcustomplot.h.

QCustomPlot* QCPLayerable::mParentPlot

Definition at line 452 of file qcustomplot.h.

bool QCPLayerable::mVisible

Definition at line 451 of file qcustomplot.h.

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