qgsquadrilateral.h

Go to the documentation of this file.

/***************************************************************************
                         qgsquadrilateral.h
                         -------------------
    begin                : November 2018
    copyright            : (C) 2018 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 QGSQUADRILATERAL_H
#define QGSQUADRILATERAL_H
 
 
#include "qgis_core.h"
#include "qgslinestring.h"
#include "qgspoint.h"
#include "qgspolygon.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsQuadrilateral
{
  public:
    // clang-format off
    QgsQuadrilateral() SIP_HOLDGIL;
    // clang-format on

    QgsQuadrilateral( const QgsPoint &p1, const QgsPoint &p2, const QgsPoint &p3, const QgsPoint &p4 ) SIP_HOLDGIL;

    explicit QgsQuadrilateral( const QgsPointXY &p1, const QgsPointXY &p2, const QgsPointXY &p3, const QgsPointXY &p4 ) SIP_HOLDGIL;
 

    enum ConstructionOption
    {
      Distance, 
      Projected, 
    };

    static QgsQuadrilateral rectangleFrom3Points( const QgsPoint &p1, const QgsPoint &p2, const QgsPoint &p3, ConstructionOption mode ) SIP_HOLDGIL;

    static QgsQuadrilateral rectangleFromExtent( const QgsPoint &p1, const QgsPoint &p2 ) SIP_HOLDGIL;
 
#ifndef SIP_RUN

    static constexpr auto &rectangleFromDiagonal = rectangleFromExtent;
#endif

    static QgsQuadrilateral squareFromDiagonal( const QgsPoint &p1, const QgsPoint &p2 ) SIP_HOLDGIL;

    static QgsQuadrilateral rectangleFromCenterPoint( const QgsPoint &center, const QgsPoint &point ) SIP_HOLDGIL;

    static QgsQuadrilateral fromRectangle( const QgsRectangle &rectangle ) SIP_HOLDGIL;
 
    // TODO:
    // Rhombus

    bool equals( const QgsQuadrilateral &other, double epsilon = 4 * std::numeric_limits<double>::epsilon() ) const SIP_HOLDGIL;
    bool operator==( const QgsQuadrilateral &other ) const SIP_HOLDGIL;
    bool operator!=( const QgsQuadrilateral &other ) const SIP_HOLDGIL;

    bool isValid() const SIP_HOLDGIL;

    enum Point
    {
      Point1,
      Point2,
      Point3,
      Point4,
    };

    bool setPoint( const QgsPoint &newPoint, Point index ) SIP_HOLDGIL;

    bool setPoints( const QgsPoint &p1, const QgsPoint &p2, const QgsPoint &p3, const QgsPoint &p4 ) SIP_HOLDGIL;

    QgsPointSequence points() const;

    QgsPolygon *toPolygon( bool force2D = false ) const SIP_FACTORY;

    QgsLineString *toLineString( bool force2D = false ) const SIP_FACTORY;

    QString toString( int pointPrecision = 17 ) const;

    double area() const SIP_HOLDGIL;

    double perimeter() const SIP_HOLDGIL;
#ifdef SIP_RUN
// clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsQuadrilateral: %1>"_s.arg( sipCpp->toString() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
  private:
    QgsPoint mPoint1, mPoint2, mPoint3, mPoint4;
};
 
#endif // QGSQUADRILATERAL_H