qgsnurbscurve.h

Go to the documentation of this file.

/***************************************************************************
                         qgsnurbscurve.h
                         -----------------
    begin                : September 2025
    copyright            : (C) 2025 by Loïc Bartoletti
    email                : loic dot bartoletti at oslandia dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSNURBSCURVE_H
#define QGSNURBSCURVE_H
 
#include <float.h>
#include <memory>
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgscurve.h"
 
#include <QPolygonF>
#include <QString>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsNurbsCurve : public QgsCurve
{
  public:
    QgsNurbsCurve();

    QgsNurbsCurve( const QVector<QgsPoint> &controlPoints, int degree, const QVector<double> &knots, const QVector<double> &weights );
 
    QgsNurbsCurve *clone() const override SIP_FACTORY;
 
#ifndef SIP_RUN

    [[nodiscard]] QgsPoint evaluate( double t ) const;
#else

    SIP_PYOBJECT evaluate( double t ) const SIP_TYPEHINT( QgsPoint );
    % MethodCode
    if ( a0 < 0.0 || a0 > 1.0 )
    {
      PyErr_SetString( PyExc_ValueError, "Parameter t must be in range [0, 1]" );
      sipIsErr = 1;
    }
    else
    {
      sipRes = sipConvertFromType( new QgsPoint( sipCpp->evaluate( a0 ) ), sipType_QgsPoint, Py_None );
    }
    % End
#endif

    bool isBezier() const SIP_HOLDGIL;

    bool isBSpline() const SIP_HOLDGIL;

    bool isRational() const SIP_HOLDGIL;

    bool isPolyBezier() const SIP_HOLDGIL;
 
    bool isClosed() const override SIP_HOLDGIL;
    bool isClosed2D() const override SIP_HOLDGIL;
 
    // QgsCurve interface
    QgsLineString *curveToLine( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override SIP_FACTORY;
    void draw( QPainter &p ) const override;
    void drawAsPolygon( QPainter &p ) const override;
    QgsPoint endPoint() const override SIP_HOLDGIL;
    bool equals( const QgsCurve &other ) const override;
    int indexOf( const QgsPoint &point ) const override;
    QgsPoint *interpolatePoint( double distance ) const override SIP_FACTORY;
    int numPoints() const override SIP_HOLDGIL;
    bool pointAt( int node, QgsPoint &point SIP_OUT, Qgis::VertexType &type SIP_OUT ) const override;
    void points( QgsPointSequence &pts SIP_OUT ) const override;
    QgsCurve *reversed() const override SIP_FACTORY;
    void scroll( int firstVertexIndex ) override;
    std::tuple<std::unique_ptr<QgsCurve>, std::unique_ptr<QgsCurve>> splitCurveAtVertex( int index ) const override SIP_SKIP;
    QgsPoint startPoint() const override SIP_HOLDGIL;
    void sumUpArea( double &sum SIP_OUT ) const override;
    void sumUpArea3D( double &sum SIP_OUT ) const override;
    double xAt( int index ) const override;
    double yAt( int index ) const override;
    double zAt( int index ) const override;
    double mAt( int index ) const override;
 
    QPolygonF asQPolygonF() const override;
 
    void addToPainterPath( QPainterPath &path ) const override;
    QgsCurve *curveSubstring( double startDistance, double endDistance ) const override SIP_FACTORY;
    double length() const override SIP_HOLDGIL;
    double segmentLength( QgsVertexId startVertex ) const override;
    double distanceBetweenVertices( QgsVertexId fromVertex, QgsVertexId toVertex ) const override;
    QgsAbstractGeometry *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0, bool removeRedundantPoints = false ) const override SIP_FACTORY;
    QgsAbstractGeometry *simplifyByDistance( double tolerance ) const override SIP_FACTORY;
    bool removeDuplicateNodes( double epsilon = 4 * std::numeric_limits<double>::epsilon(), bool useZValues = false ) override;
    double vertexAngle( QgsVertexId vertex ) const override;
    void swapXy() override;
    bool transform( QgsAbstractGeometryTransformer *transformer, QgsFeedback *feedback = nullptr ) override;
    QgsAbstractGeometry *createEmptyWithSameType() const override SIP_FACTORY;
    double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt SIP_OUT, QgsVertexId &vertexAfter SIP_OUT, int *leftOf SIP_OUT = nullptr, double epsilon = 4 * std::numeric_limits<double>::epsilon() ) const override;
    void transform( const QgsCoordinateTransform &ct, Qgis::TransformDirection d = Qgis::TransformDirection::Forward, bool transformZ = false ) override SIP_THROW( QgsCsException );
    void transform( const QTransform &t, double zTranslate = 0.0, double zScale = 1.0, double mTranslate = 0.0, double mScale = 1.0 ) override;
    QgsRectangle boundingBox() const override;
    QgsBox3D boundingBox3D() const override;
    bool moveVertex( QgsVertexId position, const QgsPoint &newPos ) override;
    bool insertVertex( QgsVertexId position, const QgsPoint &vertex ) override;
    int wkbSize( QgsAbstractGeometry::WkbFlags flags = QgsAbstractGeometry::WkbFlags() ) const override;
    QByteArray asWkb( QgsAbstractGeometry::WkbFlags flags = QgsAbstractGeometry::WkbFlags() ) const override;
    QString asWkt( int precision = 17 ) const override;
    QDomElement asGml2( QDomDocument &doc, int precision = 17, const QString &ns = "gml", QgsAbstractGeometry::AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const override;
    QDomElement asGml3( QDomDocument &doc, int precision = 17, const QString &ns = "gml", QgsAbstractGeometry::AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const override;
    json asJsonObject( int precision = 17 ) const override SIP_SKIP;
    QString asKml( int precision = 17 ) const override;
    int dimension() const override SIP_HOLDGIL;
    bool isEmpty() const override SIP_HOLDGIL;
    void clear() override;
    bool boundingBoxIntersects( const QgsRectangle &rectangle ) const override SIP_HOLDGIL;
    bool boundingBoxIntersects( const QgsBox3D &box3d ) const override SIP_HOLDGIL;
    QgsPoint centroid() const override;
 
    // QgsAbstractGeometry interface
    bool addZValue( double zValue = 0 ) override;
    bool addMValue( double mValue = 0 ) override;
    bool dropZValue() override;
    bool dropMValue() override;
    bool deleteVertex( QgsVertexId position ) override;
#ifndef SIP_RUN
    void filterVertices( const std::function<bool( const QgsPoint & )> &filter ) override;
#endif
    bool fromWkb( QgsConstWkbPtr &wkb ) override;
    bool fromWkt( const QString &wkt ) override;
    bool fuzzyEqual( const QgsAbstractGeometry &other, double epsilon = 1e-8 ) const override SIP_HOLDGIL;
    bool fuzzyDistanceEqual( const QgsAbstractGeometry &other, double epsilon = 1e-8 ) const override SIP_HOLDGIL;
    QString geometryType() const override SIP_HOLDGIL;
    bool hasCurvedSegments() const override SIP_HOLDGIL;
    int partCount() const override SIP_HOLDGIL;
    QgsCurve *toCurveType() const override;
    QgsPoint vertexAt( QgsVertexId id ) const override;
    int vertexCount( int part = 0, int ring = 0 ) const override SIP_HOLDGIL;
    int vertexNumberFromVertexId( QgsVertexId id ) const override;
    bool isValid( QString &error SIP_OUT, Qgis::GeometryValidityFlags flags = Qgis::GeometryValidityFlags() ) const override;

    int degree() const SIP_HOLDGIL { return mDegree; }

    void setDegree( int degree )
    {
      mDegree = degree;
      clearCache();
    }

    QVector<QgsPoint> controlPoints() const SIP_HOLDGIL { return mControlPoints; }

    void setControlPoints( const QVector<QgsPoint> &points )
    {
      mControlPoints = points;
      clearCache();
    }

    QVector<double> knots() const SIP_HOLDGIL { return mKnots; }

    void setKnots( const QVector<double> &knots )
    {
      mKnots = knots;
      clearCache();
    }

    QVector<double> weights() const SIP_HOLDGIL { return mWeights; }

    void setWeights( const QVector<double> &weights )
    {
      mWeights = weights;
      clearCache();
    }
 
#ifndef SIP_RUN

    double weight( int index ) const SIP_HOLDGIL;

    bool setWeight( int index, double weight );
#else

    double weight( int index ) const SIP_HOLDGIL;
    % MethodCode
    const int count = sipCpp->controlPoints().size();
    if ( a0 < 0 || a0 >= count )
    {
      PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    else
    {
      sipRes = sipCpp->weight( a0 );
    }
    % End

    void setWeight( int index, double weight );
    % MethodCode
    const int count = sipCpp->controlPoints().size();
    if ( a0 < 0 || a0 >= count )
    {
      PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    else if ( a1 <= 0 )
    {
      PyErr_SetString( PyExc_ValueError, "Weight must be positive (> 0)" );
      sipIsErr = 1;
    }
    else
    {
      sipCpp->setWeight( a0, a1 );
    }
    % End
#endif

    static QVector<double> generateUniformKnots( int numControlPoints, int degree );

    inline static const QgsNurbsCurve *cast( const QgsAbstractGeometry *geom ) SIP_SKIP // cppcheck-suppress duplInheritedMember
    {
      if ( geom && geom->geometryType() == "NurbsCurve"_L1 )
        return static_cast<const QgsNurbsCurve *>( geom );
      return nullptr;
    }

    inline static QgsNurbsCurve *cast( QgsAbstractGeometry *geom ) SIP_SKIP // cppcheck-suppress duplInheritedMember
    {
      if ( geom && geom->geometryType() == "NurbsCurve"_L1 )
        return static_cast<QgsNurbsCurve *>( geom );
      return nullptr;
    }
 
  protected:
    void clearCache() const override;
    int compareToSameClass( const QgsAbstractGeometry *other ) const final;
    QgsBox3D calculateBoundingBox3D() const override;
 
  private:
    void generateUniformKnots();
 
    QVector<QgsPoint> mControlPoints;       
    QVector<double> mKnots;                 
    QVector<double> mWeights;               
    int mDegree = 0;                        
    mutable bool mValidityComputed = false; 
    mutable bool mIsValid = false;          
};
 
#endif // QGSNURBSCURVE_H