QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
A canvas for elevation profiles. More...
#include <qgselevationprofilecanvas.h>
Public Slots | |
void | clear () |
Clears the current profile. | |
void | setSnappingEnabled (bool enabled) |
Sets whether snapping of cursor points is enabled. | |
void | zoomFull () |
Zooms to the full extent of the profile. | |
Public Slots inherited from QgsPlotCanvas |
Signals | |
void | activeJobCountChanged (int count) |
Emitted when the number of active background jobs changes. | |
void | canvasPointHovered (const QgsPointXY &point, const QgsProfilePoint &profilePoint) |
Emitted when the mouse hovers over the specified point (in canvas coordinates). | |
Signals inherited from QgsPlotCanvas | |
void | contextMenuAboutToShow (QMenu *menu, QgsPlotMouseEvent *event) |
Emitted before the canvas context menu will be shown. | |
void | plotAreaChanged () |
Emitted whenever the visible area of the plot is changed. | |
void | toolChanged (QgsPlotTool *newTool) |
Emitted when the plot tool is changed. | |
void | willBeDeleted () |
Emitted in the destructor when the canvas is about to be deleted, but is still in a perfectly valid state. | |
Public Member Functions | |
QgsElevationProfileCanvas (QWidget *parent=nullptr) | |
Constructor for QgsElevationProfileCanvas, with the specified parent widget. | |
~QgsElevationProfileCanvas () override | |
void | cancelJobs () override |
Cancel any rendering job, in a blocking way. | |
QgsProfilePoint | canvasPointToPlotPoint (QPointF point) const |
Converts a canvas point to the equivalent plot point. | |
void | centerPlotOn (double x, double y) override |
Centers the plot on the plot point corresponding to x, y in canvas units. | |
QgsCoordinateReferenceSystem | crs () const override |
Returns the coordinate reference system (CRS) for map coordinates used by the canvas. | |
Qgis::DistanceUnit | distanceUnit () const |
Returns the distance unit used by the canvas. | |
QVector< QgsProfileIdentifyResults > | identify (const QRectF &rect) |
Identify results visible within the specified plot rect. | |
QVector< QgsProfileIdentifyResults > | identify (QPointF point) |
Identify results visible at the specified plot point. | |
void | invalidateCurrentPlotExtent () |
Invalidates the current plot extent, which means that the visible plot area will be recalculated and "zoom full" operation occur when the next profile generation completes. | |
QList< QgsMapLayer * > | layers () const |
Returns the list of layers included in the profile. | |
bool | lockAxisScales () const |
Returns true if the distance and elevation scales are locked to each other. | |
void | mouseMoveEvent (QMouseEvent *e) override |
void | paintEvent (QPaintEvent *event) override |
void | panContentsBy (double dx, double dy) override |
Pans the plot contents by dx, dy in canvas units. | |
const Qgs2DPlot & | plot () const |
Returns a reference to the 2D plot used by the widget. | |
QRectF | plotArea () const |
Returns the interior rectangle representing the surface of the plot, in canvas coordinates. | |
QgsPointXY | plotPointToCanvasPoint (const QgsProfilePoint &point) const |
Converts a plot point to the equivalent canvas point. | |
QgsCurve * | profileCurve () const |
Returns the profile curve. | |
void | refresh () override |
Triggers a complete regeneration of the profile, causing the profile extraction to perform in the background. | |
void | render (QgsRenderContext &context, double width, double height, const Qgs2DPlot &plotSettings) |
Renders a portion of the profile using the specified render context. | |
void | resizeEvent (QResizeEvent *event) override |
void | scalePlot (double factor) override |
Scales the plot by a specified scale factor. | |
void | scalePlot (double xFactor, double yFactor) |
Scales the plot axis by the given factors. | |
void | setBackgroundColor (const QColor &color) |
Sets the background color to use for the profile canvas. | |
void | setCrs (const QgsCoordinateReferenceSystem &crs) |
Sets the crs associated with the canvas' map coordinates. | |
void | setDistanceUnit (Qgis::DistanceUnit unit) |
Sets the distance unit used by the canvas. | |
void | setLayers (const QList< QgsMapLayer * > &layers) |
Sets the list of layers to include in the profile. | |
void | setLockAxisScales (bool lock) |
Sets whether the distance and elevation scales are locked to each other. | |
void | setProfileCurve (QgsCurve *curve) |
Sets the profile curve. | |
void | setProject (QgsProject *project) |
Sets the project associated with the profile. | |
void | setTolerance (double tolerance) |
Sets the profile tolerance (in crs() units). | |
void | setVisiblePlotRange (double minimumDistance, double maximumDistance, double minimumElevation, double maximumElevation) |
Sets the visible area of the plot. | |
QgsPointXY | snapToPlot (QPoint point) override |
Snap a canvas point to the plot. | |
QgsPointXY | toCanvasCoordinates (const QgsPoint &point) const override |
Converts a point in map coordinates to the associated canvas point. | |
double | tolerance () const |
Returns the tolerance of the profile (in crs() units). | |
QgsPoint | toMapCoordinates (const QgsPointXY &point) const override |
Converts a point on the canvas to the associated map coordinate. | |
QgsDoubleRange | visibleDistanceRange () const |
Returns the distance range currently visible in the plot. | |
QgsDoubleRange | visibleElevationRange () const |
Returns the elevation range currently visible in the plot. | |
void | wheelZoom (QWheelEvent *event) override |
Zoom plot from a mouse wheel event. | |
void | zoomToRect (const QRectF &rect) override |
Zooms the plot to the specified rect in canvas units. | |
Public Member Functions inherited from QgsPlotCanvas | |
QgsPlotCanvas (QWidget *parent=nullptr) | |
Constructor for QgsPlotCanvas, with the specified parent widget. | |
~QgsPlotCanvas () override | |
void | setTool (QgsPlotTool *tool) |
Sets the interactive tool currently being used on the canvas. | |
QgsPlotTool * | tool () |
Returns the currently active tool. | |
void | unsetTool (QgsPlotTool *tool) |
Unset the current tool. | |
Additional Inherited Members | |
Protected Member Functions inherited from QgsPlotCanvas | |
bool | event (QEvent *e) override |
void | keyPressEvent (QKeyEvent *e) override |
void | keyReleaseEvent (QKeyEvent *e) override |
void | mouseDoubleClickEvent (QMouseEvent *e) override |
void | mouseMoveEvent (QMouseEvent *e) override |
void | mousePressEvent (QMouseEvent *e) override |
void | mouseReleaseEvent (QMouseEvent *e) override |
void | resizeEvent (QResizeEvent *e) override |
bool | viewportEvent (QEvent *event) override |
void | wheelEvent (QWheelEvent *e) override |
A canvas for elevation profiles.
Definition at line 46 of file qgselevationprofilecanvas.h.
PRIVATE QgsElevationProfileCanvas::QgsElevationProfileCanvas | ( | QWidget * | parent = nullptr | ) |
Constructor for QgsElevationProfileCanvas, with the specified parent widget.
Definition at line 418 of file qgselevationprofilecanvas.cpp.
|
override |
Definition at line 445 of file qgselevationprofilecanvas.cpp.
|
signal |
Emitted when the number of active background jobs changes.
|
overridevirtual |
Cancel any rendering job, in a blocking way.
Used for application closing.
Reimplemented from QgsPlotCanvas.
Definition at line 455 of file qgselevationprofilecanvas.cpp.
|
signal |
Emitted when the mouse hovers over the specified point (in canvas coordinates).
The profilePoint argument gives the hovered profile point, which may be snapped.
QgsProfilePoint QgsElevationProfileCanvas::canvasPointToPlotPoint | ( | QPointF | point | ) | const |
Converts a canvas point to the equivalent plot point.
Definition at line 1103 of file qgselevationprofilecanvas.cpp.
|
overridevirtual |
Centers the plot on the plot point corresponding to x, y in canvas units.
The default implementation does nothing.
Reimplemented from QgsPlotCanvas.
Definition at line 488 of file qgselevationprofilecanvas.cpp.
|
slot |
Clears the current profile.
Definition at line 1428 of file qgselevationprofilecanvas.cpp.
|
overridevirtual |
Returns the coordinate reference system (CRS) for map coordinates used by the canvas.
May return an invalid CRS if no CRS is associated with the canvas.
Reimplemented from QgsPlotCanvas.
Definition at line 1142 of file qgselevationprofilecanvas.cpp.
Qgis::DistanceUnit QgsElevationProfileCanvas::distanceUnit | ( | ) | const |
Returns the distance unit used by the canvas.
Definition at line 622 of file qgselevationprofilecanvas.cpp.
QVector< QgsProfileIdentifyResults > QgsElevationProfileCanvas::identify | ( | const QRectF & | rect | ) |
Identify results visible within the specified plot rect.
Definition at line 1407 of file qgselevationprofilecanvas.cpp.
QVector< QgsProfileIdentifyResults > QgsElevationProfileCanvas::identify | ( | QPointF | point | ) |
Identify results visible at the specified plot point.
Definition at line 1397 of file qgselevationprofilecanvas.cpp.
void QgsElevationProfileCanvas::invalidateCurrentPlotExtent | ( | ) |
Invalidates the current plot extent, which means that the visible plot area will be recalculated and "zoom full" operation occur when the next profile generation completes.
Definition at line 906 of file qgselevationprofilecanvas.cpp.
QList< QgsMapLayer * > QgsElevationProfileCanvas::layers | ( | ) | const |
Returns the list of layers included in the profile.
Definition at line 1169 of file qgselevationprofilecanvas.cpp.
bool QgsElevationProfileCanvas::lockAxisScales | ( | ) | const |
Returns true
if the distance and elevation scales are locked to each other.
Definition at line 675 of file qgselevationprofilecanvas.cpp.
|
override |
Definition at line 828 of file qgselevationprofilecanvas.cpp.
|
override |
Definition at line 1195 of file qgselevationprofilecanvas.cpp.
|
overridevirtual |
Pans the plot contents by dx, dy in canvas units.
The default implementation does nothing.
Reimplemented from QgsPlotCanvas.
Definition at line 467 of file qgselevationprofilecanvas.cpp.
const Qgs2DPlot & QgsElevationProfileCanvas::plot | ( | ) | const |
Returns a reference to the 2D plot used by the widget.
Definition at line 1339 of file qgselevationprofilecanvas.cpp.
QRectF QgsElevationProfileCanvas::plotArea | ( | ) | const |
Returns the interior rectangle representing the surface of the plot, in canvas coordinates.
Definition at line 857 of file qgselevationprofilecanvas.cpp.
QgsPointXY QgsElevationProfileCanvas::plotPointToCanvasPoint | ( | const QgsProfilePoint & | point | ) | const |
Converts a plot point to the equivalent canvas point.
Definition at line 1111 of file qgselevationprofilecanvas.cpp.
QgsCurve * QgsElevationProfileCanvas::profileCurve | ( | ) | const |
Returns the profile curve.
The CRS associated with the curve is retrieved via crs().
Definition at line 1132 of file qgselevationprofilecanvas.cpp.
|
overridevirtual |
Triggers a complete regeneration of the profile, causing the profile extraction to perform in the background.
Reimplemented from QgsPlotCanvas.
Definition at line 862 of file qgselevationprofilecanvas.cpp.
PRIVATE void QgsElevationProfileCanvas::render | ( | QgsRenderContext & | context, |
double | width, | ||
double | height, | ||
const Qgs2DPlot & | plotSettings | ||
) |
Renders a portion of the profile using the specified render context.
Definition at line 1372 of file qgselevationprofilecanvas.cpp.
|
override |
Definition at line 1174 of file qgselevationprofilecanvas.cpp.
|
overridevirtual |
Scales the plot by a specified scale factor.
The default implementation does nothing.
Reimplemented from QgsPlotCanvas.
Definition at line 511 of file qgselevationprofilecanvas.cpp.
void QgsElevationProfileCanvas::scalePlot | ( | double | xFactor, |
double | yFactor | ||
) |
Scales the plot axis by the given factors.
Definition at line 715 of file qgselevationprofilecanvas.cpp.
void QgsElevationProfileCanvas::setBackgroundColor | ( | const QColor & | color | ) |
Sets the background color to use for the profile canvas.
The chart text, border and axis color will be automatically updated to ensure readability with the new background color.
Definition at line 639 of file qgselevationprofilecanvas.cpp.
void QgsElevationProfileCanvas::setCrs | ( | const QgsCoordinateReferenceSystem & | crs | ) |
Sets the crs associated with the canvas' map coordinates.
Definition at line 1122 of file qgselevationprofilecanvas.cpp.
void QgsElevationProfileCanvas::setDistanceUnit | ( | Qgis::DistanceUnit | unit | ) |
Sets the distance unit used by the canvas.
Definition at line 627 of file qgselevationprofilecanvas.cpp.
void QgsElevationProfileCanvas::setLayers | ( | const QList< QgsMapLayer * > & | layers | ) |
Sets the list of layers to include in the profile.
Definition at line 1147 of file qgselevationprofilecanvas.cpp.
void QgsElevationProfileCanvas::setLockAxisScales | ( | bool | lock | ) |
Sets whether the distance and elevation scales are locked to each other.
Definition at line 680 of file qgselevationprofilecanvas.cpp.
void QgsElevationProfileCanvas::setProfileCurve | ( | QgsCurve * | curve | ) |
Sets the profile curve.
The CRS associated with curve is set via setCrs().
Ownership is transferred to the plot canvas.
Definition at line 1127 of file qgselevationprofilecanvas.cpp.
void QgsElevationProfileCanvas::setProject | ( | QgsProject * | project | ) |
Sets the project associated with the profile.
This must be set before any layers which utilize terrain based elevation settings can be included in the canvas.
Definition at line 1116 of file qgselevationprofilecanvas.cpp.
|
slot |
Sets whether snapping of cursor points is enabled.
Definition at line 1435 of file qgselevationprofilecanvas.cpp.
void QgsElevationProfileCanvas::setTolerance | ( | double | tolerance | ) |
Sets the profile tolerance (in crs() units).
This value determines how far from the profileCurve() is appropriate for inclusion of results. For instance, when a profile is generated for a point vector layer this tolerance distance will dictate how far from the actual profile curve a point can reside within to be included in the results.
Definition at line 1137 of file qgselevationprofilecanvas.cpp.
void QgsElevationProfileCanvas::setVisiblePlotRange | ( | double | minimumDistance, |
double | maximumDistance, | ||
double | minimumElevation, | ||
double | maximumElevation | ||
) |
Sets the visible area of the plot.
Definition at line 1313 of file qgselevationprofilecanvas.cpp.
|
overridevirtual |
Snap a canvas point to the plot.
Returns an empty point if snapping was not possible.
point | point in canvas coordinates |
Reimplemented from QgsPlotCanvas.
Definition at line 701 of file qgselevationprofilecanvas.cpp.
|
overridevirtual |
Converts a point in map coordinates to the associated canvas point.
May return an empty point if the map point cannot be converted to a canvas point.
Reimplemented from QgsPlotCanvas.
Definition at line 1230 of file qgselevationprofilecanvas.cpp.
|
inline |
Returns the tolerance of the profile (in crs() units).
This value determines how far from the profileCurve() is appropriate for inclusion of results. For instance, when a profile is generated for a point vector layer this tolerance distance will dictate how far from the actual profile curve a point can reside within to be included in the results.
Definition at line 165 of file qgselevationprofilecanvas.h.
|
overridevirtual |
Converts a point on the canvas to the associated map coordinate.
May return an empty point if the canvas point cannot be converted to a map point.
Reimplemented from QgsPlotCanvas.
Definition at line 1208 of file qgselevationprofilecanvas.cpp.
QgsDoubleRange QgsElevationProfileCanvas::visibleDistanceRange | ( | ) | const |
Returns the distance range currently visible in the plot.
Definition at line 1329 of file qgselevationprofilecanvas.cpp.
QgsDoubleRange QgsElevationProfileCanvas::visibleElevationRange | ( | ) | const |
Returns the elevation range currently visible in the plot.
Definition at line 1334 of file qgselevationprofilecanvas.cpp.
|
overridevirtual |
Zoom plot from a mouse wheel event.
The default implementation does nothing.
Reimplemented from QgsPlotCanvas.
Definition at line 772 of file qgselevationprofilecanvas.cpp.
|
slot |
Zooms to the full extent of the profile.
Definition at line 1263 of file qgselevationprofilecanvas.cpp.
|
overridevirtual |
Zooms the plot to the specified rect in canvas units.
The default implementation does nothing.
Reimplemented from QgsPlotCanvas.
Definition at line 748 of file qgselevationprofilecanvas.cpp.