qgsregularpolygon.h

Go to the documentation of this file.

/***************************************************************************
                         qgsregularpolygon.h
                         --------------
    begin                : May 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 QGSREGULARPOLYGON_H
#define QGSREGULARPOLYGON_H
 
#include "qgis_core.h"
#include "qgscircle.h"
#include "qgslinestring.h"
#include "qgspoint.h"
#include "qgspolygon.h"
#include "qgstriangle.h"
 
#include <QString>

class CORE_EXPORT QgsRegularPolygon
{
  public:
    enum ConstructionOption
    {
      InscribedCircle,    
      CircumscribedCircle 
    };
 
    // clang-format off
    QgsRegularPolygon() SIP_HOLDGIL = default;
    // clang-format on

    QgsRegularPolygon( const QgsPoint &center, double radius, double azimuth, unsigned int numberSides, ConstructionOption circle ) SIP_HOLDGIL;

    QgsRegularPolygon( const QgsPoint &center, const QgsPoint &pt1, unsigned int numberSides, ConstructionOption circle ) SIP_HOLDGIL;

    QgsRegularPolygon( const QgsPoint &pt1, const QgsPoint &pt2, unsigned int numberSides ) SIP_HOLDGIL;
 
    bool operator ==( const QgsRegularPolygon &rp ) const SIP_HOLDGIL;
    bool operator !=( const QgsRegularPolygon &rp ) const SIP_HOLDGIL;

    bool isEmpty() const SIP_HOLDGIL;

    QgsPoint center() const SIP_HOLDGIL { return mCenter; }

    double radius() const SIP_HOLDGIL { return mRadius; }

    QgsPoint firstVertex() const SIP_HOLDGIL { return mFirstVertex; }

    double apothem() const SIP_HOLDGIL { return mRadius * std::cos( M_PI / mNumberSides ); }

    unsigned int numberSides() const SIP_HOLDGIL { return mNumberSides; }

    void setCenter( const QgsPoint &center ) SIP_HOLDGIL;

    void setRadius( double radius ) SIP_HOLDGIL;

    void setFirstVertex( const QgsPoint &firstVertex ) SIP_HOLDGIL;

    void setNumberSides( unsigned int numberSides ) SIP_HOLDGIL;

    QgsPointSequence points() const;

    QgsPolygon *toPolygon() const SIP_FACTORY;

    QgsLineString *toLineString() const SIP_FACTORY;

    QgsTriangle toTriangle() const;

    QVector<QgsTriangle> triangulate() const;

    QgsCircle inscribedCircle() const SIP_HOLDGIL;

    QgsCircle circumscribedCircle() const SIP_HOLDGIL;

    QString toString( int pointPrecision = 17, int radiusPrecision = 17, int anglePrecision = 2 ) const;

    double interiorAngle() const SIP_HOLDGIL;

    double centralAngle() const SIP_HOLDGIL;

    double area() const SIP_HOLDGIL;

    double perimeter() const SIP_HOLDGIL;

    double length() const SIP_HOLDGIL;
 
  private:
    QgsPoint mCenter;
    QgsPoint mFirstVertex;
    unsigned int mNumberSides = 0;
    double mRadius = 0.0;

    double apothemToRadius( double apothem, unsigned int numberSides ) const;

    double interiorAngle( unsigned int nbSides ) const;

    double centralAngle( unsigned int nbSides ) const;
 
};
 
#endif // QGSREGULARPOLYGON_H