QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
qgsinternalgeometryengine.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsinternalgeometryengine.h - QgsInternalGeometryEngine
3
4 ---------------------
5 begin : 13.1.2016
6 copyright : (C) 2016 by Matthias Kuhn
8 ***************************************************************************
9 * *
10 * This program is free software; you can redistribute it and/or modify *
11 * it under the terms of the GNU General Public License as published by *
12 * the Free Software Foundation; either version 2 of the License, or *
13 * (at your option) any later version. *
14 * *
15 ***************************************************************************/
16#ifndef QGSINTERNALGEOMETRYENGINE_H
17#define QGSINTERNALGEOMETRYENGINE_H
18
19#define SIP_NO_FILE
20
21#include <functional>
22
23#include "qgspointxy.h"
24
25class QgsGeometry;
27class QgsLineString;
29class QgsFeedback;
30
42{
43 public:
44
50 explicit QgsInternalGeometryEngine( const QgsGeometry &geometry );
51
57 QString lastError() const;
58
72 bool isAxisParallelRectangle( double maximumDeviation, bool simpleRectanglesOnly = false ) const;
73
82 QgsGeometry extrude( double x, double y ) const;
83
93 QgsGeometry poleOfInaccessibility( double precision, double *distanceFromBoundary = nullptr ) const;
94
102 QgsGeometry orthogonalize( double tolerance = 1.0E-8, int maxIterations = 1000, double angleThreshold = 15.0 ) const;
103
111 QgsGeometry densifyByCount( int extraNodesPerSegment ) const;
112
125 QgsGeometry densifyByDistance( double distance ) const;
126
141 QgsGeometry variableWidthBuffer( int segments, const std::function< std::unique_ptr< double[] >( const QgsLineString *line ) > &widthFunction ) const;
142
157 QgsGeometry taperedBuffer( double startWidth, double endWidth, int segments ) const;
158
169 QgsGeometry variableWidthBufferByM( int segments ) const;
170
191 QVector< QgsPointXY > randomPointsInPolygon( int count,
192 const std::function< bool( const QgsPointXY & ) > &acceptPoint, unsigned long seed = 0, QgsFeedback *feedback = nullptr, int maxTriesPerPoint = 0 );
193
209 QgsGeometry convertToCurves( double distanceTolerance, double angleTolerance ) const;
210
222 QgsGeometry orientedMinimumBoundingBox( double &area SIP_OUT, double &angle SIP_OUT, double &width SIP_OUT, double &height SIP_OUT ) const;
223
236 QgsGeometry triangularWaves( double wavelength, double amplitude, bool strictWavelength = false ) const;
237
256 QgsGeometry triangularWavesRandomized( double minimumWavelength, double maximumWavelength, double minimumAmplitude, double maximumAmplitude, unsigned long seed = 0 ) const;
257
270 QgsGeometry squareWaves( double wavelength, double amplitude, bool strictWavelength = false ) const;
271
290 QgsGeometry squareWavesRandomized( double minimumWavelength, double maximumWavelength, double minimumAmplitude, double maximumAmplitude, unsigned long seed = 0 ) const;
291
292
305 QgsGeometry roundWaves( double wavelength, double amplitude, bool strictWavelength = false ) const;
306
325 QgsGeometry roundWavesRandomized( double minimumWavelength, double maximumWavelength, double minimumAmplitude, double maximumAmplitude, unsigned long seed = 0 ) const;
326
340 QgsGeometry applyDashPattern( const QVector< double > &pattern,
344 double patternOffset = 0 ) const;
345
346 private:
347 const QgsAbstractGeometry *mGeometry = nullptr;
348
349 mutable QString mLastError;
350};
351
358class CORE_EXPORT QgsRay2D
359{
360 public:
361
366 QgsRay2D( const QgsPointXY &origin, QgsVector direction )
367 : origin( origin )
368 , direction( direction )
369 {}
370
378 bool intersects( const QgsLineSegment2D &segment, QgsPointXY &intersectPoint ) const;
379
380 private:
381
382 QgsPointXY origin;
383 QgsVector direction;
384};
385
387
388// adapted for QGIS geometry classes from original work at https://github.com/trylock/visibility by trylock
389
399class CORE_EXPORT QgsLineSegmentDistanceComparer
400{
401 public:
402
407 explicit QgsLineSegmentDistanceComparer( const QgsPointXY &origin )
408 : mOrigin( origin )
409 {}
410
418 bool operator()( QgsLineSegment2D ab, QgsLineSegment2D cd ) const;
419
420 private:
421
422 QgsPointXY mOrigin;
423
424};
425
426
427// adapted for QGIS geometry classes from original work at https://github.com/trylock/visibility by trylock
428
435class CORE_EXPORT QgsClockwiseAngleComparer
436{
437 public:
438 explicit QgsClockwiseAngleComparer( const QgsPointXY &origin )
439 : mVertex( origin )
440 {}
441
442 bool operator()( const QgsPointXY &a, const QgsPointXY &b ) const;
443
444 private:
445
446 QgsPointXY mVertex;
447
448};
449
451
452#endif // QGSINTERNALGEOMETRYENGINE_H
DashPatternSizeAdjustment
Dash pattern size adjustment options.
Definition: qgis.h:2675
@ ScaleBothDashAndGap
Both the dash and gap lengths are adjusted equally.
DashPatternLineEndingRule
Dash pattern line ending rules.
Definition: qgis.h:2660
Abstract base class for all geometries.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition: qgsfeedback.h:44
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:162
This class offers geometry processing methods.
QgsGeometry triangularWavesRandomized(double minimumWavelength, double maximumWavelength, double minimumAmplitude, double maximumAmplitude, unsigned long seed=0) const
Constructs randomized triangular waves along the boundary of the geometry, with the specified wavelen...
QgsGeometry triangularWaves(double wavelength, double amplitude, bool strictWavelength=false) const
Constructs triangular waves along the boundary of the geometry, with the specified wavelength and amp...
QgsInternalGeometryEngine(const QgsGeometry &geometry)
The caller is responsible that the geometry is available and unchanged for the whole lifetime of this...
QgsGeometry roundWaves(double wavelength, double amplitude, bool strictWavelength=false) const
Constructs rounded (sine-like) waves along the boundary of the geometry, with the specified wavelengt...
QgsGeometry poleOfInaccessibility(double precision, double *distanceFromBoundary=nullptr) const
Calculates the approximate pole of inaccessibility for a surface, which is the most distant internal ...
QgsGeometry squareWaves(double wavelength, double amplitude, bool strictWavelength=false) const
Constructs square waves along the boundary of the geometry, with the specified wavelength and amplitu...
QgsGeometry variableWidthBufferByM(int segments) const
Calculates a variable width buffer using the m-values from a (multi)line geometry.
QgsGeometry extrude(double x, double y) const
Will extrude a line or (segmentized) curve by a given offset and return a polygon representation of i...
QgsGeometry roundWavesRandomized(double minimumWavelength, double maximumWavelength, double minimumAmplitude, double maximumAmplitude, unsigned long seed=0) const
Constructs randomized rounded (sine-like) waves along the boundary of the geometry,...
QgsGeometry orthogonalize(double tolerance=1.0E-8, int maxIterations=1000, double angleThreshold=15.0) const
Attempts to orthogonalize a line or polygon geometry by shifting vertices to make the geometries angl...
QgsGeometry variableWidthBuffer(int segments, const std::function< std::unique_ptr< double[] >(const QgsLineString *line) > &widthFunction) const
Calculates a variable width buffer for a (multi)curve geometry.
QString lastError() const
Returns an error string referring to the last error encountered.
QgsGeometry orientedMinimumBoundingBox(double &area, double &angle, double &width, double &height) const
Returns the oriented minimum bounding box for the geometry, which is the smallest (by area) rotated r...
QgsGeometry densifyByDistance(double distance) const
Densifies the geometry by adding regularly placed extra nodes inside each segment so that the maximum...
QgsGeometry taperedBuffer(double startWidth, double endWidth, int segments) const
Calculates a tapered width buffer for a (multi)curve geometry.
QVector< QgsPointXY > randomPointsInPolygon(int count, const std::function< bool(const QgsPointXY &) > &acceptPoint, unsigned long seed=0, QgsFeedback *feedback=nullptr, int maxTriesPerPoint=0)
Returns a list of count random points generated inside a polygon geometry (if acceptPoint is specifie...
QgsGeometry densifyByCount(int extraNodesPerSegment) const
Densifies the geometry by adding the specified number of extra nodes within each segment of the geome...
QgsGeometry applyDashPattern(const QVector< double > &pattern, Qgis::DashPatternLineEndingRule startRule=Qgis::DashPatternLineEndingRule::NoRule, Qgis::DashPatternLineEndingRule endRule=Qgis::DashPatternLineEndingRule::NoRule, Qgis::DashPatternSizeAdjustment adjustment=Qgis::DashPatternSizeAdjustment::ScaleBothDashAndGap, double patternOffset=0) const
Applies a dash pattern to a geometry, returning a MultiLineString geometry which is the input geometr...
QgsGeometry squareWavesRandomized(double minimumWavelength, double maximumWavelength, double minimumAmplitude, double maximumAmplitude, unsigned long seed=0) const
Constructs randomized square waves along the boundary of the geometry, with the specified wavelength ...
QgsGeometry convertToCurves(double distanceTolerance, double angleTolerance) const
Attempts to convert a non-curved geometry into a curved geometry type (e.g.
bool isAxisParallelRectangle(double maximumDeviation, bool simpleRectanglesOnly=false) const
Returns true if the geometry is a polygon that is almost an axis-parallel rectangle.
Represents a single 2D line segment, consisting of a 2D start and end vertex only.
Line string geometry type, with support for z-dimension and m-values.
Definition: qgslinestring.h:45
A class to represent a 2D point.
Definition: qgspointxy.h:60
A 2D ray which extends from an origin point to an infinite distance in a given direction.
QgsRay2D(const QgsPointXY &origin, QgsVector direction)
Constructor for a ray starting at the given origin and extending an infinite distance in the specifie...
A class to represent a vector.
Definition: qgsvector.h:30
double ANALYSIS_EXPORT angle(QgsPoint *p1, QgsPoint *p2, QgsPoint *p3, QgsPoint *p4)
Calculates the angle between two segments (in 2 dimension, z-values are ignored)
Definition: MathUtils.cpp:716
std::unique_ptr< GEOSGeometry, GeosDeleter > unique_ptr
Scoped GEOS pointer.
Definition: qgsgeos.h:73
#define SIP_OUT
Definition: qgis_sip.h:58
QLineF segment(int index, QRectF rect, double radius)
int precision