MarbleMap.h

Go to the documentation of this file.

//
// This file is part of the Marble Virtual Globe.
//
// This program is free software licensed under the GNU LGPL. You can
// find a copy of this license in LICENSE.txt in the top directory of
// the source code.
//
// Copyright 2006-2008 Torsten Rahn <tackat@kde.org>
// Copyright 2007      Inge Wallin  <ingwa@kde.org>
// Copyright 2009      Jens-Michael Hoffmann <jensmh@gmx.de>
//

#ifndef MARBLE_MARBLEMAP_H
#define MARBLE_MARBLEMAP_H


#include <QSize>
#include <QString>
#include <QObject>
#include <QFont>
#include <QPixmap>

#include "marble_export.h"
#include "GeoDataCoordinates.h"       // In geodata/data/

// Qt
class QAbstractItemModel;
class QItemSelectionModel;

namespace Marble
{

// MarbleMap 
class MarbleMapPrivate;

// Marble
class GeoDataLatLonAltBox;
class GeoDataPlacemark;
class MarbleModel;
class ViewportParams;
class GeoPainter;
class LayerInterface;
class Quaternion;
class RenderPlugin;
class AbstractDataPlugin;
class AbstractDataPluginItem;
class AbstractFloatItem;
class TextureLayer;
class TileCoordsPyramid;

class MARBLE_EXPORT MarbleMap : public QObject
{
    Q_OBJECT
    Q_CLASSINFO("D-Bus Interface", "org.kde.MarbleMap")

 public:

    friend class MarbleWidget;

    MarbleMap();

    explicit MarbleMap( MarbleModel *model );

    virtual ~MarbleMap();

    MarbleModel *model() const;

    // Accessors to internal objects;
    ViewportParams *viewport();
    const ViewportParams *viewport() const;

    Projection projection() const;

    QString mapThemeId() const;

    void setMapQualityForViewContext( MapQuality qualityForViewContext, ViewContext viewContext );
    MapQuality mapQuality( ViewContext viewContext ) const;

    MapQuality mapQuality() const;

    void setViewContext( ViewContext viewContext );
    ViewContext viewContext() const;

    void setSize( int width, int height );
    void setSize( const QSize& size );
    QSize size() const;
    int width() const;
    int height() const;

    int radius() const;

    int preferredRadiusCeil( int radius );
    int preferredRadiusFloor( int radius );

    int tileZoomLevel() const;

    int minimumZoom() const;

    int maximumZoom() const;

    bool screenCoordinates( qreal lon, qreal lat,
                            qreal& x, qreal& y ) const;

    bool geoCoordinates( int x, int y,
                         qreal& lon, qreal& lat,
                         GeoDataCoordinates::Unit = GeoDataCoordinates::Degree ) const;

    qreal centerLongitude() const;

    qreal centerLatitude() const;

    QVector<const GeoDataPlacemark*> whichFeatureAt( const QPoint& ) const;

    bool propertyValue( const QString& name ) const;

    bool showOverviewMap() const;

    bool showScaleBar() const;

    bool showCompass() const;

    bool showClouds() const;

    bool showSunShading() const;

    bool showCityLights() const;

    bool isLockedToSubSolarPoint() const;

    bool isSubSolarPointIconVisible() const;

    bool showAtmosphere() const;

    bool showCrosshairs() const;

    bool showGrid() const;

    bool showPlaces() const;

    bool showCities() const;

    bool showTerrain() const;

    bool showOtherPlaces() const;

    bool showRelief() const;

    bool showIceLayer() const;

    bool showBorders() const;

    bool showRivers() const;

    bool showLakes() const;

    bool showFrameRate() const;

    bool showBackground() const;

    quint64 volatileTileCacheLimit() const;

    QList<RenderPlugin *> renderPlugins() const;
    QList<AbstractFloatItem *> floatItems() const;

    AbstractFloatItem * floatItem( const QString &nameId ) const;

    QList<AbstractDataPlugin *> dataPlugins()  const;

    QList<AbstractDataPluginItem *> whichItemAt( const QPoint& curpos ) const;

    AngleUnit defaultAngleUnit() const;

    QFont defaultFont() const;

    const TextureLayer *textureLayer() const;

    void addLayer( LayerInterface *layer );

    void removeLayer( LayerInterface *layer );

 public Q_SLOTS:

    void paint( GeoPainter &painter, const QRect &dirtyRect );

    void setRadius( int radius );

    void rotateBy( const qreal &deltaLon, const qreal &deltaLat );

    void centerOn( const qreal lon, const qreal lat );

    void setCenterLatitude( qreal lat );

    void setCenterLongitude( qreal lon );

    void setProjection( Projection projection );

    void setMapThemeId( const QString& maptheme );

    void setPropertyValue( const QString& name, bool value );

    void setShowOverviewMap( bool visible );

    void setShowScaleBar( bool visible );

    void setShowCompass( bool visible );

    void setShowClouds( bool visible );

    void setShowSunShading( bool visible );

    void setShowCityLights( bool visible );

    void setLockToSubSolarPoint( bool visible );

    void setSubSolarPointIconVisible( bool visible );

    void setShowTileId( bool visible );

    void setShowAtmosphere( bool visible );

    void setShowCrosshairs( bool visible );

    void setShowGrid( bool visible );

    void setShowPlaces( bool visible );

    void setShowCities( bool visible );

    void setShowTerrain( bool visible );

    void setShowOtherPlaces( bool visible );

    void setShowRelief( bool visible );

    void setShowIceLayer( bool visible );

    void setShowBorders( bool visible );

    void setShowRivers( bool visible );

    void setShowLakes( bool visible );

    void setShowFrameRate( bool visible );

    void setShowRuntimeTrace( bool visible );

    void setShowBackground( bool visible );

    void notifyMouseClick( int x, int y );

    void clearVolatileTileCache();
    void setVolatileTileCacheLimit( quint64 kiloBytes );

    void setDefaultAngleUnit( AngleUnit angleUnit );

    void setDefaultFont( const QFont& font );

    void reload();

    void downloadRegion( QVector<TileCoordsPyramid> const & );

 Q_SIGNALS:
    void tileLevelChanged( int level );

    void themeChanged( const QString& theme );

    void projectionChanged( Projection );

    void radiusChanged( int radius );

    void mouseMoveGeoPosition( const QString& );

    void mouseClickGeoPosition( qreal lon, qreal lat, GeoDataCoordinates::Unit );

    void framesPerSecond( qreal fps );

    void repaintNeeded( const QRegion& dirtyRegion = QRegion() );

    void visibleLatLonAltBoxChanged( const GeoDataLatLonAltBox& visibleLatLonAltBox );

    void pluginSettingsChanged();

    void renderPluginInitialized( RenderPlugin *renderPlugin );

 protected:

    virtual void customPaint( GeoPainter *painter );

 private:
    Q_PRIVATE_SLOT( d, void updateMapTheme() )
    Q_PRIVATE_SLOT( d, void updateProperty( const QString &, bool ) )
    Q_PRIVATE_SLOT( d, void setDocument(QString) )

 private:
    Q_DISABLE_COPY( MarbleMap )
    MarbleMapPrivate * const d;
    friend class MarbleMapPrivate;

    class CustomPaintLayer;
    friend class CustomPaintLayer;
};

}

#endif