qgscurve.h

Go to the documentation of this file.

/***************************************************************************
                         qgscurve.h
                         ------------
    begin                : September 2014
    copyright            : (C) 2014 by Marco Hugentobler
    email                : marco at sourcepole dot ch
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSCURVE_H
#define QGSCURVE_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsabstractgeometry.h"
#include "qgsbox3d.h"
 
#include <QPainterPath>
 
class QgsLineString;

class CORE_EXPORT QgsCurve : public QgsAbstractGeometry SIP_ABSTRACT
{
  public:
    QgsCurve() = default;

    virtual bool equals( const QgsCurve &other ) const = 0;
 
    bool operator==( const QgsAbstractGeometry &other ) const override;
    bool operator!=( const QgsAbstractGeometry &other ) const override;
 
    QgsCurve *clone() const override = 0 SIP_FACTORY;

    virtual QgsPoint startPoint() const = 0;

    virtual QgsPoint endPoint() const = 0;
 
    // clang-format off
    virtual bool isClosed() const SIP_HOLDGIL;
    // clang-format on

    virtual bool isClosed2D() const SIP_HOLDGIL;

    virtual bool isRing() const SIP_HOLDGIL;

    virtual QgsLineString *curveToLine( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const = 0 SIP_FACTORY;

    virtual void addToPainterPath( QPainterPath &path ) const = 0;
    QPainterPath asQPainterPath() const override;

    virtual void drawAsPolygon( QPainter &p ) const = 0;

    virtual void points( QgsPointSequence &pt SIP_OUT ) const = 0;

    virtual int numPoints() const = 0;
 
#ifdef SIP_RUN
// clang-format off
    int __len__() const;
    % Docstring
    Returns the number of points in the curve.
    % End
    % MethodCode
    sipRes = sipCpp->numPoints();
    % End

    int __bool__() const;
    % MethodCode
    sipRes = true;
    % End
// clang-format on
#endif

    virtual void sumUpArea( double &sum SIP_OUT ) const = 0;

    virtual void sumUpArea3D( double &sum SIP_OUT ) const = 0;
 
    QgsCoordinateSequence coordinateSequence() const override;
    bool nextVertex( QgsVertexId &id, QgsPoint &vertex SIP_OUT ) const override;
    void adjacentVertices( QgsVertexId vertex, QgsVertexId &previousVertex SIP_OUT, QgsVertexId &nextVertex SIP_OUT ) const override;
    int vertexNumberFromVertexId( QgsVertexId id ) const override;

    virtual bool pointAt( int node, QgsPoint &point SIP_OUT, Qgis::VertexType &type SIP_OUT ) const = 0;

    virtual int indexOf( const QgsPoint &point ) const = 0;

    virtual QgsCurve *reversed() const = 0 SIP_FACTORY;
 
    QgsAbstractGeometry *boundary() const override SIP_FACTORY;
 
    QString asKml( int precision = 17 ) const override;

    QgsCurve *segmentize( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override SIP_FACTORY;
 
    int vertexCount( int part = 0, int ring = 0 ) const override;
    int ringCount( int part = 0 ) const override;
    int partCount() const override;
    QgsPoint vertexAt( QgsVertexId id ) const override;
    bool hasVertex( QgsVertexId position ) const override;
    QgsCurve *toCurveType() const override SIP_FACTORY;
    void normalize() final SIP_HOLDGIL;
 
    QgsBox3D boundingBox3D() const override;
    bool isValid( QString &error SIP_OUT, Qgis::GeometryValidityFlags flags = Qgis::GeometryValidityFlags() ) const override;

    virtual double xAt( int index ) const = 0;

    virtual double yAt( int index ) const = 0;

    virtual double zAt( int index ) const = 0;

    virtual double mAt( int index ) const = 0;

    virtual QPolygonF asQPolygonF() const;

    virtual QgsPoint *interpolatePoint( double distance ) const = 0 SIP_FACTORY;

    virtual QgsCurve *curveSubstring( double startDistance, double endDistance ) const = 0 SIP_FACTORY;

    double straightDistance2d() const;

    double sinuosity() const;

    Qgis::AngularDirection orientation() const;

    virtual void scroll( int firstVertexIndex ) = 0;

    virtual double distanceBetweenVertices( QgsVertexId fromVertex, QgsVertexId toVertex ) const = 0;
 
#ifndef SIP_RUN

    inline static const QgsCurve *cast( const QgsAbstractGeometry *geom )
    {
      if ( !geom )
        return nullptr;
 
      const Qgis::WkbType type = geom->wkbType();
      if ( QgsWkbTypes::geometryType( type ) == Qgis::GeometryType::Line && QgsWkbTypes::isSingleType( type ) )
      {
        return static_cast<const QgsCurve *>( geom );
      }
      return nullptr;
    }

    inline static QgsCurve *cast( QgsAbstractGeometry *geom )
    {
      if ( !geom )
        return nullptr;
 
      const Qgis::WkbType type = geom->wkbType();
      if ( QgsWkbTypes::geometryType( type ) == Qgis::GeometryType::Line && QgsWkbTypes::isSingleType( type ) )
      {
        return static_cast<QgsCurve *>( geom );
      }
      return nullptr;
    }

    virtual std::tuple< std::unique_ptr< QgsCurve >, std::unique_ptr< QgsCurve > > splitCurveAtVertex( int index ) const = 0;
 
#endif
 
 
  protected:
 
    void clearCache() const override;
 
    int childCount() const override;
    QgsPoint childPoint( int index ) const override;
#ifndef SIP_RUN

    bool snapToGridPrivate( double hSpacing, double vSpacing, double dSpacing, double mSpacing,
                            const QVector<double> &srcX, const QVector<double> &srcY, const QVector<double> &srcZ, const QVector<double> &srcM,
                            QVector<double> &outX, QVector<double> &outY, QVector<double> &outZ, QVector<double> &outM,
                            bool removeRedundantPoints ) const;
#endif

    mutable QgsBox3D mBoundingBox;
 
    mutable bool mHasCachedSummedUpArea = false;
    mutable double mSummedUpArea = 0;
    mutable bool mHasCachedSummedUpArea3D = false;
    mutable double mSummedUpArea3D = 0;
 
  private:
 
    mutable bool mHasCachedValidity = false;
    mutable QString mValidityFailureReason;
 
    friend class TestQgsGeometry;
};
 
#endif // QGSCURVE_H