Cute Chess  0.1
Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
QCPItemPixmap Class Reference

An arbitrary pixmap. More...

Inheritance diagram for QCPItemPixmap:
QCPAbstractItem QCPLayerable QObject

Public Member Functions

Qt::AspectRatioMode aspectRatioMode () const
 
QPen pen () const
 
QPixmap pixmap () const
 
 QCPItemPixmap (QCustomPlot *parentPlot)
 
bool scaled () const
 
QPen selectedPen () const
 
virtual double selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const Q_DECL_OVERRIDE
 
void setPen (const QPen &pen)
 
void setPixmap (const QPixmap &pixmap)
 
void setScaled (bool scaled, Qt::AspectRatioMode aspectRatioMode=Qt::KeepAspectRatio, Qt::TransformationMode transformationMode=Qt::SmoothTransformation)
 
void setSelectedPen (const QPen &pen)
 
Qt::TransformationMode transformationMode () const
 
- Public Member Functions inherited from QCPAbstractItem
QCPItemAnchoranchor (const QString &name) const
 
QList< QCPItemAnchor * > anchors () const
 
QCPAxisRectclipAxisRect () const
 
bool clipToAxisRect () const
 
bool hasAnchor (const QString &name) const
 
QCPItemPositionposition (const QString &name) const
 
QList< QCPItemPosition * > positions () const
 
 QCPAbstractItem (QCustomPlot *parentPlot)
 
bool selectable () const
 
bool selected () const
 
void setClipAxisRect (QCPAxisRect *rect)
 
void setClipToAxisRect (bool clip)
 
Q_SLOT void setSelectable (bool selectable)
 
Q_SLOT void setSelected (bool selected)
 
- Public Member Functions inherited from QCPLayerable
bool antialiased () const
 
QCPLayerlayer () const
 
QCPLayerableparentLayerable () const
 
QCustomPlotparentPlot () const
 
 QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=0)
 
bool realVisibility () const
 
void setAntialiased (bool enabled)
 
Q_SLOT bool setLayer (QCPLayer *layer)
 
bool setLayer (const QString &layerName)
 
void setVisible (bool on)
 
bool visible () const
 

Public Attributes

QCPItemAnchor *const bottom
 
QCPItemAnchor *const bottomLeft
 
QCPItemPosition *const bottomRight
 
QCPItemAnchor *const left
 
QCPItemAnchor *const right
 
QCPItemAnchor *const top
 
QCPItemPosition *const topLeft
 
QCPItemAnchor *const topRight
 

Protected Types

enum  AnchorIndex {
  aiTop, aiTopRight, aiRight, aiBottom,
  aiBottomLeft, aiLeft
}
 

Protected Member Functions

virtual QPointF anchorPixelPosition (int anchorId) const Q_DECL_OVERRIDE
 
virtual void draw (QCPPainter *painter) Q_DECL_OVERRIDE
 
QRect getFinalRect (bool *flippedHorz=0, bool *flippedVert=0) const
 
QPen mainPen () const
 
void updateScaledPixmap (QRect finalRect=QRect(), bool flipHorz=false, bool flipVert=false)
 
- Protected Member Functions inherited from QCPAbstractItem
virtual void applyDefaultAntialiasingHint (QCPPainter *painter) const Q_DECL_OVERRIDE
 
virtual QRect clipRect () const Q_DECL_OVERRIDE
 
QCPItemAnchorcreateAnchor (const QString &name, int anchorId)
 
QCPItemPositioncreatePosition (const QString &name)
 
virtual void deselectEvent (bool *selectionStateChanged) Q_DECL_OVERRIDE
 
double rectDistance (const QRectF &rect, const QPointF &pos, bool filledRect) const
 
virtual void selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged) Q_DECL_OVERRIDE
 
virtual QCP::Interaction selectionCategory () const Q_DECL_OVERRIDE
 
- Protected Member Functions inherited from QCPLayerable
void applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const
 
void initializeParentPlot (QCustomPlot *parentPlot)
 
virtual void mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details)
 
virtual void mouseMoveEvent (QMouseEvent *event, const QPointF &startPos)
 
virtual void mousePressEvent (QMouseEvent *event, const QVariant &details)
 
virtual void mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos)
 
bool moveToLayer (QCPLayer *layer, bool prepend)
 
virtual void parentPlotInitialized (QCustomPlot *parentPlot)
 
void setParentLayerable (QCPLayerable *parentLayerable)
 
virtual void wheelEvent (QWheelEvent *event)
 

Protected Attributes

Qt::AspectRatioMode mAspectRatioMode
 
QPen mPen
 
QPixmap mPixmap
 
bool mScaled
 
QPixmap mScaledPixmap
 
bool mScaledPixmapInvalidated
 
QPen mSelectedPen
 
Qt::TransformationMode mTransformationMode
 
- Protected Attributes inherited from QCPAbstractItem
QList< QCPItemAnchor * > mAnchors
 
QPointer< QCPAxisRectmClipAxisRect
 
bool mClipToAxisRect
 
QList< QCPItemPosition * > mPositions
 
bool mSelectable
 
bool mSelected
 
- Protected Attributes inherited from QCPLayerable
bool mAntialiased
 
QCPLayermLayer
 
QPointer< QCPLayerablemParentLayerable
 
QCustomPlotmParentPlot
 
bool mVisible
 

Additional Inherited Members

- Signals inherited from QCPAbstractItem
void selectableChanged (bool selectable)
 
void selectionChanged (bool selected)
 
- Signals inherited from QCPLayerable
void layerChanged (QCPLayer *newLayer)
 

Detailed Description

An arbitrary pixmap.

QCPItemPixmap.png
Pixmap example. Blue dotted circles are anchors, solid blue discs are positions.

It has two positions, topLeft and bottomRight, which define the rectangle the pixmap will be drawn in. Depending on the scale setting (setScaled), the pixmap will be either scaled to fit the rectangle or be drawn aligned to the topLeft position.

If scaling is enabled and topLeft is further to the bottom/right than bottomRight (as shown on the right side of the example image), the pixmap will be flipped in the respective orientations.

Constructor & Destructor Documentation

QCPItemPixmap::QCPItemPixmap ( QCustomPlot parentPlot)
explicit

Creates a rectangle item and sets default values.

The created item is automatically registered with parentPlot. This QCustomPlot instance takes ownership of the item, so do not delete it manually but use QCustomPlot::removeItem() instead.

Member Function Documentation

double QCPItemPixmap::selectTest ( const QPointF pos,
bool  onlySelectable,
QVariant details = 0 
) const
virtual

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 object is represented not by single lines but by an area like a QCPItemText or the bars of a QCPBars plottable, a click inside the area should also be considered a hit. In these cases this function thus returns a constant value greater zero but still below the parent plot's selection tolerance. (typically the selectionTolerance multiplied by 0.99).

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.

In the case of 1D Plottables (QCPAbstractPlottable1D, like QCPGraph or QCPBars) details will be set to a QCPDataSelection, describing the closest data point to pos.

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

See also
selectEvent, deselectEvent, mousePressEvent, wheelEvent, QCustomPlot::setInteractions, QCPAbstractPlottable1D::selectTestRect

Implements QCPAbstractItem.

void QCPItemPixmap::setPen ( const QPen pen)

Sets the pen that will be used to draw a border around the pixmap.

See also
setSelectedPen, setBrush
void QCPItemPixmap::setPixmap ( const QPixmap pixmap)

Sets the pixmap that will be displayed.

void QCPItemPixmap::setScaled ( bool  scaled,
Qt::AspectRatioMode  aspectRatioMode = Qt::KeepAspectRatio,
Qt::TransformationMode  transformationMode = Qt::SmoothTransformation 
)

Sets whether the pixmap will be scaled to fit the rectangle defined by the topLeft and bottomRight positions.

void QCPItemPixmap::setSelectedPen ( const QPen pen)

Sets the pen that will be used to draw a border around the pixmap when selected

See also
setPen, setSelected

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