QGIS API Documentation 3.39.0-Master (f549811d78c)
|
Encapsulates the context in which an elevation profile is to be generated. More...
#include <qgsabstractprofilegenerator.h>
Public Member Functions | |
double | convertDistanceToPixels (double size, Qgis::RenderUnit unit) const |
Converts a distance size from the specified units to pixels. | |
QgsDoubleRange | distanceRange () const |
Returns the range of distances to include in the generation. | |
double | dpi () const |
Returns the DPI (dots per inch) for the profie, to be used in size conversions. | |
QgsDoubleRange | elevationRange () const |
Returns the range of elevations to include in the generation. | |
double | mapUnitsPerDistancePixel () const |
Returns the number of map units per pixel in the distance dimension. | |
double | maximumErrorMapUnits () const |
Returns the maximum allowed error in the generated result, in profile curve map units. | |
bool | operator!= (const QgsProfileGenerationContext &other) const |
bool | operator== (const QgsProfileGenerationContext &other) const |
void | setDistanceRange (const QgsDoubleRange &range) |
Sets the range of distances to include in the generation. | |
void | setDpi (double dpi) |
Sets the dpi (dots per inch) for the profie, to be used in size conversions. | |
void | setElevationRange (const QgsDoubleRange &range) |
Sets the range of elevations to include in the generation. | |
void | setMapUnitsPerDistancePixel (double units) |
Sets the number of map units per pixel in the distance dimension. | |
void | setMaximumErrorMapUnits (double error) |
Sets the maximum allowed error in the generated result, in profile curve map units. | |
Encapsulates the context in which an elevation profile is to be generated.
Definition at line 285 of file qgsabstractprofilegenerator.h.
double QgsProfileGenerationContext::convertDistanceToPixels | ( | double | size, |
Qgis::RenderUnit | unit | ||
) | const |
Converts a distance size from the specified units to pixels.
Definition at line 94 of file qgsabstractprofilegenerator.cpp.
|
inline |
Returns the range of distances to include in the generation.
Distances outside this range may be excluded from the generation (if it results in faster profile generation).
Definition at line 330 of file qgsabstractprofilegenerator.h.
|
inline |
Returns the DPI (dots per inch) for the profie, to be used in size conversions.
Definition at line 371 of file qgsabstractprofilegenerator.h.
|
inline |
Returns the range of elevations to include in the generation.
Elevations outside this range may be excluded from the generation (if it results in faster profile generation).
Definition at line 348 of file qgsabstractprofilegenerator.h.
|
inline |
Returns the number of map units per pixel in the distance dimension.
Definition at line 314 of file qgsabstractprofilegenerator.h.
|
inline |
Returns the maximum allowed error in the generated result, in profile curve map units.
By default this is NaN, which indicates that the profile should be generated in the highest precision possible. Larger values will result in a faster profile to generate.
Definition at line 297 of file qgsabstractprofilegenerator.h.
bool QgsProfileGenerationContext::operator!= | ( | const QgsProfileGenerationContext & | other | ) | const |
Definition at line 141 of file qgsabstractprofilegenerator.cpp.
bool QgsProfileGenerationContext::operator== | ( | const QgsProfileGenerationContext & | other | ) | const |
Definition at line 132 of file qgsabstractprofilegenerator.cpp.
|
inline |
Sets the range of distances to include in the generation.
Distances outside this range may be excluded from the generation (if it results in faster profile generation).
Definition at line 339 of file qgsabstractprofilegenerator.h.
|
inline |
Sets the dpi (dots per inch) for the profie, to be used in size conversions.
Definition at line 364 of file qgsabstractprofilegenerator.h.
|
inline |
Sets the range of elevations to include in the generation.
Elevations outside this range may be excluded from the generation (if it results in faster profile generation).
Definition at line 357 of file qgsabstractprofilegenerator.h.
|
inline |
Sets the number of map units per pixel in the distance dimension.
Definition at line 321 of file qgsabstractprofilegenerator.h.
|
inline |
Sets the maximum allowed error in the generated result, in profile curve map units.
By default this is NaN, which indicates that the profile should be generated in the highest precision possible. Larger values will result in a faster profile to generate.
Definition at line 307 of file qgsabstractprofilegenerator.h.