qgsellipse.h

Go to the documentation of this file.

/***************************************************************************
                         qgsellipse.h
                         --------------
    begin                : March 2017
    copyright            : (C) 2017 by Loïc Bartoletti
    email                : lituus at free dot fr
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSELLIPSE_H
#define QGSELLIPSE_H
 
#include "qgis_core.h"
#include "qgslinestring.h"
#include "qgspoint.h"
#include "qgspolygon.h"
#include "qgsrectangle.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsEllipse
{
  public:
    // clang-format off
    QgsEllipse() SIP_HOLDGIL = default;
    // clang-format on
 
    virtual ~QgsEllipse() = default;

    QgsEllipse( const QgsPoint &center, double semiMajorAxis, double semiMinorAxis, double azimuth = 90 ) SIP_HOLDGIL;

    static QgsEllipse fromFoci( const QgsPoint &pt1, const QgsPoint &pt2, const QgsPoint &pt3 ) SIP_HOLDGIL;

    static QgsEllipse fromExtent( const QgsPoint &pt1, const QgsPoint &pt2 ) SIP_HOLDGIL;

    static QgsEllipse fromCenterPoint( const QgsPoint &ptc, const QgsPoint &pt1 ) SIP_HOLDGIL;

    static QgsEllipse fromCenter2Points( const QgsPoint &ptc, const QgsPoint &pt1, const QgsPoint &pt2 ) SIP_HOLDGIL;
 
    virtual bool operator ==( const QgsEllipse &elp ) const;
    virtual bool operator !=( const QgsEllipse &elp ) const;

    virtual bool isEmpty() const SIP_HOLDGIL;

    QgsPoint center() const SIP_HOLDGIL {return mCenter; }

    double semiMajorAxis() const SIP_HOLDGIL {return mSemiMajorAxis; }

    double semiMinorAxis() const SIP_HOLDGIL {return mSemiMinorAxis; }

    double azimuth() const SIP_HOLDGIL {return mAzimuth; }

    QgsPoint &rcenter() SIP_SKIP { return mCenter; }

    void setCenter( const QgsPoint &center ) SIP_HOLDGIL {mCenter = center; }

    virtual void setSemiMajorAxis( double semiMajorAxis ) SIP_HOLDGIL;

    virtual void setSemiMinorAxis( double semiMinorAxis ) SIP_HOLDGIL;

    void setAzimuth( double azimuth ) SIP_HOLDGIL;

    virtual double focusDistance() const SIP_HOLDGIL;

    virtual QVector<QgsPoint> foci() const;

    virtual double eccentricity() const SIP_HOLDGIL;
    virtual double area() const SIP_HOLDGIL;
    virtual double perimeter() const SIP_HOLDGIL;

    virtual QVector<QgsPoint> quadrant() const;

    virtual QgsPointSequence points( unsigned int segments = 36 ) const;

    virtual QgsPolygon *toPolygon( unsigned int segments = 36 ) const SIP_FACTORY;

    virtual QgsLineString *toLineString( unsigned int segments = 36 ) const SIP_FACTORY;
    //virtual QgsCurvePolygon toCurvePolygon() const;

    virtual QgsPolygon *orientedBoundingBox() const SIP_FACTORY;

    virtual QgsRectangle boundingBox() const;

    virtual QString toString( int pointPrecision = 17, int axisPrecision = 17, int azimuthPrecision = 2 ) const;
 
#ifdef SIP_RUN
// clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsEllipse: %1>"_s.arg( sipCpp->toString() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
  protected:
    QgsPoint mCenter;
    double mSemiMajorAxis = 0.0;
    double mSemiMinorAxis = 0.0;
    double mAzimuth = 90.0;
 
  private:
    void normalizeAxis();
 
    void pointsInternal( unsigned int segments, QVector< double> &x, QVector< double> &y, QVector<double> &z, QVector< double> &m ) const;
};
 
#endif // QGSELLIPSE_H