iCub-main
Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
QCPItemPixmap Class Reference

An arbitrary pixmap. More...

#include <qcustomplot.h>

+ Inheritance diagram for QCPItemPixmap:

Public Member Functions

 QCPItemPixmap (QCustomPlot *parentPlot)
 Creates a rectangle item and sets default values. More...
 
virtual ~QCPItemPixmap ()
 
QPixmap pixmap () const
 
bool scaled () const
 
Qt::AspectRatioMode aspectRatioMode () const
 
QPen pen () const
 
QPen selectedPen () const
 
void setPixmap (const QPixmap &pixmap)
 Sets the pixmap that will be displayed. More...
 
void setScaled (bool scaled, Qt::AspectRatioMode aspectRatioMode=Qt::KeepAspectRatio)
 Sets whether the pixmap will be scaled to fit the rectangle defined by the topLeft and bottomRight positions. More...
 
void setPen (const QPen &pen)
 Sets the pen that will be used to draw a border around the pixmap. More...
 
void setSelectedPen (const QPen &pen)
 Sets the pen that will be used to draw a border around the pixmap when selected. More...
 
virtual double 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. More...
 
- Public Member Functions inherited from QCPAbstractItem
 QCPAbstractItem (QCustomPlot *parentPlot)
 Base class constructor which initializes base class members. More...
 
virtual ~QCPAbstractItem ()
 
bool clipToAxisRect () const
 
QCPAxisRectclipAxisRect () const
 
bool selectable () const
 
bool selected () const
 
void setClipToAxisRect (bool clip)
 Sets whether the item shall be clipped to an axis rect or whether it shall be visible on the entire QCustomPlot. More...
 
void setClipAxisRect (QCPAxisRect *rect)
 Sets the clip axis rect. More...
 
Q_SLOT void setSelectable (bool selectable)
 Sets whether the user can (de-)select this item by clicking on the QCustomPlot surface. More...
 
Q_SLOT 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 QCPLayerable
 QCPLayerable (QCustomPlot *plot, QString targetLayer="", QCPLayerable *parentLayerable=0)
 Creates a new QCPLayerable instance. More...
 
 ~QCPLayerable ()
 
bool visible () const
 
QCustomPlotparentPlot () const
 
QCPLayerableparentLayerable () const
 Returns the parent layerable of this layerable. More...
 
QCPLayerlayer () const
 
bool antialiased () const
 
void setVisible (bool on)
 Sets the visibility of this layerable object. More...
 
Q_SLOT 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...
 
bool 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. More...
 

Public Attributes

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

Protected Types

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

Protected Member Functions

virtual void draw (QCPPainter *painter)
 
virtual QPointF anchorPixelPoint (int anchorId) const
 
void updateScaledPixmap (QRect finalRect=QRect(), bool flipHorz=false, bool flipVert=false)
 
QRect getFinalRect (bool *flippedHorz=0, bool *flippedVert=0) const
 
QPen mainPen () const
 
- Protected Member Functions inherited from QCPAbstractItem
virtual QCP::Interaction selectionCategory () const
 
virtual QRect clipRect () const
 
virtual void applyDefaultAntialiasingHint (QCPPainter *painter) const
 
virtual void selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged)
 
virtual void deselectEvent (bool *selectionStateChanged)
 
double distSqrToLine (const QPointF &start, const QPointF &end, const QPointF &point) const
 
double rectSelectTest (const QRectF &rect, const QPointF &pos, bool filledRect) const
 
QCPItemPositioncreatePosition (const QString &name)
 
QCPItemAnchorcreateAnchor (const QString &name, int anchorId)
 
- Protected Member Functions inherited from QCPLayerable
virtual void parentPlotInitialized (QCustomPlot *parentPlot)
 
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

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

Additional Inherited Members

- Signals inherited from 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. More...
 
void selectableChanged (bool selectable)
 
- Signals inherited from QCPLayerable
void layerChanged (QCPLayer *newLayer)
 This signal is emitted when the layer of this layerable changes, i.e. More...
 

Detailed Description

An arbitrary pixmap.

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.

Definition at line 3335 of file qcustomplot.h.

Member Enumeration Documentation

◆ AnchorIndex

Enumerator
aiTop 
aiTopRight 
aiRight 
aiBottom 
aiBottomLeft 
aiLeft 

Definition at line 3375 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPItemPixmap()

QCPItemPixmap::QCPItemPixmap ( QCustomPlot parentPlot)

Creates a rectangle item and sets default values.

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

Definition at line 20573 of file qcustomplot.cpp.

◆ ~QCPItemPixmap()

QCPItemPixmap::~QCPItemPixmap ( )
virtual

Definition at line 20592 of file qcustomplot.cpp.

Member Function Documentation

◆ anchorPixelPoint()

QPointF QCPItemPixmap::anchorPixelPoint ( int  anchorId) const
protectedvirtual

Reimplemented from QCPAbstractItem.

Definition at line 20670 of file qcustomplot.cpp.

◆ aspectRatioMode()

Qt::AspectRatioMode QCPItemPixmap::aspectRatioMode ( ) const
inline

Definition at line 3352 of file qcustomplot.h.

◆ draw()

void QCPItemPixmap::draw ( QCPPainter painter)
protectedvirtual

Implements QCPAbstractItem.

Definition at line 20648 of file qcustomplot.cpp.

◆ getFinalRect()

QRect QCPItemPixmap::getFinalRect ( bool *  flippedHorz = 0,
bool *  flippedVert = 0 
) const
protected

Definition at line 20742 of file qcustomplot.cpp.

◆ mainPen()

QPen QCPItemPixmap::mainPen ( ) const
protected

Definition at line 20786 of file qcustomplot.cpp.

◆ pen()

QPen QCPItemPixmap::pen ( ) const
inline

Definition at line 3353 of file qcustomplot.h.

◆ pixmap()

QPixmap QCPItemPixmap::pixmap ( ) const
inline

Definition at line 3350 of file qcustomplot.h.

◆ scaled()

bool QCPItemPixmap::scaled ( ) const
inline

Definition at line 3351 of file qcustomplot.h.

◆ selectedPen()

QPen QCPItemPixmap::selectedPen ( ) const
inline

Definition at line 3354 of file qcustomplot.h.

◆ selectTest()

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

Implements QCPAbstractItem.

Definition at line 20638 of file qcustomplot.cpp.

◆ setPen()

void QCPItemPixmap::setPen ( const QPen &  pen)

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

See also
setSelectedPen, setBrush

Definition at line 20622 of file qcustomplot.cpp.

◆ setPixmap()

void QCPItemPixmap::setPixmap ( const QPixmap &  pixmap)

Sets the pixmap that will be displayed.

Definition at line 20599 of file qcustomplot.cpp.

◆ setScaled()

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

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

Definition at line 20610 of file qcustomplot.cpp.

◆ setSelectedPen()

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

Definition at line 20632 of file qcustomplot.cpp.

◆ updateScaledPixmap()

void QCPItemPixmap::updateScaledPixmap ( QRect  finalRect = QRect(),
bool  flipHorz = false,
bool  flipVert = false 
)
protected

Definition at line 20709 of file qcustomplot.cpp.

Member Data Documentation

◆ bottom

QCPItemAnchor* const QCPItemPixmap::bottom

Definition at line 3370 of file qcustomplot.h.

◆ bottomLeft

QCPItemAnchor* const QCPItemPixmap::bottomLeft

Definition at line 3371 of file qcustomplot.h.

◆ bottomRight

QCPItemPosition* const QCPItemPixmap::bottomRight

Definition at line 3366 of file qcustomplot.h.

◆ left

QCPItemAnchor* const QCPItemPixmap::left

Definition at line 3372 of file qcustomplot.h.

◆ mAspectRatioMode

Qt::AspectRatioMode QCPItemPixmap::mAspectRatioMode
protected

Definition at line 3381 of file qcustomplot.h.

◆ mPen

QPen QCPItemPixmap::mPen
protected

Definition at line 3382 of file qcustomplot.h.

◆ mPixmap

QPixmap QCPItemPixmap::mPixmap
protected

Definition at line 3378 of file qcustomplot.h.

◆ mScaled

bool QCPItemPixmap::mScaled
protected

Definition at line 3380 of file qcustomplot.h.

◆ mScaledPixmap

QPixmap QCPItemPixmap::mScaledPixmap
protected

Definition at line 3379 of file qcustomplot.h.

◆ mSelectedPen

QPen QCPItemPixmap::mSelectedPen
protected

Definition at line 3382 of file qcustomplot.h.

◆ right

QCPItemAnchor* const QCPItemPixmap::right

Definition at line 3369 of file qcustomplot.h.

◆ top

QCPItemAnchor* const QCPItemPixmap::top

Definition at line 3367 of file qcustomplot.h.

◆ topLeft

QCPItemPosition* const QCPItemPixmap::topLeft

Definition at line 3365 of file qcustomplot.h.

◆ topRight

QCPItemAnchor* const QCPItemPixmap::topRight

Definition at line 3368 of file qcustomplot.h.


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