qgssfcgalgeometry.h

Go to the documentation of this file.

/***************************************************************************
                         qgssfcgalGeometry.h
                         -------------------
    begin                : May 2025
    copyright            : (C) 2025 by Oslandia
    email                : benoit dot de dot mezzo at oslandia dot com
    email                : jean dot felder at oslandia dot com
    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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifdef WITH_SFCGAL
#ifndef QGSSGCGAL_GEOMETRY_H
#define QGSSGCGAL_GEOMETRY_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
SIP_IF_MODULE( HAVE_SFCGAL_SIP )
 
#include "qgsabstractgeometry.h"
#include "qgslinestring.h"
#include "qgsmatrix4x4.h"
#include "qgspoint.h"
#include "qgssfcgalengine.h"
 

class CORE_EXPORT QgsSfcgalGeometry
{
  public:
    QgsSfcgalGeometry();

    SIP_SKIP QgsSfcgalGeometry( sfcgal::shared_geom sfcgalGeom );

    QgsSfcgalGeometry( const QgsAbstractGeometry *qgsGeom ) SIP_THROW( QgsSfcgalException );

    QgsSfcgalGeometry( const QgsAbstractGeometry &qgsGeom ) SIP_THROW( QgsSfcgalException );

    QgsSfcgalGeometry( const QgsGeometry &qgsGeom ) SIP_THROW( QgsSfcgalException );

    QgsSfcgalGeometry( const QString &wkt ) SIP_THROW( QgsSfcgalException );

    QgsSfcgalGeometry( const QgsSfcgalGeometry &otherGeom ) SIP_THROW( QgsSfcgalException );

    QgsSfcgalGeometry &operator=( const QgsSfcgalGeometry &other ) = default;

    SIP_SKIP sfcgal::shared_geom sfcgalGeometry() const { return mSfcgalGeom; }

    std::unique_ptr<QgsAbstractGeometry> asQgisGeometry() const SIP_THROW( QgsSfcgalException );

    Qgis::WkbType wkbType() const SIP_THROW( QgsSfcgalException );
 
    // clang-format off
    QString geometryType() const SIP_THROW( QgsNotSupportedException, QgsSfcgalException ) SIP_HOLDGIL;
    // clang-format on

    std::unique_ptr<QgsSfcgalGeometry> clone() const;

    static std::unique_ptr<QgsSfcgalGeometry> fromWkb( const QgsConstWkbPtr &wkbPtr ) SIP_THROW( QgsSfcgalException );

    QByteArray asWkb( QgsAbstractGeometry::WkbFlags flags = QgsAbstractGeometry::WkbFlags() ) const SIP_THROW( QgsSfcgalException );

    static std::unique_ptr<QgsSfcgalGeometry> fromWkt( const QString &wkt ) SIP_THROW( QgsSfcgalException );

    QString asWkt( int precision = -1 ) const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> boundary() const SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    bool operator==( const QgsSfcgalGeometry &other ) const SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    bool operator!=( const QgsSfcgalGeometry &other ) const SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    bool fuzzyEqual( const QgsSfcgalGeometry &other, double epsilon ) const SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    int dimension() const SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    int partCount() const SIP_THROW( QgsSfcgalException );

    bool addZValue( double zValue = 0 ) SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    bool addMValue( double mValue = 0 ) SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    bool dropZValue() SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    bool dropMValue() SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    void swapXy() SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    bool isValid() const SIP_THROW( QgsSfcgalException );

    bool isEmpty() const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> geometryN( unsigned int index ) const SIP_THROW( QgsSfcgalException );

    double area( bool withDiscretization = false ) const SIP_THROW( QgsSfcgalException );

    double volume( bool withDiscretization = false ) const SIP_THROW( QgsSfcgalException );

    double length() const SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    bool isSimple() const SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    QgsPoint centroid() const SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> translate( const QgsVector3D &translation ) const SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> scale( const QgsVector3D &scaleFactor, const QgsPoint &center = QgsPoint() ) const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> rotate2D( double angle, const QgsPoint &center ) const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> rotate3D( double angle, const QgsVector3D &axisVector, const QgsPoint &center = QgsPoint() ) const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> transform( const QgsMatrix4x4 &mat ) const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> split3D( const QgsPoint &planePoint, const QgsVector3D &planeNormal, bool closeGeometries ) const SIP_THROW( QgsSfcgalException );

    bool intersects( const QgsAbstractGeometry *otherGeom ) const SIP_THROW( QgsSfcgalException );

    bool intersects( const QgsSfcgalGeometry &otherGeom ) const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> intersection( const QgsAbstractGeometry *otherGeom ) const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> intersection( const QgsSfcgalGeometry &otherGeom ) const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> combine( const QVector<QgsAbstractGeometry *> &geomList ) const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> difference( const QgsAbstractGeometry *otherGeom ) const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> difference( const QgsSfcgalGeometry &otherGeom ) const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> triangulate() const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> convexHull() const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> envelope() const SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    bool covers( const QgsSfcgalGeometry &otherGeom ) const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> buffer3D( double radius, int segments, Qgis::JoinStyle3D joinStyle3D ) const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> buffer2D( double radius, int segments, Qgis::JoinStyle joinStyle ) const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> simplify( double tolerance, bool preserveTopology ) const SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> extrude( const QgsVector3D &extrusion ) const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> approximateMedialAxis( bool extendToEdges = false ) const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> toSolid() const SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> toPolyhedralSurface() const SIP_THROW( QgsSfcgalException );
 
    // ============= PRIMITIVE

    SIP_SKIP QgsSfcgalGeometry( sfcgal::shared_prim sfcgalPrim, sfcgal::primitiveType type );

    static std::unique_ptr<QgsSfcgalGeometry> createBox( double sizeX, double sizeY, double sizeZ ) SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    static std::unique_ptr<QgsSfcgalGeometry> createCone( double bottomRadius, double height, double topRadius, unsigned int radial ) SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    static std::unique_ptr<QgsSfcgalGeometry> createCube( double size ) SIP_THROW( QgsSfcgalException );

    static std::unique_ptr<QgsSfcgalGeometry> createCylinder( double radius, double height, unsigned int radial ) SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    static std::unique_ptr<QgsSfcgalGeometry> createSphere( double radius, unsigned int subdivisions ) SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    static std::unique_ptr<QgsSfcgalGeometry> createTorus( double mainRadius, double tubeRadius, unsigned int mainRadial, unsigned int tubeRadial ) SIP_THROW( QgsNotSupportedException, QgsSfcgalException );

    QList<std::pair<QString, QString>> primitiveParameters() const SIP_THROW( QgsSfcgalException );

    QVariant primitiveParameter( const QString &name ) const SIP_THROW( QgsSfcgalException );

    void primitiveSetParameter( const QString &name, const QVariant &value ) SIP_THROW( QgsSfcgalException );

    std::unique_ptr<QgsSfcgalGeometry> primitiveAsPolyhedralSurface() const SIP_THROW( QgsSfcgalException );

    QgsMatrix4x4 primitiveTransform() const SIP_THROW( QgsSfcgalException );
 
  protected:

    void clearCache() const;
 
  private:
    sfcgal::shared_geom workingGeom() const;
 
    sfcgal::shared_geom mSfcgalGeom;
    bool mIsPrimitive = false;
 
#if SFCGAL_VERSION_NUM >= SFCGAL_MAKE_VERSION( 2, 3, 0 )
    void setPrimitiveTranslate( const QgsVector3D &translation );
    void setPrimitiveScale( const QgsVector3D &scaleFactor, const QgsPoint &center );
    void setPrimitiveRotation( double angle, const QgsVector3D &axisVector, const QgsPoint &center );
 
    sfcgal::shared_prim mSfcgalPrim;
    sfcgal::primitiveType mPrimType;
    QgsMatrix4x4 mPrimTransform;
#endif
};
 
 
#endif // QGSSGCGAL_GEOMETRY_H
#endif