QgsMapCanvasItem Class Reference

An abstract class for items that can be placed on the map canvas. More...

#include <qgsmapcanvasitem.h>

Inheritance diagram for QgsMapCanvasItem:

Collaboration diagram for QgsMapCanvasItem:

Public Member Functions
virtual void	updatePosition ()
	called on changed extent or resize event to update position of the item
virtual QRectF	boundingRect () const
	default implementation for canvas items
void	setPanningOffset (const QPoint &point)
	sets current offset, to be called from QgsMapCanvas
QgsRectangle	rect () const
	returns canvas item rectangle
void	setRect (const QgsRectangle &r)
	sets canvas item rectangle
QgsPoint	toMapCoordinates (const QPoint &point)
	transformation from screen coordinates to map coordinates
QPointF	toCanvasCoordinates (const QgsPoint &point)
	transformation from map coordinates to screen coordinates

Protected Member Functions
	QgsMapCanvasItem (QgsMapCanvas *mapCanvas)
	protected constructor: cannot be constructed directly
virtual	~QgsMapCanvasItem ()
virtual void	paint (QPainter *painter)=0
	function to be implemented by derived classes
virtual void	paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget=0)
	paint function called by map canvas
void	updateCanvas ()
	schedules map canvas for repaint
bool	setRenderContextVariables (QPainter *p, QgsRenderContext &context) const
	Sets render context parameters.

Protected Attributes
QgsMapCanvas *	mMapCanvas
	pointer to map canvas
QgsRectangle	mRect
	canvas item rectangle (in map coordinates)
QPoint	mPanningOffset
	offset from normal position due current panning operation, used when converting map coordinates to move map canvas items
QSizeF	mItemSize
	cached size of the item (to return in boundingRect())

Detailed Description

An abstract class for items that can be placed on the map canvas.

Definition at line 30 of file qgsmapcanvasitem.h.

Constructor & Destructor Documentation

QgsMapCanvasItem::QgsMapCanvasItem ( QgsMapCanvas *  mapCanvas )

protected

protected constructor: cannot be constructed directly

Definition at line 29 of file qgsmapcanvasitem.cpp.

QgsMapCanvasItem::~QgsMapCanvasItem ( )

protectedvirtual

Definition at line 35 of file qgsmapcanvasitem.cpp.

Member Function Documentation

QRectF QgsMapCanvasItem::boundingRect ( ) const

virtual

default implementation for canvas items

Reimplemented in QgsAnnotationItem, and QgsVertexMarker.

Definition at line 96 of file qgsmapcanvasitem.cpp.

References mItemSize.

virtual void QgsMapCanvasItem::paint ( QPainter *  painter )

protectedpure virtual

function to be implemented by derived classes

Implemented in QgsRubberBand, QgsVertexMarker, QgsHighlight, QgsTextAnnotationItem, QgsHtmlAnnotationItem, QgsFormAnnotationItem, and QgsSvgAnnotationItem.

Referenced by paint().

void QgsMapCanvasItem::paint ( QPainter *  painter, const QStyleOptionGraphicsItem *  option, QWidget *  widget = 0  )

protectedvirtual

paint function called by map canvas

Reimplemented in QgsHtmlAnnotationItem, and QgsFormAnnotationItem.

Definition at line 40 of file qgsmapcanvasitem.cpp.

References QgsMapCanvas::antiAliasingEnabled(), mMapCanvas, and paint().

QgsRectangle QgsMapCanvasItem::rect

(

)

const

returns canvas item rectangle

Definition at line 67 of file qgsmapcanvasitem.cpp.

References mRect.

Referenced by setRect(), and QgsRubberBand::updateRect().

void QgsMapCanvasItem::setPanningOffset

(

const QPoint &

point

)

sets current offset, to be called from QgsMapCanvas

Definition at line 154 of file qgsmapcanvasitem.cpp.

References mPanningOffset.

Referenced by QgsMapCanvas::moveCanvasContents().

void QgsMapCanvasItem::setRect

(

const QgsRectangle &

r

)

sets canvas item rectangle

Definition at line 73 of file qgsmapcanvasitem.cpp.

References QgsRectangle::isEmpty(), mItemSize, mRect, rect(), toCanvasCoordinates(), QgsRectangle::xMaximum(), QgsRectangle::xMinimum(), QgsRectangle::yMaximum(), and QgsRectangle::yMinimum().

Referenced by updatePosition(), QgsHighlight::updateRect(), and QgsRubberBand::updateRect().

bool QgsMapCanvasItem::setRenderContextVariables ( QPainter *  p, QgsRenderContext &  context  ) const

protected

Sets render context parameters.

Parameters

p	painter for rendering
context	out: configured context

Returns

true in case of success

Note

added in version 1.5

Definition at line 109 of file qgsmapcanvasitem.cpp.

References QgsMapCanvas::mapRenderer(), QgsMapRenderer::Millimeters, mMapCanvas, QgsMapRenderer::outputDpi(), QgsMapRenderer::outputUnits(), rasterScaleFactor, QgsMapCanvas::scale(), QgsRenderContext::setPainter(), QgsRenderContext::setRasterScaleFactor(), QgsRenderContext::setRendererScale(), and QgsRenderContext::setScaleFactor().

Referenced by QgsAnnotationItem::drawMarkerSymbol().

QPointF QgsMapCanvasItem::toCanvasCoordinates

(

const QgsPoint &

point

)

transformation from map coordinates to screen coordinates

Definition at line 59 of file qgsmapcanvasitem.cpp.

References QgsMapCanvas::getCoordinateTransform(), mMapCanvas, mPanningOffset, QgsMapToPixel::transformInPlace(), QgsPoint::x(), and QgsPoint::y().

Referenced by QgsRubberBand::paint(), QgsHighlight::paintLine(), QgsHighlight::paintPoint(), QgsHighlight::paintPolygon(), QgsVertexMarker::setCenter(), QgsAnnotationItem::setMapPosition(), setRect(), and QgsAnnotationItem::updatePosition().

QgsPoint QgsMapCanvasItem::toMapCoordinates

(

const QPoint &

point

)

transformation from screen coordinates to map coordinates

Definition at line 53 of file qgsmapcanvasitem.cpp.

References QgsMapCanvas::getCoordinateTransform(), mMapCanvas, mPanningOffset, and QgsMapToPixel::toMapCoordinates().

Referenced by QgsAnnotationItem::setMapPositionFixed(), and QgsAnnotationItem::updatePosition().

void QgsMapCanvasItem::updateCanvas ( )

protected

schedules map canvas for repaint

Definition at line 102 of file qgsmapcanvasitem.cpp.

void QgsMapCanvasItem::updatePosition ( )

virtual

called on changed extent or resize event to update position of the item

Reimplemented in QgsVertexMarker, and QgsAnnotationItem.

Definition at line 147 of file qgsmapcanvasitem.cpp.

References mRect, and setRect().

Referenced by QgsMapCanvas::updateCanvasItemPositions().

Member Data Documentation

QSizeF QgsMapCanvasItem::mItemSize

protected

cached size of the item (to return in boundingRect())

Definition at line 93 of file qgsmapcanvasitem.h.

Referenced by boundingRect(), and setRect().

QgsMapCanvas* QgsMapCanvasItem::mMapCanvas

protected

pointer to map canvas

Definition at line 83 of file qgsmapcanvasitem.h.

Referenced by QgsRubberBand::addGeometry(), QgsHtmlAnnotationItem::javascript(), paint(), QgsHighlight::paintPoint(), QgsFormAnnotationItem::QgsFormAnnotationItem(), QgsHtmlAnnotationItem::QgsHtmlAnnotationItem(), QgsHtmlAnnotationItem::readXML(), QgsFormAnnotationItem::readXML(), QgsAnnotationItem::scaledSymbolSize(), QgsFormAnnotationItem::setFeatureForMapPosition(), QgsHtmlAnnotationItem::setFeatureForMapPosition(), setRenderContextVariables(), QgsRubberBand::setToCanvasRectangle(), toCanvasCoordinates(), toMapCoordinates(), QgsHighlight::updateRect(), QgsRubberBand::updateRect(), QgsFormAnnotationItem::updateVisibility(), and QgsHtmlAnnotationItem::updateVisibility().

QPoint QgsMapCanvasItem::mPanningOffset

protected

offset from normal position due current panning operation, used when converting map coordinates to move map canvas items

Definition at line 90 of file qgsmapcanvasitem.h.

Referenced by setPanningOffset(), toCanvasCoordinates(), and toMapCoordinates().

QgsRectangle QgsMapCanvasItem::mRect

protected

canvas item rectangle (in map coordinates)

Definition at line 86 of file qgsmapcanvasitem.h.

Referenced by rect(), setRect(), and updatePosition().

---

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

• /tmp/buildd/qgis-2.0.1/src/gui/qgsmapcanvasitem.h
• /tmp/buildd/qgis-2.0.1/src/gui/qgsmapcanvasitem.cpp