Marble::GeoDataLatLonBox

#include <GeoDataLatLonBox.h>

Inheritance diagram for Marble::GeoDataLatLonBox:

Public Member Functions

 GeoDataLatLonBox (qreal north, qreal south, qreal east, qreal west, GeoDataCoordinates::Unit unit=GeoDataCoordinates::Radian)
 
 GeoDataLatLonBox (const GeoDataLatLonBox &)
 
void boundaries (qreal &north, qreal &south, qreal &east, qreal &west, GeoDataCoordinates::Unit unit=GeoDataCoordinates::Radian) const
 
virtual GeoDataCoordinates center () const
 
virtual void clear ()
 
virtual bool contains (const GeoDataCoordinates &) const
 
bool contains (const GeoDataLatLonBox &) const
 
bool contains (qreal lon, qreal lat) const
 
bool containsPole (Pole pole=AnyPole) const
 
bool crossesDateLine () const
 
qreal east (GeoDataCoordinates::Unit unit=GeoDataCoordinates::Radian) const
 
qreal height (GeoDataCoordinates::Unit unit=GeoDataCoordinates::Radian) const
 
virtual bool intersects (const GeoDataLatLonBox &) const
 
virtual bool isEmpty () const
 
virtual bool isNull () const
 
const char * nodeType () const override
 
qreal north (GeoDataCoordinates::Unit unit=GeoDataCoordinates::Radian) const
 
GeoDataLatLonBoxoperator= (const GeoDataLatLonBox &other)
 
GeoDataLatLonBox operator| (const GeoDataLatLonBox &other) const
 
GeoDataLatLonBoxoperator|= (const GeoDataLatLonBox &other)
 
void pack (QDataStream &stream) const override
 
qreal rotation (GeoDataCoordinates::Unit unit=GeoDataCoordinates::Radian) const
 
void scale (qreal verticalFactor, qreal horizontalFactor) const
 
GeoDataLatLonBox scaled (qreal verticalFactor, qreal horizontalFactor) const
 
void setBoundaries (qreal north, qreal south, qreal east, qreal west, GeoDataCoordinates::Unit unit=GeoDataCoordinates::Radian)
 
void setEast (const qreal east, GeoDataCoordinates::Unit unit=GeoDataCoordinates::Radian)
 
void setNorth (const qreal north, GeoDataCoordinates::Unit unit=GeoDataCoordinates::Radian)
 
void setRotation (const qreal rotation, GeoDataCoordinates::Unit unit=GeoDataCoordinates::Radian)
 
void setSouth (const qreal south, GeoDataCoordinates::Unit unit=GeoDataCoordinates::Radian)
 
void setWest (const qreal west, GeoDataCoordinates::Unit unit=GeoDataCoordinates::Radian)
 
qreal south (GeoDataCoordinates::Unit unit=GeoDataCoordinates::Radian) const
 
GeoDataLatLonBox toCircumscribedRectangle () const
 
GeoDataLatLonBox united (const GeoDataLatLonBox &other) const
 
void unpack (QDataStream &stream) override
 
qreal west (GeoDataCoordinates::Unit unit=GeoDataCoordinates::Radian) const
 
qreal width (GeoDataCoordinates::Unit unit=GeoDataCoordinates::Radian) const
 
- Public Member Functions inherited from Marble::GeoDataObject
 GeoDataObject (const GeoDataObject &)
 
QString id () const
 
GeoDataObjectoperator= (const GeoDataObject &)
 
void pack (QDataStream &stream) const override
 
const GeoDataObjectparent () const
 
GeoDataObjectparent ()
 
QString resolvePath (const QString &relativePath) const
 
void setId (const QString &value)
 
void setParent (GeoDataObject *parent)
 
void setTargetId (const QString &value)
 
QString targetId () const
 
void unpack (QDataStream &steam) override
 

Static Public Member Functions

static bool crossesDateLine (qreal east, qreal west)
 
static GeoDataLatLonBox fromLineString (const GeoDataLineString &lineString)
 
static bool fuzzyCompare (const GeoDataLatLonBox &lhs, const GeoDataLatLonBox &rhs, const qreal factor=0.01)
 
static qreal height (qreal north, qreal south, GeoDataCoordinates::Unit unit=GeoDataCoordinates::Radian)
 
static qreal width (qreal east, qreal west, GeoDataCoordinates::Unit unit=GeoDataCoordinates::Radian)
 

Friends

bool GEODATA_EXPORT operator!= (GeoDataLatLonBox const &lhs, GeoDataLatLonBox const &rhs)
 
bool GEODATA_EXPORT operator== (GeoDataLatLonBox const &lhs, GeoDataLatLonBox const &rhs)
 

Additional Inherited Members

- Protected Member Functions inherited from Marble::GeoDataObject
virtual bool equals (const GeoDataObject &other) const
 

Detailed Description

A class that defines a 2D bounding box for geographic data.

GeoDataLatLonBox is a 2D bounding box that describes a geographic area in terms of latitude and longitude.

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.

This is also true if the GeoDataLatLonBox covers the whole longitude range from 180 deg West to 180 deg East. Notably in this case the bounding box crosses the date line.

If the GeoDataLatLonBox does not cover the whole longitude range but still crosses the date line then the eastern boundary has got a smaller value than the western one.

Definition at line 51 of file GeoDataLatLonBox.h.

Member Function Documentation

GeoDataCoordinates Marble::GeoDataLatLonBox::center ( ) const
virtual

returns the center of this box

Returns
a coordinate, face-center of the box

Reimplemented in Marble::GeoDataLatLonAltBox.

Definition at line 307 of file GeoDataLatLonBox.cpp.

void Marble::GeoDataLatLonBox::clear ( )
virtual

Resets the bounding box to its uninitialised state (and thus contains nothing).

Reimplemented in Marble::GeoDataLatLonAltBox.

Definition at line 844 of file GeoDataLatLonBox.cpp.

bool Marble::GeoDataLatLonBox::contains ( qreal  lon,
qreal  lat 
) const

Detect whether the bounding box contains a point of given lon and lat.

Parameters
lonlongitude in radians.
latlatitude in radians.
Returns
true if the box contains given point, false otherwise

Definition at line 337 of file GeoDataLatLonBox.cpp.

bool Marble::GeoDataLatLonBox::containsPole ( Pole  pole = AnyPole) const

Detect whether the bounding box contains one of the poles.

Returns
true the bounding box contains one of the poles. false the bounding box doesn't contain one of the poles.

Definition at line 320 of file GeoDataLatLonBox.cpp.

bool Marble::GeoDataLatLonBox::crossesDateLine ( ) const

Detect whether the bounding box crosses the IDL.

Returns
true the bounding box crosses the +/-180 deg longitude. false the bounding box doesn't cross the +/-180 deg longitude.

Definition at line 297 of file GeoDataLatLonBox.cpp.

bool Marble::GeoDataLatLonBox::crossesDateLine ( qreal  east,
qreal  west 
)
static

Detect whether the bounding box crosses the IDL.

Parameters
eastradians east.
westradians west.
Returns
true the bounding box crosses the +/-180 deg longitude. false the bounding box doesn't cross the +/-180 deg longitude.

Definition at line 302 of file GeoDataLatLonBox.cpp.

qreal Marble::GeoDataLatLonBox::east ( GeoDataCoordinates::Unit  unit = GeoDataCoordinates::Radian) const

Get the eastern boundary of the bounding box.

Returns
the longitude of the eastern boundary.

Definition at line 132 of file GeoDataLatLonBox.cpp.

GeoDataLatLonBox Marble::GeoDataLatLonBox::fromLineString ( const GeoDataLineString lineString)
static

Create the smallest bounding box from a line string.

Returns
the smallest bounding box that contains the linestring.

Definition at line 635 of file GeoDataLatLonBox.cpp.

bool Marble::GeoDataLatLonBox::fuzzyCompare ( const GeoDataLatLonBox lhs,
const GeoDataLatLonBox rhs,
const qreal  factor = 0.01 
)
static

Indicates whether two bounding boxes are roughly equal.

The factor specifies the margin threshold relative to the left handside bounding box within which both bounding boxes are considered equal.

Returns
Return value is true if both bounding box are approximately equal.

Definition at line 788 of file GeoDataLatLonBox.cpp.

qreal Marble::GeoDataLatLonBox::height ( GeoDataCoordinates::Unit  unit = GeoDataCoordinates::Radian) const

Get the height of the latitude interval.

Returns
the angle covered by the latitude range.

Definition at line 281 of file GeoDataLatLonBox.cpp.

qreal Marble::GeoDataLatLonBox::height ( qreal  north,
qreal  south,
GeoDataCoordinates::Unit  unit = GeoDataCoordinates::Radian 
)
static

Get the height of the latitude interval.

North and south parameters are in radians.

Returns
the angle covered by the latitude range in given unit.

Definition at line 286 of file GeoDataLatLonBox.cpp.

bool Marble::GeoDataLatLonBox::isEmpty ( ) const
virtual

Indicates whether the bounding box is not initialised (and contains nothing).

Returns
Return value is true if bounding box is not initialised.

Definition at line 783 of file GeoDataLatLonBox.cpp.

bool Marble::GeoDataLatLonBox::isNull ( ) const
virtual

Indicates whether the bounding box only contains a single 2D point ("singularity").

Returns
Return value is true if the height and the width of the bounding box equal zero.

Reimplemented in Marble::GeoDataLatLonAltBox.

Definition at line 778 of file GeoDataLatLonBox.cpp.

const char * Marble::GeoDataLatLonBox::nodeType ( ) const
overridevirtual

Provides type information for downcasting a GeoData.

Implements Marble::GeoNode.

Definition at line 85 of file GeoDataLatLonBox.cpp.

qreal Marble::GeoDataLatLonBox::north ( GeoDataCoordinates::Unit  unit = GeoDataCoordinates::Radian) const

Get the northern boundary of the bounding box.

Returns
the latitude of the northern boundary.

Definition at line 90 of file GeoDataLatLonBox.cpp.

GeoDataLatLonBox & Marble::GeoDataLatLonBox::operator|= ( const GeoDataLatLonBox other)

Unites this bounding box with the given one.

Returns
Returns a reference to self.

Definition at line 614 of file GeoDataLatLonBox.cpp.

void Marble::GeoDataLatLonBox::pack ( QDataStream stream) const
override

Serialize the contents of the feature to stream.

Definition at line 621 of file GeoDataLatLonBox.cpp.

qreal Marble::GeoDataLatLonBox::rotation ( GeoDataCoordinates::Unit  unit = GeoDataCoordinates::Radian) const

Get the rotation of the bounding box.

Returns
the rotation of the bounding box.

Definition at line 187 of file GeoDataLatLonBox.cpp.

void Marble::GeoDataLatLonBox::scale ( qreal  verticalFactor,
qreal  horizontalFactor 
) const

Changes the differences between the boundaries and the center by the given factor, keeping the center unchanged.

Parameters
verticalFactorVertical scale factor (affects north and south boundaries)
horizontalFactorHorizontal scale factor (affects west and east boundaries)

Definition at line 233 of file GeoDataLatLonBox.cpp.

qreal Marble::GeoDataLatLonBox::south ( GeoDataCoordinates::Unit  unit = GeoDataCoordinates::Radian) const

Get the southern boundary of the bounding box.

Returns
the latitude of the southern boundary.

Definition at line 111 of file GeoDataLatLonBox.cpp.

GeoDataLatLonBox Marble::GeoDataLatLonBox::toCircumscribedRectangle ( ) const
Returns
Returns the smallest bounding box that contains this LatLonBox rotated with its given angle.

Definition at line 540 of file GeoDataLatLonBox.cpp.

GeoDataLatLonBox Marble::GeoDataLatLonBox::united ( const GeoDataLatLonBox other) const

Returns the bounding LatLonBox of this box with the given one.

Definition at line 480 of file GeoDataLatLonBox.cpp.

void Marble::GeoDataLatLonBox::unpack ( QDataStream stream)
override

Unserialize the contents of the feature from stream.

Definition at line 628 of file GeoDataLatLonBox.cpp.

qreal Marble::GeoDataLatLonBox::west ( GeoDataCoordinates::Unit  unit = GeoDataCoordinates::Radian) const

Get the western boundary of the bounding box.

Returns
the longitude of the western boundary.

Definition at line 153 of file GeoDataLatLonBox.cpp.

qreal Marble::GeoDataLatLonBox::width ( GeoDataCoordinates::Unit  unit = GeoDataCoordinates::Radian) const

Get the width of the longitude interval.

Returns
the angle covered by the longitude range.

Definition at line 257 of file GeoDataLatLonBox.cpp.

qreal Marble::GeoDataLatLonBox::width ( qreal  east,
qreal  west,
GeoDataCoordinates::Unit  unit = GeoDataCoordinates::Radian 
)
static

Get the width of the longitude interval.

East and west parameters are in radians.

Returns
the angle covered by the longitude range in given unit.

Definition at line 262 of file GeoDataLatLonBox.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jul 13 2020 23:19:48 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.