QGIS API Documentation 3.39.0-Master (9ea1ddbe645)
|
A class for highlight features on the map. More...
#include <qgshighlight.h>
Public Member Functions | |
QgsHighlight (QgsMapCanvas *mapCanvas, const QgsFeature &feature, QgsVectorLayer *layer) | |
Constructor for highlighting true feature shape using feature attributes and renderer. | |
QgsHighlight (QgsMapCanvas *mapCanvas, const QgsGeometry &geom, QgsMapLayer *layer) | |
Constructor for QgsHighlight. | |
~QgsHighlight () override | |
void | applyDefaultStyle () |
Applies the default style from the user settings to the highlight. | |
double | buffer () const |
Returns the buffer. | |
QColor | color () const |
Returns the line/stroke color. | |
QColor | fillColor () const |
Returns the fill color. | |
QgsMapLayer * | layer () const |
Returns the layer for which this highlight has been created. | |
void | setBuffer (double buffer) |
Set line / stroke buffer in millimeters. | |
void | setColor (const QColor &color) |
Set line/stroke to color, polygon fill to color with alpha = 63. | |
void | setFillColor (const QColor &fillColor) |
Fill color for the highlight. | |
void | setMinWidth (double width) |
Set minimum line / stroke width in millimeters. | |
void | setWidth (int width) |
Set stroke width. | |
void | updatePosition () override |
called on changed extent or resize event to update position of the item | |
int | width () const |
Returns the stroke width. | |
![]() | |
QRectF | boundingRect () const override |
QgsRectangle | rect () const |
returns canvas item rectangle in map units | |
void | setRect (const QgsRectangle &r, bool resetRotation=true) |
sets canvas item rectangle in map units | |
QPointF | toCanvasCoordinates (const QgsPointXY &point) const |
transformation from map coordinates to screen coordinates | |
QgsPointXY | toMapCoordinates (QPoint point) const |
transformation from screen coordinates to map coordinates | |
Protected Member Functions | |
void | paint (QPainter *p) override |
function to be implemented by derived classes | |
void | updateRect () |
recalculates needed rectangle | |
![]() | |
QgsMapCanvasItem (QgsMapCanvas *mapCanvas) | |
protected constructor: cannot be constructed directly | |
~QgsMapCanvasItem () override | |
void | paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget=nullptr) override |
bool | setRenderContextVariables (QPainter *p, QgsRenderContext &context) const |
Sets render context parameters. | |
void | updateCanvas () |
schedules map canvas for repaint | |
Properties | |
int | buffer |
QColor | color |
QColor | fillColor |
int | width |
Friends | |
class | QgsMapToolAddFeature |
class | QgsUpdateGpsDetailsAction |
Additional Inherited Members | |
![]() | |
QSizeF | mItemSize |
cached size of the item (to return in boundingRect()) | |
QgsMapCanvas * | mMapCanvas = nullptr |
pointer to map canvas | |
QgsRectangle | mRect |
cached canvas item rectangle in map coordinates encodes position (xmin,ymax) and size (width/height) used to re-position and re-size the item on zoom/pan while waiting for the renderer to complete. | |
double | mRectRotation |
A class for highlight features on the map.
The QgsHighlight class provides a transparent overlay canvas item for highlighting features or geometries on a map canvas.
Definition at line 61 of file qgshighlight.h.
QgsHighlight::QgsHighlight | ( | QgsMapCanvas * | mapCanvas, |
const QgsGeometry & | geom, | ||
QgsMapLayer * | layer | ||
) |
Constructor for QgsHighlight.
mapCanvas | associated map canvas |
geom | initial geometry of highlight |
layer | associated map layer |
Definition at line 52 of file qgshighlight.cpp.
QgsHighlight::QgsHighlight | ( | QgsMapCanvas * | mapCanvas, |
const QgsFeature & | feature, | ||
QgsVectorLayer * | layer | ||
) |
Constructor for highlighting true
feature shape using feature attributes and renderer.
mapCanvas | map canvas |
feature | |
layer | vector layer |
Definition at line 61 of file qgshighlight.cpp.
|
overridedefault |
void QgsHighlight::applyDefaultStyle | ( | ) |
Applies the default style from the user settings to the highlight.
Definition at line 308 of file qgshighlight.cpp.
|
inline |
|
inline |
|
inline |
|
inline |
Returns the layer for which this highlight has been created.
Definition at line 168 of file qgshighlight.h.
|
overrideprotectedvirtual |
function to be implemented by derived classes
Implements QgsMapCanvasItem.
Definition at line 323 of file qgshighlight.cpp.
|
inline |
Set line / stroke buffer in millimeters.
Definition at line 157 of file qgshighlight.h.
void QgsHighlight::setColor | ( | const QColor & | color | ) |
Set line/stroke to color, polygon fill to color with alpha = 63.
This is legacy function, use setFillColor() after setColor() if different fill color is required.
Definition at line 108 of file qgshighlight.cpp.
void QgsHighlight::setFillColor | ( | const QColor & | fillColor | ) |
Fill color for the highlight.
Will be used for polygons and points.
Definition at line 117 of file qgshighlight.cpp.
|
inline |
Set minimum line / stroke width in millimeters.
Definition at line 163 of file qgshighlight.h.
void QgsHighlight::setWidth | ( | int | width | ) |
|
overridevirtual |
called on changed extent or resize event to update position of the item
Reimplemented from QgsMapCanvasItem.
Definition at line 295 of file qgshighlight.cpp.
|
protected |
recalculates needed rectangle
Definition at line 488 of file qgshighlight.cpp.
|
inline |
|
friend |
Definition at line 219 of file qgshighlight.h.
|
friend |
Definition at line 220 of file qgshighlight.h.
|
readwrite |
Definition at line 89 of file qgshighlight.h.
|
readwrite |
Definition at line 86 of file qgshighlight.h.
|
readwrite |
Definition at line 87 of file qgshighlight.h.
|
readwrite |
Definition at line 88 of file qgshighlight.h.