qgssphere.h

Go to the documentation of this file.

/***************************************************************************
                         qgssphere.h
                         --------------
    begin                : July 2023
    copyright            : (C) 2023 by Nyall Dawson
    email                : nyall dot dawson at gmail 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 QGSSPHERE_H
#define QGSSPHERE_H
 
#include <limits>
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsPoint;
class QgsCircle;
class QgsBox3D;
class QgsVector3D;

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

    QgsSphere( double x, double y, double z, double radius ) SIP_HOLDGIL;
 
    bool operator==( const QgsSphere &other ) const
    {
      return qgsDoubleNear( mCenterX, other.mCenterX ) && qgsDoubleNear( mCenterY, other.mCenterY ) && qgsDoubleNear( mCenterZ, other.mCenterZ ) && qgsDoubleNear( mRadius, other.mRadius );
    }
    bool operator!=( const QgsSphere &other ) const { return !( *this == other ); }

    bool isNull() const SIP_HOLDGIL;

    bool isEmpty() const SIP_HOLDGIL;

    QgsPoint center() const SIP_HOLDGIL;

    QgsVector3D centerVector() const SIP_HOLDGIL;

    double centerX() const { return mCenterX; }

    double centerY() const { return mCenterY; }

    double centerZ() const { return mCenterZ; }

    void setCenter( const QgsPoint &center ) SIP_HOLDGIL;

    void setCenter( double x, double y, double z ) SIP_HOLDGIL { mCenterX = x; mCenterY = y; mCenterZ = z; }

    double radius() const SIP_HOLDGIL { return mRadius; }

    void setRadius( double radius ) SIP_HOLDGIL{ mRadius = radius; }

    double diameter() const SIP_HOLDGIL { return mRadius * 2; }

    double volume() const SIP_HOLDGIL;

    double surfaceArea() const SIP_HOLDGIL;

    QgsCircle toCircle() const SIP_HOLDGIL;

    QgsBox3D boundingBox() const SIP_HOLDGIL;
 
#ifdef SIP_RUN
// clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str;
    if ( sipCpp->isNull() )
    {
      str = u"<QgsSphere: null>"_s.arg( sipCpp->centerX() ).arg( sipCpp->centerY() ).arg( sipCpp->centerZ() ).arg( sipCpp->radius() );
    }
    else
    {
      str = u"<QgsSphere: (%1, %2, %3) radius %4>"_s.arg( sipCpp->centerX() ).arg( sipCpp->centerY() ).arg( sipCpp->centerZ() ).arg( sipCpp->radius() );
    }
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
  private:
    double mCenterX = std::numeric_limits< double >::quiet_NaN();
    double mCenterY = std::numeric_limits< double >::quiet_NaN();
    double mCenterZ = std::numeric_limits< double >::quiet_NaN();
    double mRadius = 0;
 
};
 
#endif // QGSSPHERE_H