The QGraphicsPixmapItem class provides a pixmap item which can be added to a QGraphicsScene. More...

Inheritance diagram for QGraphicsPixmapItem:

Public Types
enum	ShapeMode

Public Types inherited from QGraphicsItem
enum	CacheMode

enum	GraphicsItemChange

enum	GraphicsItemFlag

enum	PanelModality

Public Methods
	QGraphicsPixmapItem (const QPixmap &pixmap, QGraphicsItem *parent=nullptr)

	QGraphicsPixmapItem (QGraphicsItem *parent=nullptr)

	~QGraphicsPixmapItem ()

QRectF	boundingRect () const override

bool	contains (const QPointF &point) const override

bool	isObscuredBy (const QGraphicsItem *graphicsItem) const override

QPointF	offset () const

QPainterPath	opaqueArea () const override

void	paint (QPainter painter, const QStyleOptionGraphicsItem option, QWidget *widget) override

QPixmap	pixmap () const

void	setOffset (const QPointF &offset)

void	setOffset (qreal x, qreal y)

void	setPixmap (const QPixmap &pixmap)

void	setShapeMode (ShapeMode mode)

void	setTransformationMode (Qt::TransformationMode mode)

QPainterPath	shape () const override

ShapeMode	shapeMode () const

Qt::TransformationMode	transformationMode () const

int	type () const override

Public Methods inherited from QGraphicsItem
	QGraphicsItem (QGraphicsItem *parent=nullptr)

virtual	~QGraphicsItem ()

bool	acceptDrops () const

Qt::MouseButtons	acceptedMouseButtons () const

bool	acceptHoverEvents () const

bool	acceptTouchEvents () const

virtual void	advance (int phase)

QRegion	boundingRegion (const QTransform &itemToDeviceTransform) const

qreal	boundingRegionGranularity () const

CacheMode	cacheMode () const

QList< QGraphicsItem * >	childItems () const

QRectF	childrenBoundingRect () const

void	clearFocus ()

QPainterPath	clipPath () const

virtual bool	collidesWithItem (const QGraphicsItem *graphicsItem, Qt::ItemSelectionMode mode=Qt::IntersectsItemShape) const

virtual bool	collidesWithPath (const QPainterPath &path, Qt::ItemSelectionMode mode=Qt::IntersectsItemShape) const

QList< QGraphicsItem * >	collidingItems (Qt::ItemSelectionMode mode=Qt::IntersectsItemShape) const

QGraphicsItem *	commonAncestorItem (const QGraphicsItem *graphicsItem) const

QCursor	cursor () const

QVariant	data (int key) const

QTransform	deviceTransform (const QTransform &viewportTransform) const

qreal	effectiveOpacity () const

void	ensureVisible (const QRectF &rectF=QRectF (), int xmargin=50, int ymargin=50)

void	ensureVisible (qreal x, qreal y, qreal width, qreal height, int xmargin=50, int ymargin=50)

bool	filtersChildEvents () const

GraphicsItemFlags	flags () const

QGraphicsItem *	focusItem () const

QGraphicsItem *	focusProxy () const

void	grabKeyboard ()

void	grabMouse ()

QGraphicsEffect *	graphicsEffect () const

QGraphicsItemGroup *	group () const

bool	handlesChildEvents () const

bool	hasCursor () const

bool	hasFocus () const

void	hide ()

Qt::InputMethodHints	inputMethodHints () const

void	installSceneEventFilter (QGraphicsItem *filterItem)

bool	isActive () const

bool	isAncestorOf (const QGraphicsItem *graphicsItem) const

bool	isBlockedByModalPanel (QGraphicsItem **blockingPanel=nullptr) const

bool	isClipped () const

bool	isEnabled () const

bool	isObscured (const QRectF &rectF=QRectF ()) const

bool	isObscured (qreal x, qreal y, qreal width, qreal height) const

bool	isPanel () const

bool	isSelected () const

bool	isUnderMouse () const

bool	isVisible () const

bool	isVisibleTo (const QGraphicsItem *graphicsItem) const

bool	isWidget () const

bool	isWindow () const

QTransform	itemTransform (const QGraphicsItem graphicsItem, bool ok=nullptr) const

QPainterPath	mapFromItem (const QGraphicsItem *graphicsItem, const QPainterPath &path) const

QPointF	mapFromItem (const QGraphicsItem *graphicsItem, const QPointF &point) const

QPolygonF	mapFromItem (const QGraphicsItem *graphicsItem, const QPolygonF &polygon) const

QPolygonF	mapFromItem (const QGraphicsItem *graphicsItem, const QRectF &rectF) const

QPointF	mapFromItem (const QGraphicsItem *graphicsItem, qreal x, qreal y) const

QPolygonF	mapFromItem (const QGraphicsItem *graphicsItem, qreal x, qreal y, qreal width, qreal height) const

QPainterPath	mapFromParent (const QPainterPath &path) const

QPointF	mapFromParent (const QPointF &point) const

QPolygonF	mapFromParent (const QPolygonF &polygon) const

QPolygonF	mapFromParent (const QRectF &rectF) const

QPointF	mapFromParent (qreal x, qreal y) const

QPolygonF	mapFromParent (qreal x, qreal y, qreal width, qreal height) const

QPainterPath	mapFromScene (const QPainterPath &path) const

QPointF	mapFromScene (const QPointF &point) const

QPolygonF	mapFromScene (const QPolygonF &polygon) const

QPolygonF	mapFromScene (const QRectF &rectF) const

QPointF	mapFromScene (qreal x, qreal y) const

QPolygonF	mapFromScene (qreal x, qreal y, qreal width, qreal height) const

QRectF	mapRectFromItem (const QGraphicsItem *graphicsItem, const QRectF &rectF) const

QRectF	mapRectFromItem (const QGraphicsItem *graphicsItem, qreal x, qreal y, qreal width, qreal height) const

QRectF	mapRectFromParent (const QRectF &rectF) const

QRectF	mapRectFromParent (qreal x, qreal y, qreal width, qreal height) const

QRectF	mapRectFromScene (const QRectF &rectF) const

QRectF	mapRectFromScene (qreal x, qreal y, qreal width, qreal height) const

QRectF	mapRectToItem (const QGraphicsItem *graphicsItem, const QRectF &rectF) const

QRectF	mapRectToItem (const QGraphicsItem *graphicsItem, qreal x, qreal y, qreal width, qreal height) const

QRectF	mapRectToParent (const QRectF &rectF) const

QRectF	mapRectToParent (qreal x, qreal y, qreal width, qreal height) const

QRectF	mapRectToScene (const QRectF &rectF) const

QRectF	mapRectToScene (qreal x, qreal y, qreal width, qreal height) const

QPainterPath	mapToItem (const QGraphicsItem *graphicsItem, const QPainterPath &path) const

QPointF	mapToItem (const QGraphicsItem *graphicsItem, const QPointF &point) const

QPolygonF	mapToItem (const QGraphicsItem *graphicsItem, const QPolygonF &polygon) const

QPolygonF	mapToItem (const QGraphicsItem *graphicsItem, const QRectF &rectF) const

QPointF	mapToItem (const QGraphicsItem *graphicsItem, qreal x, qreal y) const

QPolygonF	mapToItem (const QGraphicsItem *graphicsItem, qreal x, qreal y, qreal width, qreal height) const

QPainterPath	mapToParent (const QPainterPath &path) const

QPointF	mapToParent (const QPointF &point) const

QPolygonF	mapToParent (const QPolygonF &polygon) const

QPolygonF	mapToParent (const QRectF &rectF) const

QPointF	mapToParent (qreal x, qreal y) const

QPolygonF	mapToParent (qreal x, qreal y, qreal width, qreal height) const

QPainterPath	mapToScene (const QPainterPath &path) const

QPointF	mapToScene (const QPointF &point) const

QPolygonF	mapToScene (const QPolygonF &polygon) const

QPolygonF	mapToScene (const QRectF &rectF) const

QPointF	mapToScene (qreal x, qreal y) const

QPolygonF	mapToScene (qreal x, qreal y, qreal width, qreal height) const

QMatrix	matrix () const

void	moveBy (qreal dx, qreal dy)

qreal	opacity () const

QGraphicsItem *	panel () const

PanelModality	panelModality () const

QGraphicsItem *	parentItem () const

QGraphicsObject *	parentObject () const

QGraphicsWidget *	parentWidget () const

QPointF	pos () const

void	removeSceneEventFilter (QGraphicsItem *filterItem)

void	resetMatrix ()

void	resetTransform ()

qreal	rotation () const

qreal	scale () const

QGraphicsScene *	scene () const

QRectF	sceneBoundingRect () const

QMatrix	sceneMatrix () const

QPointF	scenePos () const

QTransform	sceneTransform () const

void	scroll (qreal dx, qreal dy, const QRectF &rectF=QRectF ())

void	setAcceptDrops (bool on)

void	setAcceptedMouseButtons (Qt::MouseButtons buttons)

void	setAcceptHoverEvents (bool enabled)

void	setAcceptTouchEvents (bool enabled)

void	setActive (bool active)

void	setBoundingRegionGranularity (qreal granularity)

void	setCacheMode (CacheMode mode, const QSize &cacheSize=QSize ())

void	setCursor (const QCursor &cursor)

void	setData (int key, const QVariant &value)

void	setEnabled (bool enabled)

void	setFiltersChildEvents (bool enabled)

void	setFlag (GraphicsItemFlag flag, bool enabled=true)

void	setFlags (GraphicsItemFlags flags)

void	setFocus (Qt::FocusReason focusReason=Qt::OtherFocusReason)

void	setFocusProxy (QGraphicsItem *graphicsItem)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setGroup (QGraphicsItemGroup *group)

void	setHandlesChildEvents (bool enabled)

void	setInputMethodHints (Qt::InputMethodHints hints)

void	setMatrix (const QMatrix &matrix, bool combine=false)

void	setOpacity (qreal opacity)

void	setPanelModality (PanelModality panelModality)

void	setParentItem (QGraphicsItem *parent)

void	setPos (const QPointF &pos)

void	setPos (qreal x, qreal y)

void	setRotation (qreal angle)

void	setScale (qreal factor)

void	setSelected (bool selected)

void	setToolTip (const QString &toolTip)

void	setTransform (const QTransform &matrix, bool combine=false)

void	setTransformations (const QList< QGraphicsTransform * > &transformations)

void	setTransformOriginPoint (const QPointF &origin)

void	setTransformOriginPoint (qreal x, qreal y)

void	setVisible (bool visible)

void	setX (qreal x)

void	setY (qreal y)

void	setZValue (qreal z)

void	show ()

void	stackBefore (const QGraphicsItem *graphicsItem)

QGraphicsObject *	toGraphicsObject ()

const QGraphicsObject *	toGraphicsObject () const

QString	toolTip () const

QGraphicsItem *	topLevelItem () const

QGraphicsWidget *	topLevelWidget () const

QTransform	transform () const

QList< QGraphicsTransform * >	transformations () const

QPointF	transformOriginPoint () const

void	ungrabKeyboard ()

void	ungrabMouse ()

void	unsetCursor ()

void	update (const QRectF &rectF=QRectF ())

void	update (qreal x, qreal y, qreal width, qreal height)

QGraphicsWidget *	window () const

qreal	x () const

qreal	y () const

qreal	zValue () const

Additional Inherited Members
Public Typedefs inherited from QGraphicsItem
using	GraphicsItemFlags = QFlags< GraphicsItemFlag >

Static Public Members inherited from QGraphicsItem
static constexpr const int	UserType = 65536

Protected Methods inherited from QGraphicsItem
virtual void	contextMenuEvent (QGraphicsSceneContextMenuEvent *event)

virtual void	dragEnterEvent (QGraphicsSceneDragDropEvent *event)

virtual void	dragLeaveEvent (QGraphicsSceneDragDropEvent *event)

virtual void	dragMoveEvent (QGraphicsSceneDragDropEvent *event)

virtual void	dropEvent (QGraphicsSceneDragDropEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

virtual void	focusOutEvent (QFocusEvent *event)

virtual void	hoverEnterEvent (QGraphicsSceneHoverEvent *event)

virtual void	hoverLeaveEvent (QGraphicsSceneHoverEvent *event)

virtual void	hoverMoveEvent (QGraphicsSceneHoverEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

virtual QVariant	itemChange (GraphicsItemChange change, const QVariant &value)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	mouseDoubleClickEvent (QGraphicsSceneMouseEvent *event)

virtual void	mouseMoveEvent (QGraphicsSceneMouseEvent *event)

virtual void	mousePressEvent (QGraphicsSceneMouseEvent *event)

virtual void	mouseReleaseEvent (QGraphicsSceneMouseEvent *event)

void	prepareGeometryChange ()

virtual bool	sceneEvent (QEvent *event)

virtual bool	sceneEventFilter (QGraphicsItem watched, QEvent event)

void	updateMicroFocus ()

virtual void	wheelEvent (QGraphicsSceneWheelEvent *event)

Related Functions inherited from QGraphicsItem
T	qgraphicsitem_cast (QGraphicsItem *item)

Detailed Description

The QGraphicsPixmapItem class provides a pixmap item which can be added to a QGraphicsScene. To set the item's pixmap, pass a QPixmap to QGraphicsPixmapItem's constructor, or call the setPixmap() function. The pixmap() function returns the current pixmap. QGraphicsPixmapItem uses pixmap's optional alpha mask to provide a reasonable implementation of boundingRect(), shape(), and contains().

The pixmap is drawn at the item's (0, 0) coordinate, as returned by offset(). You can change the drawing offset by calling setOffset().

You can set the pixmap's transformation mode by calling setTransformationMode(). By default, Qt::FastTransformation is used, which provides fast, non-smooth scaling. Qt::SmoothTransformation enables QPainter::SmoothPixmapTransform on the painter, and the quality depends on the platform and viewport. The result is usually not as good as calling QPixmap::scale() directly. Call transformationMode() to get the current transformation mode for the item.

See also: QGraphicsPathItem, QGraphicsRectItem, QGraphicsEllipseItem, QGraphicsTextItem, QGraphicsPolygonItem, QGraphicsLineItem, Graphics View System

Member Enumeration Documentation

enum QGraphicsPixmapItem::ShapeMode

This enum describes how QGraphicsPixmapItem calculates its shape and opaque area. The default value is MaskShape.

Constant	Value	Description
`QGraphicsPixmapItem::MaskShape`	`0`	The shape is determined by calling QPixmap::mask(). This shape includes only the opaque pixels of the pixmap. Because the shape is more complex, however, it can be slower than the other modes, and uses more memory.
`QGraphicsPixmapItem::BoundingRectShape`	`1`	The shape is determined by tracing the outline of the pixmap. This is the fastest shape mode, but it does not take into account any transparent areas on the pixmap.
`QGraphicsPixmapItem::HeuristicMaskShape`	`2`	The shape is determine by calling QPixmap::createHeuristicMask(). The performance and memory consumption is similar to MaskShape.

Constructor & Destructor Documentation

QGraphicsPixmapItem::QGraphicsPixmapItem ( QGraphicsItem * parent = nullptr )

explicit

Constructs a QGraphicsPixmapItem. The parent object is passed to the QGraphicsItem constructor.

See also: QGraphicsScene::addItem()

QGraphicsPixmapItem::QGraphicsPixmapItem	(	const QPixmap &	pixmap,
		QGraphicsItem *	parent = `nullptr`
	)

explicit

Constructs a new QGraphicsPixmapItem using pixmap as the default pixmap. The parent object is passed to the QGraphicsItem constructor.

See also: QGraphicsScene::addItem()

QGraphicsPixmapItem::~QGraphicsPixmapItem ( )

Destroys the QGraphicsPixmapItem.

Method Documentation

QRectF QGraphicsPixmapItem::boundingRect ( ) const

overridevirtual

Implements QGraphicsItem::boundingRect()

bool QGraphicsPixmapItem::contains ( const QPointF & point ) const

overridevirtual

Reimplemented from QGraphicsItem::contains()

bool QGraphicsPixmapItem::isObscuredBy ( const QGraphicsItem * graphicsItem ) const

overridevirtual

Reimplemented from QGraphicsItem::isObscuredBy()

QPointF QGraphicsPixmapItem::offset ( ) const

Returns the pixmap item's offset, which defines the point of the top-left corner of the pixmap, in local coordinates.

See also: setOffset()

QPainterPath QGraphicsPixmapItem::opaqueArea ( ) const

overridevirtual

Reimplemented from QGraphicsItem::opaqueArea()

void QGraphicsPixmapItem::paint	(	QPainter *	painter,
		const QStyleOptionGraphicsItem *	option,
		QWidget *	widget
	)

overridevirtual

Implements QGraphicsItem::paint()

QPixmap QGraphicsPixmapItem::pixmap ( ) const

Returns the item's pixmap, or an invalid QPixmap if no pixmap has been set.

See also: setPixmap()

void QGraphicsPixmapItem::setOffset ( const QPointF & offset )

Sets the pixmap item's offset to offset. QGraphicsPixmapItem will draw its pixmap using offset for its top-left corner.

See also: offset()

void QGraphicsPixmapItem::setOffset	(	qreal	x,
		qreal	y
	)

inline

Equivalent to calling setOffset(QPointF(x, y)).

void QGraphicsPixmapItem::setPixmap ( const QPixmap & pixmap )

Sets the item's pixmap to pixmap.

See also: pixmap()

void QGraphicsPixmapItem::setShapeMode ( ShapeMode mode )

Sets the item's shape mode to mode. The shape mode describes how QGraphicsPixmapItem calculates its shape. The default mode is MaskShape.

See also: shapeMode(), ShapeMode

void QGraphicsPixmapItem::setTransformationMode ( Qt::TransformationMode mode )

Sets the pixmap item's transformation mode to mode, and toggles an update of the item. The default mode is Qt::FastTransformation, which provides quick transformation with no smoothing.

Qt::SmoothTransformation enables QPainter::SmoothPixmapTransform on the painter, and the quality depends on the platform and viewport. The result is usually not as good as calling QPixmap::scale() directly.