Marble::GeoDataLatLonBox
#include <GeoDataLatLonBox.h>
Public Member Functions | |
GeoDataLatLonBox (const GeoDataLatLonBox &) | |
GeoDataLatLonBox (qreal north, qreal south, qreal east, qreal west, GeoDataCoordinates::Unit unit=GeoDataCoordinates::Radian) | |
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 |
GeoDataLatLonBox & | operator= (const GeoDataLatLonBox &other) |
GeoDataLatLonBox | operator| (const GeoDataLatLonBox &other) const |
GeoDataLatLonBox & | operator|= (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 |
GeoDataObject & | operator= (const GeoDataObject &) |
void | pack (QDataStream &stream) const override |
GeoDataObject * | parent () |
const GeoDataObject * | parent () const |
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 |
Public Member Functions inherited from Marble::GeoNode |
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) |
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 44 of file GeoDataLatLonBox.h.
Constructor & Destructor Documentation
◆ GeoDataLatLonBox() [1/3]
Marble::GeoDataLatLonBox::GeoDataLatLonBox | ( | ) |
Definition at line 51 of file GeoDataLatLonBox.cpp.
◆ GeoDataLatLonBox() [2/3]
Marble::GeoDataLatLonBox::GeoDataLatLonBox | ( | qreal | north, |
qreal | south, | ||
qreal | east, | ||
qreal | west, | ||
GeoDataCoordinates::Unit | unit = GeoDataCoordinates::Radian ) |
Definition at line 57 of file GeoDataLatLonBox.cpp.
◆ GeoDataLatLonBox() [3/3]
Marble::GeoDataLatLonBox::GeoDataLatLonBox | ( | const GeoDataLatLonBox & | other | ) |
Definition at line 64 of file GeoDataLatLonBox.cpp.
◆ ~GeoDataLatLonBox()
|
override |
Definition at line 70 of file GeoDataLatLonBox.cpp.
Member Function Documentation
◆ boundaries()
void Marble::GeoDataLatLonBox::boundaries | ( | qreal & | north, |
qreal & | south, | ||
qreal & | east, | ||
qreal & | west, | ||
GeoDataCoordinates::Unit | unit = GeoDataCoordinates::Radian ) const |
Definition at line 185 of file GeoDataLatLonBox.cpp.
◆ center()
|
virtual |
returns the center of this box
- Returns
- a coordinate, face-center of the box
Reimplemented in Marble::GeoDataLatLonAltBox.
Definition at line 294 of file GeoDataLatLonBox.cpp.
◆ clear()
|
virtual |
Resets the bounding box to its uninitialised state (and thus contains nothing).
Reimplemented in Marble::GeoDataLatLonAltBox.
Definition at line 815 of file GeoDataLatLonBox.cpp.
◆ contains() [1/3]
|
virtual |
Definition at line 336 of file GeoDataLatLonBox.cpp.
◆ contains() [2/3]
bool Marble::GeoDataLatLonBox::contains | ( | const GeoDataLatLonBox & | other | ) | const |
Definition at line 345 of file GeoDataLatLonBox.cpp.
◆ contains() [3/3]
bool Marble::GeoDataLatLonBox::contains | ( | qreal | lon, |
qreal | lat ) const |
Detect whether the bounding box contains a point of given lon and lat.
- Parameters
-
lon longitude in radians. lat latitude in radians.
- Returns
- true if the box contains given point, false otherwise
Definition at line 321 of file GeoDataLatLonBox.cpp.
◆ containsPole()
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 305 of file GeoDataLatLonBox.cpp.
◆ crossesDateLine() [1/2]
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 284 of file GeoDataLatLonBox.cpp.
◆ crossesDateLine() [2/2]
|
static |
Detect whether the bounding box crosses the IDL.
- Parameters
-
east radians east. west radians 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 289 of file GeoDataLatLonBox.cpp.
◆ east()
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 122 of file GeoDataLatLonBox.cpp.
◆ fromLineString()
|
static |
Create the smallest bounding box from a line string.
- Returns
- the smallest bounding box that contains the linestring.
Definition at line 606 of file GeoDataLatLonBox.cpp.
◆ fuzzyCompare()
|
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 757 of file GeoDataLatLonBox.cpp.
◆ height() [1/2]
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 268 of file GeoDataLatLonBox.cpp.
◆ height() [2/2]
|
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 273 of file GeoDataLatLonBox.cpp.
◆ intersects()
|
virtual |
Definition at line 396 of file GeoDataLatLonBox.cpp.
◆ isEmpty()
|
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 752 of file GeoDataLatLonBox.cpp.
◆ isNull()
|
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 747 of file GeoDataLatLonBox.cpp.
◆ nodeType()
|
overridevirtual |
Provides type information for downcasting a GeoData.
Implements Marble::GeoNode.
Definition at line 75 of file GeoDataLatLonBox.cpp.
◆ north()
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 80 of file GeoDataLatLonBox.cpp.
◆ operator=()
GeoDataLatLonBox & Marble::GeoDataLatLonBox::operator= | ( | const GeoDataLatLonBox & | other | ) |
Definition at line 573 of file GeoDataLatLonBox.cpp.
◆ operator|()
GeoDataLatLonBox Marble::GeoDataLatLonBox::operator| | ( | const GeoDataLatLonBox & | other | ) | const |
Definition at line 581 of file GeoDataLatLonBox.cpp.
◆ operator|=()
GeoDataLatLonBox & Marble::GeoDataLatLonBox::operator|= | ( | const GeoDataLatLonBox & | other | ) |
Unites this bounding box with the given one.
- Returns
- Returns a reference to self.
Definition at line 586 of file GeoDataLatLonBox.cpp.
◆ pack()
|
override |
Serialize the contents of the feature to stream
.
Definition at line 592 of file GeoDataLatLonBox.cpp.
◆ rotation()
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 177 of file GeoDataLatLonBox.cpp.
◆ scale()
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
-
verticalFactor Vertical scale factor (affects north and south boundaries) horizontalFactor Horizontal scale factor (affects west and east boundaries)
Definition at line 223 of file GeoDataLatLonBox.cpp.
◆ scaled()
GeoDataLatLonBox Marble::GeoDataLatLonBox::scaled | ( | qreal | verticalFactor, |
qreal | horizontalFactor ) const |
Definition at line 239 of file GeoDataLatLonBox.cpp.
◆ setBoundaries()
void Marble::GeoDataLatLonBox::setBoundaries | ( | qreal | north, |
qreal | south, | ||
qreal | east, | ||
qreal | west, | ||
GeoDataCoordinates::Unit | unit = GeoDataCoordinates::Radian ) |
Definition at line 204 of file GeoDataLatLonBox.cpp.
◆ setEast()
void Marble::GeoDataLatLonBox::setEast | ( | const qreal | east, |
GeoDataCoordinates::Unit | unit = GeoDataCoordinates::Radian ) |
Definition at line 130 of file GeoDataLatLonBox.cpp.
◆ setNorth()
void Marble::GeoDataLatLonBox::setNorth | ( | const qreal | north, |
GeoDataCoordinates::Unit | unit = GeoDataCoordinates::Radian ) |
Definition at line 88 of file GeoDataLatLonBox.cpp.
◆ setRotation()
void Marble::GeoDataLatLonBox::setRotation | ( | const qreal | rotation, |
GeoDataCoordinates::Unit | unit = GeoDataCoordinates::Radian ) |
Definition at line 164 of file GeoDataLatLonBox.cpp.
◆ setSouth()
void Marble::GeoDataLatLonBox::setSouth | ( | const qreal | south, |
GeoDataCoordinates::Unit | unit = GeoDataCoordinates::Radian ) |
Definition at line 109 of file GeoDataLatLonBox.cpp.
◆ setWest()
void Marble::GeoDataLatLonBox::setWest | ( | const qreal | west, |
GeoDataCoordinates::Unit | unit = GeoDataCoordinates::Radian ) |
Definition at line 151 of file GeoDataLatLonBox.cpp.
◆ south()
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 101 of file GeoDataLatLonBox.cpp.
◆ toCircumscribedRectangle()
GeoDataLatLonBox Marble::GeoDataLatLonBox::toCircumscribedRectangle | ( | ) | const |
- Returns
- Returns the smallest bounding box that contains this LatLonBox rotated with its given angle.
Definition at line 511 of file GeoDataLatLonBox.cpp.
◆ united()
GeoDataLatLonBox Marble::GeoDataLatLonBox::united | ( | const GeoDataLatLonBox & | other | ) | const |
Returns the bounding LatLonBox of this box with the given one.
Definition at line 453 of file GeoDataLatLonBox.cpp.
◆ unpack()
|
override |
Unserialize the contents of the feature from stream
.
Definition at line 599 of file GeoDataLatLonBox.cpp.
◆ west()
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 143 of file GeoDataLatLonBox.cpp.
◆ width() [1/2]
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 246 of file GeoDataLatLonBox.cpp.
◆ width() [2/2]
|
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 251 of file GeoDataLatLonBox.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 4 2024 16:37:04 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.