QGIS API Documentation 4.1.0-Master (60fea48833c)
Loading...
Searching...
No Matches
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
20#include <functional>
21
22#include "qgspointxy.h"
23
24#define SIP_NO_FILE
25
26class QgsGeometry;
28class QgsLineString;
30class QgsFeedback;
31
41
43{
44 public:
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(
192 int count, const std::function< bool( const QgsPointXY & ) > &acceptPoint, unsigned long seed = 0, QgsFeedback *feedback = nullptr, int maxTriesPerPoint = 0
193 );
194
210 QgsGeometry convertToCurves( double distanceTolerance, double angleTolerance ) const;
211
223 QgsGeometry orientedMinimumBoundingBox( double &area SIP_OUT, double &angle SIP_OUT, double &width SIP_OUT, double &height SIP_OUT ) const;
224
237 QgsGeometry triangularWaves( double wavelength, double amplitude, bool strictWavelength = false ) const;
238
257 QgsGeometry triangularWavesRandomized( double minimumWavelength, double maximumWavelength, double minimumAmplitude, double maximumAmplitude, unsigned long seed = 0 ) const;
258
271 QgsGeometry squareWaves( double wavelength, double amplitude, bool strictWavelength = false ) const;
272
291 QgsGeometry squareWavesRandomized( double minimumWavelength, double maximumWavelength, double minimumAmplitude, double maximumAmplitude, unsigned long seed = 0 ) const;
292
293
306 QgsGeometry roundWaves( double wavelength, double amplitude, bool strictWavelength = false ) const;
307
326 QgsGeometry roundWavesRandomized( double minimumWavelength, double maximumWavelength, double minimumAmplitude, double maximumAmplitude, unsigned long seed = 0 ) const;
327
342 const QVector< double > &pattern,
346 double patternOffset = 0
347 ) const;
348
349 private:
350 const QgsAbstractGeometry *mGeometry = nullptr;
351
352 mutable QString mLastError;
353};
354
361class CORE_EXPORT QgsRay2D
362{
363 public:
368 QgsRay2D( const QgsPointXY &origin, QgsVector direction )
369 : origin( origin )
370 , direction( direction )
371 {}
372
380 bool intersects( const QgsLineSegment2D &segment, QgsPointXY &intersectPoint ) const;
381
382 private:
383 QgsPointXY origin;
384 QgsVector direction;
385};
386
388
389// adapted for QGIS geometry classes from original work at https://github.com/trylock/visibility by trylock
390
400class CORE_EXPORT QgsLineSegmentDistanceComparer
401{
402 public:
407 explicit QgsLineSegmentDistanceComparer( const QgsPointXY &origin )
408 : mOrigin( origin )
409 {}
410
418 bool operator()( QgsLineSegment2D ab, QgsLineSegment2D cd ) const;
419
420 private:
421 QgsPointXY mOrigin;
422};
423
424
425// adapted for QGIS geometry classes from original work at https://github.com/trylock/visibility by trylock
426
433class CORE_EXPORT QgsClockwiseAngleComparer
434{
435 public:
436 explicit QgsClockwiseAngleComparer( const QgsPointXY &origin )
437 : mVertex( origin )
438 {}
439
440 bool operator()( const QgsPointXY &a, const QgsPointXY &b ) const;
441
442 private:
443 QgsPointXY mVertex;
444};
445
447
448#endif // QGSINTERNALGEOMETRYENGINE_H
DashPatternSizeAdjustment
Dash pattern size adjustment options.
Definition qgis.h:3405
@ ScaleBothDashAndGap
Both the dash and gap lengths are adjusted equally.
Definition qgis.h:3406
DashPatternLineEndingRule
Dash pattern line ending rules.
Definition qgis.h:3390
@ NoRule
No special rule.
Definition qgis.h:3391
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.
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.
Represents a 2D point.
Definition qgspointxy.h:62
QgsRay2D(const QgsPointXY &origin, QgsVector direction)
Constructor for a ray starting at the given origin and extending an infinite distance in the specifie...
Represent a 2-dimensional vector.
Definition qgsvector.h:34
#define SIP_OUT
Definition qgis_sip.h:57
QLineF segment(int index, QRectF rect, double radius)