QGIS API Documentation 3.27.0-Master (1d7a28cfd2)
qgsprofilesnapping.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsprofilesnapping.h
3 ---------------
4 begin : April 2022
5 copyright : (C) 2022 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17#ifndef QGSPROFILESNAPPING_H
18#define QGSPROFILESNAPPING_H
19
20#include "qgis_core.h"
21#include "qgis_sip.h"
22#include "qgis.h"
23#include "qgsprofilepoint.h"
24
30class CORE_EXPORT QgsProfileSnapContext
31{
32 public:
33
35 double maximumSurfaceDistanceDelta = 0;
36
38 double maximumSurfaceElevationDelta = 0;
39
41 double maximumPointDistanceDelta = 0;
42
44 double maximumPointElevationDelta = 0;
45
47 double displayRatioElevationVsDistance = 1;
48
49};
50
56class CORE_EXPORT QgsProfileSnapResult
57{
58 public:
59
62
66 bool isValid() const { return !snappedPoint.isEmpty(); }
67};
68
69#endif // QGSPROFILESNAPPING_H
Encapsulates a point on a distance-elevation profile.
bool isEmpty() const SIP_HOLDGIL
Returns true if the point is empty.
Encapsulates the context of snapping a profile point.
Encapsulates results of snapping a profile point.
bool isValid() const
Returns true if the result is a valid point.
QgsProfilePoint snappedPoint
Snapped point.