qgssfcgalengine.h

Go to the documentation of this file.

/***************************************************************************
                        qgssfcgalengine.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 QGSSFCGALENGINE_H
#define QGSSFCGALENGINE_H
 
 
#include <SFCGAL/capi/sfcgal_c.h>
#include <source_location>
 
#include "qgis_core.h"
#include "qgsexception.h"
#include "qgsgeometry.h"
#include "qgslogger.h"
#include "qgspoint.h"
#include "qgsvector3d.h"
 
#include <QMatrix4x4>
 
#define SIP_NO_FILE
 
class QgsGeometry;
class QgsSfcgalGeometry;

#ifndef SFCGAL_MAKE_VERSION
#define SFCGAL_MAKE_VERSION( major, minor, patch ) ( ( major ) * 10000 + ( minor ) * 100 + ( patch ) )
#endif
#ifndef SFCGAL_VERSION_NUM
#define SFCGAL_VERSION_NUM SFCGAL_MAKE_VERSION( SFCGAL_VERSION_MAJOR_INT, SFCGAL_VERSION_MINOR_INT, SFCGAL_VERSION_PATCH_INT )
#endif

#define CHECK_NOT_NULL( ptr, defaultObj )                                              \
  if ( !( ptr ) )                                                                      \
  {                                                                                    \
    sfcgal::errorHandler()->addText( QString( "Null pointer for '%1'" ).arg( #ptr ) ); \
    return ( defaultObj );                                                             \
  }

#define CHECK_SUCCESS( errorMsg, defaultObj )                       \
  if ( !sfcgal::errorHandler()->hasSucceedOrStack( ( errorMsg ) ) ) \
  {                                                                 \
    return ( defaultObj );                                          \
  }

#define CHECK_SUCCESS_LOG( errorMsg, defaultObj )                   \
  if ( !sfcgal::errorHandler()->hasSucceedOrStack( ( errorMsg ) ) ) \
  {                                                                 \
    QgsDebugError( sfcgal::errorHandler()->getFullText() );         \
    return ( defaultObj );                                          \
  }

#define THROW_ON_ERROR( errorMsg )                                     \
  if ( !sfcgal::errorHandler()->hasSucceedOrStack( ( errorMsg ) ) )    \
  {                                                                    \
    QgsDebugError( sfcgal::errorHandler()->getFullText() );            \
    throw QgsSfcgalException( sfcgal::errorHandler()->getFullText() ); \
  }
 

namespace sfcgal
{
  // ==== SFCGAL geometry
  using geometry = sfcgal_geometry_t;

  struct GeometryDeleter
  {
      void CORE_EXPORT operator()( geometry *geom ) const;
  };

  using unique_geom = std::unique_ptr< geometry, GeometryDeleter >;
  using shared_geom = std::shared_ptr< geometry >; // NO DELETER ==> added with function make_shared_geom!!!!!

  shared_geom make_shared_geom( geometry *geom );
} // namespace sfcgal
 
namespace sfcgal
{
  // ==== SFCGAL primitive
#if SFCGAL_VERSION_NUM >= SFCGAL_MAKE_VERSION( 2, 3, 0 )
  using primitive = sfcgal_primitive_t;
  using primitiveType = sfcgal_primitive_type_t;
#else
  using primitive = int;
  using primitiveType = int;
#endif

  struct PrimitiveDeleter
  {
      void CORE_EXPORT operator()( primitive *prim ) const;
  };

  using unique_prim = std::unique_ptr< primitive, PrimitiveDeleter >;
  using shared_prim = std::shared_ptr< primitive >; // NO DELETER ==> added with function make_shared_prim!!!!!

  shared_prim make_shared_prim( primitive *prim );

  struct PrimitiveParameterDesc
  {
      std::string name;
      std::string type;
      std::variant<int, double, QgsPoint, QgsVector3D> value;
  };

  void to_json( json &j, const PrimitiveParameterDesc &p );

  void from_json( const json &j, PrimitiveParameterDesc &p );
} // namespace sfcgal
 
namespace sfcgal
{
  // ==== SFCGAL errors
  int errorCallback( const char *, ... );

  int warningCallback( const char *, ... );

  class CORE_EXPORT ErrorHandler
  {
    public:
      ErrorHandler();

      bool hasSucceedOrStack( QString *errorMsg = nullptr, const std::source_location &location = std::source_location::current() );

      void clearText( QString *errorMsg = nullptr );

      bool isTextEmpty() const;

      QString getMainText() const;

      QString getFullText() const;

      void addText( const QString &msg, const std::source_location &location = std::source_location::current() );
 
    private:
      QStringList errorMessages;
  };

  CORE_EXPORT ErrorHandler *errorHandler();

  using func_geomgeom_to_geom = sfcgal_geometry_t *( * ) ( const sfcgal_geometry_t *, const sfcgal_geometry_t * );
  using func_geom_to_geom = sfcgal_geometry_t *( * ) ( const sfcgal_geometry_t * );
} // namespace sfcgal

class CORE_EXPORT QgsSfcgalEngine
{
  public:
    static std::unique_ptr< QgsAbstractGeometry > toAbstractGeometry( const sfcgal::geometry *geom, QString *errorMsg = nullptr );

    static std::unique_ptr< QgsSfcgalGeometry > toSfcgalGeometry( sfcgal::shared_geom &geom, QString *errorMsg = nullptr );

    static sfcgal::shared_geom fromAbstractGeometry( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr );

    static sfcgal::shared_geom cloneGeometry( const sfcgal::geometry *geom, QString *errorMsg = nullptr );

    static QString geometryType( const sfcgal::geometry *geom, QString *errorMsg = nullptr );

    static sfcgal::shared_geom fromWkb( const QgsConstWkbPtr &wkbPtr, QString *errorMsg = nullptr );

    static sfcgal::shared_geom fromWkt( const QString &wkt, QString *errorMsg = nullptr );

    static QByteArray toWkb( const sfcgal::geometry *geom, QString *errorMsg = nullptr );

    static QString toWkt( const sfcgal::geometry *geom, int numDecimals = -1, QString *errorMsg = nullptr );

    static Qgis::WkbType wkbType( const sfcgal::geometry *geom, QString *errorMsg = nullptr );

    static int dimension( const sfcgal::geometry *geom, QString *errorMsg = nullptr );

    static int partCount( const sfcgal::geometry *geom, QString *errorMsg );

    static bool addZValue( sfcgal::geometry *geom, double zValue = 0, QString *errorMsg = nullptr );

    static bool addMValue( sfcgal::geometry *geom, double mValue = 0, QString *errorMsg = nullptr );

    static bool dropZValue( sfcgal::geometry *geom, QString *errorMsg = nullptr );

    static bool dropMValue( sfcgal::geometry *geom, QString *errorMsg = nullptr );

    static void swapXy( sfcgal::geometry *geom, QString *errorMsg = nullptr );

    static bool isEqual( const sfcgal::geometry *geomA, const sfcgal::geometry *geomB, double tolerance = -1.0, QString *errorMsg = nullptr );

    static bool isEmpty( const sfcgal::geometry *geom, QString *errorMsg = nullptr );

    static bool isValid( const sfcgal::geometry *geom, QString *errorMsg = nullptr, QgsGeometry *errorLoc = nullptr );

    static bool isSimple( const sfcgal::geometry *geom, QString *errorMsg = nullptr );

    static sfcgal::shared_geom boundary( const sfcgal::geometry *geom, QString *errorMsg = nullptr );

    static QgsPoint centroid( const sfcgal::geometry *geom, QString *errorMsg = nullptr );

    static sfcgal::shared_geom translate( const sfcgal::geometry *geom, const QgsVector3D &translation, QString *errorMsg = nullptr );

    static sfcgal::shared_geom scale( const sfcgal::geometry *geom, const QgsVector3D &scaleFactor, const QgsPoint &center = QgsPoint(), QString *errorMsg = nullptr );

    static sfcgal::shared_geom rotate2D( const sfcgal::geometry *geom, double angle, const QgsPoint &center, QString *errorMsg = nullptr );

    static sfcgal::shared_geom rotate3D( const sfcgal::geometry *geom, double angle, const QgsVector3D &axisVector, const QgsPoint &center = QgsPoint(), QString *errorMsg = nullptr );

    static double distance( const sfcgal::geometry *geomA, const sfcgal::geometry *geomB, QString *errorMsg = nullptr );

    static bool distanceWithin( const sfcgal::geometry *geomA, const sfcgal::geometry *geomB, double maxdistance, QString *errorMsg );

    static double area( const sfcgal::geometry *geom, QString *errorMsg = nullptr );

    static double length( const sfcgal::geometry *geom, QString *errorMsg = nullptr );

    static bool intersects( const sfcgal::geometry *geomA, const sfcgal::geometry *geomB, QString *errorMsg = nullptr );

    static sfcgal::shared_geom intersection( const sfcgal::geometry *geomA, const sfcgal::geometry *geomB, QString *errorMsg = nullptr );

    static sfcgal::shared_geom difference( const sfcgal::geometry *geomA, const sfcgal::geometry *geomB, QString *errorMsg = nullptr );

    static sfcgal::shared_geom combine( const QVector< sfcgal::shared_geom > &geomList, QString *errorMsg = nullptr );

    static sfcgal::shared_geom triangulate( const sfcgal::geometry *geom, QString *errorMsg = nullptr );

    static bool covers( const sfcgal::geometry *geomA, const sfcgal::geometry *geomB, QString *errorMsg = nullptr );

    static sfcgal::shared_geom convexHull( const sfcgal::geometry *geom, QString *errorMsg = nullptr );

    static sfcgal::shared_geom envelope( const sfcgal::geometry *geom, QString *errorMsg = nullptr );

    static sfcgal::shared_geom offsetCurve( const sfcgal::geometry *geom, double distance, int segments, Qgis::JoinStyle joinStyle, QString *errorMsg = nullptr );

    static sfcgal::shared_geom buffer3D( const sfcgal::geometry *geom, double radius, int segments, Qgis::JoinStyle3D joinStyle3D, QString *errorMsg = nullptr );

    static sfcgal::shared_geom buffer2D( const sfcgal::geometry *geom, double radius, int segments, Qgis::JoinStyle joinStyle, QString *errorMsg = nullptr );

    static sfcgal::shared_geom extrude( const sfcgal::geometry *geom, const QgsVector3D &extrusion, QString *errorMsg = nullptr );

    static sfcgal::shared_geom simplify( const sfcgal::geometry *geom, double tolerance, bool preserveTopology, QString *errorMsg = nullptr );

    static sfcgal::shared_geom approximateMedialAxis( const sfcgal::geometry *geom, QString *errorMsg = nullptr );
 
#if SFCGAL_VERSION_NUM >= SFCGAL_MAKE_VERSION( 2, 3, 0 )

    static sfcgal::shared_geom transform( const sfcgal::geometry *geom, const QMatrix4x4 &mat, QString *errorMsg = nullptr );

    static std::unique_ptr< QgsSfcgalGeometry > toSfcgalGeometry( sfcgal::shared_prim &prim, sfcgal::primitiveType type, QString *errorMsg = nullptr );

    static sfcgal::shared_prim createCube( double size, QString *errorMsg = nullptr );

    static sfcgal::shared_prim primitiveClone( const sfcgal::primitive *prim, QString *errorMsg = nullptr );

    static sfcgal::shared_geom primitiveAsPolyhedral( const sfcgal::primitive *prim, const QMatrix4x4 &mat = QMatrix4x4(), QString *errorMsg = nullptr );

    static bool primitiveIsEqual( const sfcgal::primitive *primA, const sfcgal::primitive *primB, double tolerance = -1.0, QString *errorMsg = nullptr );

    static double primitiveArea( const sfcgal::primitive *prim, bool withDiscretization = false, QString *errorMsg = nullptr );

    static double primitiveVolume( const sfcgal::primitive *prim, bool withDiscretization = false, QString *errorMsg = nullptr );

    static QVector<sfcgal::PrimitiveParameterDesc> primitiveParameters( const sfcgal::primitive *prim, QString *errorMsg = nullptr );

    static QVariant primitiveParameter( const sfcgal::primitive *prim, const QString &name, QString *errorMsg = nullptr );

    static void primitiveSetParameter( sfcgal::primitive *prim, const QString &name, const QVariant &value, QString *errorMsg = nullptr );
 
#endif
};

 
 
class SFCGALException : public std::runtime_error
{
  public:
    explicit SFCGALException( const QString &message )
      : std::runtime_error( message.toUtf8().constData() )
    {}
};

 
#endif // QGSSFCGALENGINE_H
#endif