chore(qgssfcgalgeometry): Improve not supported comment

It is not possible to compile QGIS with SFCGAL 1.X
This commit is contained in:
Jean Felder 2025-09-04 09:06:41 +02:00 committed by Nyall Dawson
parent b5b26d2583
commit d52606061c
3 changed files with 47 additions and 77 deletions

View File

@ -121,8 +121,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
std::unique_ptr<QgsSfcgalGeometry> clone() const;
@ -201,8 +200,7 @@ the geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
bool operator==( const QgsSfcgalGeometry &other ) const;
@ -224,8 +222,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
int dimension() const;
@ -241,8 +238,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
int partCount() const;
@ -277,8 +273,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
bool addMValue( double mValue = 0 );
@ -296,8 +291,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
bool dropZValue();
@ -312,8 +306,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
bool dropMValue();
@ -328,8 +321,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
void swapXy();
@ -342,8 +334,7 @@ If an error was encountered during the operation, more information can
be retrieved by calling :py:func:`~QgsSfcgalGeometry.lastError` on the
geometry.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
bool isValid() const;
@ -390,8 +381,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
bool isSimple() const;
@ -408,8 +398,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
QgsPoint centroid() const;
@ -424,8 +413,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
std::unique_ptr<QgsSfcgalGeometry> translate( const QgsVector3D &translation ) const;
@ -442,8 +430,7 @@ returned geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
std::unique_ptr<QgsSfcgalGeometry> scale( const QgsVector3D &scaleFactor, const QgsPoint &center = QgsPoint() ) const;
@ -617,8 +604,7 @@ returned geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
bool covers( const QgsSfcgalGeometry &otherGeom ) const;
@ -688,8 +674,7 @@ returned geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
std::unique_ptr<QgsSfcgalGeometry> extrude( const QgsVector3D &extrusion ) const;

View File

@ -121,8 +121,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
std::unique_ptr<QgsSfcgalGeometry> clone() const;
@ -201,8 +200,7 @@ the geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
bool operator==( const QgsSfcgalGeometry &other ) const throw( QgsNotSupportedException );
@ -224,8 +222,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
int dimension() const throw( QgsNotSupportedException );
@ -241,8 +238,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
int partCount() const;
@ -277,8 +273,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
bool addMValue( double mValue = 0 ) throw( QgsNotSupportedException );
@ -296,8 +291,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
bool dropZValue() throw( QgsNotSupportedException );
@ -312,8 +306,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
bool dropMValue() throw( QgsNotSupportedException );
@ -328,8 +321,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
void swapXy() throw( QgsNotSupportedException );
@ -342,8 +334,7 @@ If an error was encountered during the operation, more information can
be retrieved by calling :py:func:`~QgsSfcgalGeometry.lastError` on the
geometry.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
bool isValid() const;
@ -390,8 +381,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
bool isSimple() const throw( QgsNotSupportedException );
@ -408,8 +398,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
QgsPoint centroid() const throw( QgsNotSupportedException );
@ -424,8 +413,7 @@ geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
std::unique_ptr<QgsSfcgalGeometry> translate( const QgsVector3D &translation ) const throw( QgsNotSupportedException );
@ -442,8 +430,7 @@ returned geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
std::unique_ptr<QgsSfcgalGeometry> scale( const QgsVector3D &scaleFactor, const QgsPoint &center = QgsPoint() ) const;
@ -617,8 +604,7 @@ returned geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
bool covers( const QgsSfcgalGeometry &otherGeom ) const;
@ -688,8 +674,7 @@ returned geometry.
This method requires a QGIS build based on SFCGAL 2.1 or later.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0 or
earlier.
:raises QgsNotSupportedException: on QGIS builds based on SFCGAL 2.0.
%End
std::unique_ptr<QgsSfcgalGeometry> extrude( const QgsVector3D &extrusion ) const;

View File

@ -135,7 +135,7 @@ class CORE_EXPORT QgsSfcgalGeometry
*
* This method requires a QGIS build based on SFCGAL 2.1 or later.
*
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0 or earlier.
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0.
*/
QString geometryType() const SIP_THROW( QgsNotSupportedException ) SIP_HOLDGIL;
@ -196,7 +196,7 @@ class CORE_EXPORT QgsSfcgalGeometry
*
* This method requires a QGIS build based on SFCGAL 2.1 or later.
*
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0 or earlier.
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0.
*/
std::unique_ptr<QgsSfcgalGeometry> boundary() const SIP_THROW( QgsNotSupportedException );
@ -206,7 +206,7 @@ class CORE_EXPORT QgsSfcgalGeometry
*
* This operator requires a QGIS build based on SFCGAL 2.1 or later.
*
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0 or earlier.
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0.
*/
bool operator==( const QgsSfcgalGeometry &other ) const SIP_THROW( QgsNotSupportedException );
@ -216,7 +216,7 @@ class CORE_EXPORT QgsSfcgalGeometry
*
* This operator requires a QGIS build based on SFCGAL 2.1 or later.
*
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0 or earlier.
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0.
*/
bool operator!=( const QgsSfcgalGeometry &other ) const SIP_THROW( QgsNotSupportedException );
@ -231,7 +231,7 @@ class CORE_EXPORT QgsSfcgalGeometry
*
* This method requires a QGIS build based on SFCGAL 2.1 or later.
*
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0 or earlier.
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0.
*/
bool fuzzyEqual( const QgsSfcgalGeometry &other, double epsilon ) const SIP_THROW( QgsNotSupportedException );
@ -245,7 +245,7 @@ class CORE_EXPORT QgsSfcgalGeometry
*
* This method requires a QGIS build based on SFCGAL 2.1 or later.
*
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0 or earlier.
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0.
*/
int dimension() const SIP_THROW( QgsNotSupportedException );
@ -273,7 +273,7 @@ class CORE_EXPORT QgsSfcgalGeometry
*
* This method requires a QGIS build based on SFCGAL 2.1 or later.
*
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0 or earlier.
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0.
*/
bool addZValue( double zValue = 0 ) SIP_THROW( QgsNotSupportedException );
@ -287,7 +287,7 @@ class CORE_EXPORT QgsSfcgalGeometry
*
* This method requires a QGIS build based on SFCGAL 2.1 or later.
*
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0 or earlier.
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0.
*/
bool addMValue( double mValue = 0 ) SIP_THROW( QgsNotSupportedException );
@ -300,7 +300,7 @@ class CORE_EXPORT QgsSfcgalGeometry
*
* This method requires a QGIS build based on SFCGAL 2.1 or later.
*
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0 or earlier.
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0.
*/
bool dropZValue() SIP_THROW( QgsNotSupportedException );
@ -313,7 +313,7 @@ class CORE_EXPORT QgsSfcgalGeometry
*
* This method requires a QGIS build based on SFCGAL 2.1 or later.
*
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0 or earlier.
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0.
*/
bool dropMValue() SIP_THROW( QgsNotSupportedException );
@ -325,7 +325,7 @@ class CORE_EXPORT QgsSfcgalGeometry
* If an error was encountered during the operation, more information can be retrieved
* by calling lastError() on the geometry.
*
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0 or earlier.
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0.
*/
void swapXy() SIP_THROW( QgsNotSupportedException );
@ -368,7 +368,7 @@ class CORE_EXPORT QgsSfcgalGeometry
*
* This method requires a QGIS build based on SFCGAL 2.1 or later.
*
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0 or earlier.
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0.
*/
double length() const SIP_THROW( QgsNotSupportedException );
@ -384,7 +384,7 @@ class CORE_EXPORT QgsSfcgalGeometry
*
* This method requires a QGIS build based on SFCGAL 2.1 or later.
*
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0 or earlier.
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0.
*/
bool isSimple() const SIP_THROW( QgsNotSupportedException );
@ -398,7 +398,7 @@ class CORE_EXPORT QgsSfcgalGeometry
*
* This method requires a QGIS build based on SFCGAL 2.1 or later.
*
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0 or earlier.
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0.
*/
QgsPoint centroid() const SIP_THROW( QgsNotSupportedException );
@ -413,7 +413,7 @@ class CORE_EXPORT QgsSfcgalGeometry
*
* This method requires a QGIS build based on SFCGAL 2.1 or later.
*
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0 or earlier.
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0.
*/
std::unique_ptr<QgsSfcgalGeometry> translate( const QgsVector3D &translation ) const SIP_THROW( QgsNotSupportedException );
@ -570,7 +570,7 @@ class CORE_EXPORT QgsSfcgalGeometry
*
* This method requires a QGIS build based on SFCGAL 2.1 or later.
*
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0 or earlier.
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0.
*/
std::unique_ptr<QgsSfcgalGeometry> envelope() const SIP_THROW( QgsNotSupportedException );
@ -633,7 +633,7 @@ class CORE_EXPORT QgsSfcgalGeometry
*
* This method requires a QGIS build based on SFCGAL 2.1 or later.
*
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0 or earlier.
* \throws QgsNotSupportedException on QGIS builds based on SFCGAL 2.0.
*/
std::unique_ptr<QgsSfcgalGeometry> simplify( double tolerance, bool preserveTopology ) const SIP_THROW( QgsNotSupportedException );