QGIS/python/core/geometry/qgsgeometryengine.sip
2017-04-30 11:29:45 +02:00

183 lines
6.2 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/geometry/qgsgeometryengine.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsGeometryEngine
{
%Docstring
Contains geometry relation and modification algorithms.
.. versionadded:: 2.10
%End
%TypeHeaderCode
#include "qgsgeometryengine.h"
%End
public:
virtual ~QgsGeometryEngine();
virtual void geometryChanged() = 0;
virtual void prepareGeometry() = 0;
virtual QgsAbstractGeometry *intersection( const QgsAbstractGeometry &geom, QString *errorMsg = 0 ) const = 0 /Factory/;
%Docstring
:rtype: QgsAbstractGeometry
%End
virtual QgsAbstractGeometry *difference( const QgsAbstractGeometry &geom, QString *errorMsg = 0 ) const = 0 /Factory/;
%Docstring
:rtype: QgsAbstractGeometry
%End
virtual QgsAbstractGeometry *combine( const QgsAbstractGeometry &geom, QString *errorMsg = 0 ) const = 0 /Factory/;
%Docstring
:rtype: QgsAbstractGeometry
%End
virtual QgsAbstractGeometry *combine( const QList< QgsAbstractGeometry * > &, QString *errorMsg = 0 ) const = 0 /Factory/;
%Docstring
:rtype: QgsAbstractGeometry
%End
virtual QgsAbstractGeometry *symDifference( const QgsAbstractGeometry &geom, QString *errorMsg = 0 ) const = 0 /Factory/;
%Docstring
:rtype: QgsAbstractGeometry
%End
virtual QgsAbstractGeometry *buffer( double distance, int segments, QString *errorMsg = 0 ) const = 0 /Factory/;
%Docstring
:rtype: QgsAbstractGeometry
%End
virtual QgsAbstractGeometry *buffer( double distance, int segments, int endCapStyle, int joinStyle, double mitreLimit, QString *errorMsg = 0 ) const = 0 /Factory/;
%Docstring
:rtype: QgsAbstractGeometry
%End
virtual QgsAbstractGeometry *simplify( double tolerance, QString *errorMsg = 0 ) const = 0 /Factory/;
%Docstring
:rtype: QgsAbstractGeometry
%End
virtual QgsAbstractGeometry *interpolate( double distance, QString *errorMsg = 0 ) const = 0 /Factory/;
%Docstring
:rtype: QgsAbstractGeometry
%End
virtual QgsAbstractGeometry *envelope( QString *errorMsg = 0 ) const = 0 /Factory/;
%Docstring
:rtype: QgsAbstractGeometry
%End
virtual bool centroid( QgsPointV2 &pt, QString *errorMsg = 0 ) const = 0;
%Docstring
:rtype: bool
%End
virtual bool pointOnSurface( QgsPointV2 &pt, QString *errorMsg = 0 ) const = 0;
%Docstring
:rtype: bool
%End
virtual QgsAbstractGeometry *convexHull( QString *errorMsg = 0 ) const = 0 /Factory/;
%Docstring
:rtype: QgsAbstractGeometry
%End
virtual double distance( const QgsAbstractGeometry &geom, QString *errorMsg = 0 ) const = 0;
%Docstring
:rtype: float
%End
virtual bool intersects( const QgsAbstractGeometry &geom, QString *errorMsg = 0 ) const = 0;
%Docstring
:rtype: bool
%End
virtual bool touches( const QgsAbstractGeometry &geom, QString *errorMsg = 0 ) const = 0;
%Docstring
:rtype: bool
%End
virtual bool crosses( const QgsAbstractGeometry &geom, QString *errorMsg = 0 ) const = 0;
%Docstring
:rtype: bool
%End
virtual bool within( const QgsAbstractGeometry &geom, QString *errorMsg = 0 ) const = 0;
%Docstring
:rtype: bool
%End
virtual bool overlaps( const QgsAbstractGeometry &geom, QString *errorMsg = 0 ) const = 0;
%Docstring
:rtype: bool
%End
virtual bool contains( const QgsAbstractGeometry &geom, QString *errorMsg = 0 ) const = 0;
%Docstring
:rtype: bool
%End
virtual bool disjoint( const QgsAbstractGeometry &geom, QString *errorMsg = 0 ) const = 0;
%Docstring
:rtype: bool
%End
virtual QString relate( const QgsAbstractGeometry &geom, QString *errorMsg = 0 ) const = 0;
%Docstring
Returns the Dimensional Extended 9 Intersection Model (DE-9IM) representation of the
relationship between the geometries.
\param geom geometry to relate to
\param errorMsg destination storage for any error message
:return: DE-9IM string for relationship, or an empty string if an error occurred
.. versionadded:: 2.12
:rtype: str
%End
virtual bool relatePattern( const QgsAbstractGeometry &geom, const QString &pattern, QString *errorMsg = 0 ) const = 0;
%Docstring
Tests whether two geometries are related by a specified Dimensional Extended 9 Intersection Model (DE-9IM)
pattern.
\param geom geometry to relate to
\param pattern DE-9IM pattern for match
\param errorMsg destination storage for any error message
:return: true if geometry relationship matches with pattern
.. versionadded:: 2.14
:rtype: bool
%End
virtual double area( QString *errorMsg = 0 ) const = 0;
%Docstring
:rtype: float
%End
virtual double length( QString *errorMsg = 0 ) const = 0;
%Docstring
:rtype: float
%End
virtual bool isValid( QString *errorMsg = 0 ) const = 0;
%Docstring
:rtype: bool
%End
virtual bool isEqual( const QgsAbstractGeometry &geom, QString *errorMsg = 0 ) const = 0;
%Docstring
:rtype: bool
%End
virtual bool isEmpty( QString *errorMsg ) const = 0;
%Docstring
:rtype: bool
%End
virtual int splitGeometry( const QgsLineString &splitLine,
QList<QgsAbstractGeometry *> &newGeometries,
bool topological,
QgsPointSequence &topologyTestPoints, QString *errorMsg = 0 ) const;
%Docstring
:rtype: int
%End
virtual QgsAbstractGeometry *offsetCurve( double distance, int segments, int joinStyle, double mitreLimit, QString *errorMsg = 0 ) const = 0 /Factory/;
%Docstring
:rtype: QgsAbstractGeometry
%End
protected:
QgsGeometryEngine( const QgsAbstractGeometry *geometry );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/geometry/qgsgeometryengine.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/