File indexing completed on 2024-05-12 03:50:12

 // SPDX-License-Identifier: LGPL-2.1-or-later
 //
 // SPDX-FileCopyrightText: 2007 Andrew Manson <g.real.ate@gmail.com>
 // SPDX-FileCopyrightText: 2008 Torsten Rahn <rahn@kde.org>
 //
 
 
 #ifndef MARBLE_GEODATALATLONALTBOX_H
 #define MARBLE_GEODATALATLONALTBOX_H
 
 
 #include "MarbleGlobal.h"
 
 #include "geodata_export.h"
 
 #include "GeoDataLatLonBox.h"
 
 #include <QHash>
 
 namespace Marble
 {
 
 class GeoDataLatLonAltBoxPrivate;
 
 class GeoDataLineString;
 
 
 /**
  * @short A class that defines a 3D bounding box for geographic data.
  *
  * GeoDataLatLonAltBox is a 3D bounding box that describes a geographic area
  * in terms of latitude, longitude and altitude.
  *
  * The bounding box gets described by assigning the northern, southern, 
  * eastern and western boundary.
  * So usually the value of the eastern boundary is bigger than the
  * value of the western boundary. Only if the bounding box crosses the
  * date line then the eastern boundary has got a smaller value than 
  * the western one.
  */
 
 class GEODATA_EXPORT GeoDataLatLonAltBox : public GeoDataLatLonBox
 {
     friend bool GEODATA_EXPORT operator==( GeoDataLatLonAltBox const& lhs, GeoDataLatLonAltBox const& rhs );
 
  public:
     GeoDataLatLonAltBox();
     GeoDataLatLonAltBox( const GeoDataLatLonAltBox & other );
     GeoDataLatLonAltBox( const GeoDataLatLonBox &other, qreal minAltitude, qreal maxAltitude );
     /**
      * @brief A LatLonAltBox with the data from a GeoDataCoordinate
      * This way of creating a GeoDataLatLonAltBox sets the north and south
      * values of this box to the Latitude value in the GeoDataCoordinate,
      * resulting in a Box that has a 0 Area. This is useful for building
      * LatLonAltBoxes from GeoDataCoordinates.
      */
     explicit GeoDataLatLonAltBox( const GeoDataCoordinates & coordinates );
     
     ~GeoDataLatLonAltBox() override;
 
     GeoDataLatLonAltBox& operator=( const GeoDataLatLonAltBox& other );
     GeoDataLatLonAltBox& operator=( const GeoDataCoordinates& other );
 
     /// Provides type information for downcasting a GeoData
     const char* nodeType() const override;
 
     /**
      * @brief qHash, for using GeoDataLatLonAltBox in a QCache as Key
      * @return the hash of the GeoDataLatLonAltBox
      */
     uint qHash(const GeoDataLatLonAltBox &);
 
     /**
      * @brief Get the lower altitude boundary of the bounding box.
      * @return the height of the lower altitude boundary in meters.
      */
     qreal minAltitude() const;
     void setMinAltitude( const qreal minAltitude );
 
     /**
      * @brief Get the upper altitude boundary of the bounding box.
      * @return the height of the upper altitude boundary in meters.
      */
     qreal maxAltitude() const;
     void setMaxAltitude( const qreal maxAltitude );
 
     /**
      * @brief Get the reference system for the altitude.
      * @return the point of reference which marks the origin 
      * for measuring the altitude.
      */
     AltitudeMode altitudeMode() const;
     void setAltitudeMode( const AltitudeMode altitudeMode );
 
     bool contains( const GeoDataCoordinates & ) const override;
     bool     contains( const GeoDataLatLonAltBox & ) const;
 
     /**
      * @brief Check if this GeoDataLatLonAltBox intersects with the given one.
      */
     virtual bool intersects( const GeoDataLatLonAltBox & ) const;
 
     using GeoDataLatLonBox::intersects;
 
     /**
      * @brief Create the smallest bounding box from a line string.
      * @return the smallest bounding box that contains the linestring.
      */
     static GeoDataLatLonAltBox fromLineString( const GeoDataLineString& lineString );
 
     /**
      * @brief Indicates whether the bounding box only contains a single 2D point ("singularity").
      * @return Return value is true if the height and the width of the bounding box equal zero.
      */
     bool isNull() const override;
 
     /**
      * @brief Resets the bounding box to its uninitialised state (and thus contains nothing).
      */
     void clear() override;
 
     /**
      * @brief returns the center of this box
      * @return a coordinate, body-center of the box
      */
     GeoDataCoordinates center() const override;
 
     /// Serialize the contents of the feature to @p stream.
     void pack( QDataStream& stream ) const override;
     /// Unserialize the contents of the feature from @p stream.
     void unpack( QDataStream& stream ) override;
 
  private:
     GeoDataLatLonAltBoxPrivate  * const d;
 };
 
 uint GEODATA_EXPORT qHash(const GeoDataLatLonAltBox &box, uint seed = 0);
 
 bool GEODATA_EXPORT operator==( GeoDataLatLonAltBox const& lhs, GeoDataLatLonAltBox const& rhs );
 
 }
 
 Q_DECLARE_METATYPE( Marble::GeoDataLatLonAltBox )
 
 #endif