Marble::AbstractProjection

Search for usage in LXR

#include <AbstractProjection.h>

Inheritance diagram for Marble::AbstractProjection:

Public Types

enum  PreservationType { NoPreservation, Conformal, EqualArea }
 
enum  SurfaceType {
  Cylindrical, Pseudocylindrical, Hybrid, Conical,
  Pseudoconical, Azimuthal
}
 

Public Member Functions

 AbstractProjection ()
 
virtual qreal clippingRadius () const
 
virtual QString description () const =0
 
virtual bool geoCoordinates (const int x, const int y, const ViewportParams *viewport, qreal &lon, qreal &lat, GeoDataCoordinates::Unit unit=GeoDataCoordinates::Degree) const =0
 
virtual QIcon icon () const =0
 
virtual bool isClippedToSphere () const
 
virtual bool isOrientedNormal () const
 
virtual GeoDataLatLonAltBox latLonAltBox (const QRect &screenRect, const ViewportParams *viewport) const
 
virtual bool mapCoversViewport (const ViewportParams *viewport) const =0
 
QRegion mapRegion (const ViewportParams *viewport) const
 
virtual QPainterPath mapShape (const ViewportParams *viewport) const =0
 
qreal maxLat () const
 
virtual qreal maxValidLat () const
 
qreal minLat () const
 
virtual qreal minValidLat () const
 
virtual QString name () const =0
 
virtual PreservationType preservationType () const
 
virtual bool repeatableX () const
 
bool screenCoordinates (const qreal lon, const qreal lat, const ViewportParams *viewport, qreal &x, qreal &y) const
 
virtual bool screenCoordinates (const GeoDataCoordinates &geopoint, const ViewportParams *viewport, qreal &x, qreal &y, bool &globeHidesPoint) const =0
 
bool screenCoordinates (const GeoDataCoordinates &geopoint, const ViewportParams *viewport, qreal &x, qreal &y) const
 
virtual bool screenCoordinates (const GeoDataCoordinates &coordinates, const ViewportParams *viewport, qreal *x, qreal &y, int &pointRepeatNum, const QSizeF &size, bool &globeHidesPoint) const =0
 
virtual bool screenCoordinates (const GeoDataLineString &lineString, const ViewportParams *viewport, QVector< QPolygonF * > &polygons) const =0
 
void setMaxLat (qreal maxLat)
 
void setMinLat (qreal minLat)
 
virtual SurfaceType surfaceType () const =0
 
virtual bool traversableDateLine () const
 
virtual bool traversablePoles () const
 

Protected Member Functions

 AbstractProjection (AbstractProjectionPrivate *dd)
 

Protected Attributes

const QScopedPointer< AbstractProjectionPrivate > d_ptr
 

Detailed Description

A base class for all projections in Marble.

Definition at line 47 of file AbstractProjection.h.

Constructor & Destructor Documentation

AbstractProjection::AbstractProjection ( )

Construct a new AbstractProjection.

Definition at line 25 of file AbstractProjection.cpp.

Member Function Documentation

virtual QString Marble::AbstractProjection::description ( ) const
pure virtual
virtual bool Marble::AbstractProjection::geoCoordinates ( const int  x,
const int  y,
const ViewportParams viewport,
qreal &  lon,
qreal &  lat,
GeoDataCoordinates::Unit  unit = GeoDataCoordinates::Degree 
) const
pure virtual

Get the earth coordinates corresponding to a pixel in the map.

Parameters
xthe x coordinate of the pixel
ythe y coordinate of the pixel
viewportthe viewport parameters
lonthe longitude angle is returned through this parameter
latthe latitude angle is returned through this parameter
unitthe unit of the angles for lon and lat.
Returns
true if the pixel (x, y) is within the globe false if the pixel (x, y) is outside the globe, i.e. in space.

Implemented in Marble::MercatorProjection, Marble::EquirectProjection, Marble::SphericalProjection, Marble::AzimuthalEquidistantProjection, Marble::GnomonicProjection, Marble::LambertAzimuthalProjection, Marble::StereographicProjection, and Marble::VerticalPerspectiveProjection.

bool AbstractProjection::isClippedToSphere ( ) const
virtual

Defines whether a projection is supposed to be clipped to a certain radius.

Example: The Gnomonic projection is clipped to a circle of a certain clipping radius (although it's mathematically defined beyond that radius).

Reimplemented in Marble::AzimuthalProjection.

Definition at line 143 of file AbstractProjection.cpp.

GeoDataLatLonAltBox AbstractProjection::latLonAltBox ( const QRect screenRect,
const ViewportParams viewport 
) const
virtual

Returns a GeoDataLatLonAltBox bounding box of the given screenrect inside the given viewport.

Reimplemented in Marble::MercatorProjection, Marble::EquirectProjection, and Marble::AzimuthalProjection.

Definition at line 172 of file AbstractProjection.cpp.

virtual bool Marble::AbstractProjection::mapCoversViewport ( const ViewportParams viewport) const
pure virtual

Returns whether the projected data fully obstructs the current viewport.

In this case there are no black areas visible around the actual map. This case allows for performance optimizations.

Implemented in Marble::MercatorProjection, Marble::EquirectProjection, and Marble::AzimuthalProjection.

virtual QPainterPath Marble::AbstractProjection::mapShape ( const ViewportParams viewport) const
pure virtual

Returns the shape/outline of a map projection.

This call allows e.g. to draw the default background color of the map itself.

Example: For an azimuthal projection a circle is returned at low zoom values.

Implemented in Marble::AzimuthalProjection, and Marble::CylindricalProjection.

qreal AbstractProjection::maxLat ( ) const

Returns the arbitrarily chosen maximum (northern) latitude.

By default this value is equal to the value defined inside maxValidLat(). In general this value can only be smaller or equal to maxValidLat().

Definition at line 79 of file AbstractProjection.cpp.

qreal AbstractProjection::maxValidLat ( ) const
virtual

Returns the maximum (northern) latitude that is mathematically defined and reasonable.

Example: For many projections the value will represent +90 degrees in Radian. In the case of Mercator this value will equal +85.05113 degrees in Radian.

Reimplemented in Marble::MercatorProjection.

Definition at line 74 of file AbstractProjection.cpp.

qreal AbstractProjection::minLat ( ) const

Returns the arbitrarily chosen minimum (southern) latitude.

By default this value is equal to the value defined inside minValidLat(). In general this value can only be larger or equal to minValidLat().

Definition at line 101 of file AbstractProjection.cpp.

qreal AbstractProjection::minValidLat ( ) const
virtual

Returns the minimum (southern) latitude that is mathematically defined and reasonable.

Example: For many projections the value will represent -90 degrees in Radian. In the case of Mercator this value will equal -85.05113 degrees in Radian.

Reimplemented in Marble::MercatorProjection.

Definition at line 96 of file AbstractProjection.cpp.

virtual QString Marble::AbstractProjection::name ( ) const
pure virtual
bool AbstractProjection::repeatableX ( ) const
virtual

Returns whether the projection allows for wrapping in x direction (along the longitude scale).

Example: Cylindrical projections allow for repeating.

Reimplemented in Marble::CylindricalProjection, and Marble::AzimuthalProjection.

Definition at line 118 of file AbstractProjection.cpp.

bool AbstractProjection::screenCoordinates ( const qreal  lon,
const qreal  lat,
const ViewportParams viewport,
qreal &  x,
qreal &  y 
) const

Get the screen coordinates corresponding to geographical coordinates in the map.

Parameters
lonthe lon coordinate of the requested pixel position in radians
latthe lat coordinate of the requested pixel position in radians
viewportthe viewport parameters
xthe x coordinate of the pixel is returned through this parameter
ythe y coordinate of the pixel is returned through this parameter
Returns
true if the geographical coordinates are visible on the screen false if the geographical coordinates are not visible on the screen
See also
ViewportParams

Definition at line 154 of file AbstractProjection.cpp.

virtual bool Marble::AbstractProjection::screenCoordinates ( const GeoDataCoordinates geopoint,
const ViewportParams viewport,
qreal &  x,
qreal &  y,
bool &  globeHidesPoint 
) const
pure virtual

Get the screen coordinates corresponding to geographical coordinates in the map.

Parameters
geopointthe point on earth, including altitude, that we want the coordinates for.
viewportthe viewport parameters
xthe x coordinate of the pixel is returned through this parameter
ythe y coordinate of the pixel is returned through this parameter
globeHidesPointwhether the point gets hidden on the far side of the earth
Returns
true if the geographical coordinates are visible on the screen false if the geographical coordinates are not visible on the screen
See also
ViewportParams

Implemented in Marble::MercatorProjection, Marble::EquirectProjection, Marble::SphericalProjection, Marble::AzimuthalEquidistantProjection, Marble::GnomonicProjection, Marble::LambertAzimuthalProjection, Marble::StereographicProjection, and Marble::VerticalPerspectiveProjection.

virtual bool Marble::AbstractProjection::screenCoordinates ( const GeoDataCoordinates coordinates,
const ViewportParams viewport,
qreal *  x,
qreal &  y,
int &  pointRepeatNum,
const QSizeF size,
bool &  globeHidesPoint 
) const
pure virtual

Get the coordinates of screen points for geographical coordinates in the map.

Parameters
coordinatesthe point on earth, including altitude, that we want the coordinates for.
viewportthe viewport parameters
xthe x coordinates of the pixels are returned through this parameter
ythe y coordinate of the pixel is returned through this parameter
pointRepeatNumthe amount of times that a single geographical point gets represented on the map
sizethe size
globeHidesPointwhether the point gets hidden on the far side of the earth
Returns
true if the geographical coordinates are visible on the screen false if the geographical coordinates are not visible on the screen
See also
ViewportParams

Implemented in Marble::MercatorProjection, Marble::EquirectProjection, Marble::SphericalProjection, Marble::AzimuthalEquidistantProjection, Marble::GnomonicProjection, Marble::LambertAzimuthalProjection, Marble::StereographicProjection, and Marble::VerticalPerspectiveProjection.

bool AbstractProjection::traversablePoles ( ) const
virtual

Returns whether the projection allows to navigate seamlessly "over" the pole.

Example: Azimuthal projections.

Reimplemented in Marble::CylindricalProjection, and Marble::AzimuthalProjection.

Definition at line 123 of file AbstractProjection.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Tue Oct 26 2021 23:21:26 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.