MarbleWidget.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>
//

#ifndef MARBLE_MARBLEWIDGET_H
#define MARBLE_MARBLEWIDGET_H


#include <QPixmap>
#include <QWidget>

#include "GeoDataCoordinates.h"
#include "GeoDataLookAt.h"
#include "MarbleGlobal.h"             // types needed in all of marble.
#include "marble_export.h"
#include "GeoDataFolder.h"
#include "RenderState.h"

// Qt
class QAbstractItemModel;
class QItemSelectionModel;
class QSettings;

namespace Marble
{

class AbstractDataPluginItem;
class AbstractFloatItem;
class GeoDataLatLonAltBox;
class GeoDataLatLonBox;
class GeoPainter;
class GeoSceneDocument;
class LayerInterface;
class MarbleModel;
class MarbleWidgetPopupMenu;
class MarbleWidgetInputHandler;
class MarbleWidgetPrivate;
class Quaternion;
class RenderPlugin;
class RoutingLayer;
class TextureLayer;
class TileCoordsPyramid;
class TileCreator;
class GeoDataPlacemark;
class ViewportParams;
class PopupLayer;

class MARBLE_EXPORT MarbleWidget : public QWidget
{
    Q_OBJECT
#ifdef MARBLE_DBUS
    Q_CLASSINFO("D-Bus Interface", "org.kde.MarbleWidget")
#endif

    Q_PROPERTY(int zoom          READ zoom            WRITE setZoom)

    Q_PROPERTY(QString mapThemeId  READ mapThemeId    WRITE setMapThemeId)
    Q_PROPERTY(int projection    READ projection      WRITE setProjection)

    Q_PROPERTY(qreal longitude  READ centerLongitude WRITE setCenterLongitude)
    Q_PROPERTY(qreal latitude   READ centerLatitude  WRITE setCenterLatitude)

    Q_PROPERTY(bool showOverviewMap READ showOverviewMap    WRITE setShowOverviewMap)
    Q_PROPERTY(bool showScaleBar READ showScaleBar    WRITE setShowScaleBar)
    Q_PROPERTY(bool showCompass  READ showCompass     WRITE setShowCompass)
    Q_PROPERTY(bool showGrid     READ showGrid        WRITE setShowGrid)

    Q_PROPERTY(bool showClouds   READ showClouds      WRITE setShowClouds)
    Q_PROPERTY(bool showSunShading READ showSunShading WRITE setShowSunShading)
    Q_PROPERTY(bool showCityLights READ showCityLights WRITE setShowCityLights)
    Q_PROPERTY(bool isLockedToSubSolarPoint READ isLockedToSubSolarPoint WRITE setLockToSubSolarPoint)
    Q_PROPERTY(bool isSubSolarPointIconVisible READ isSubSolarPointIconVisible WRITE setSubSolarPointIconVisible)
    Q_PROPERTY(bool showAtmosphere READ showAtmosphere WRITE setShowAtmosphere)
    Q_PROPERTY(bool showCrosshairs READ showCrosshairs WRITE setShowCrosshairs)

    Q_PROPERTY(bool showPlaces   READ showPlaces      WRITE setShowPlaces)
    Q_PROPERTY(bool showCities   READ showCities      WRITE setShowCities)
    Q_PROPERTY(bool showTerrain  READ showTerrain     WRITE setShowTerrain)
    Q_PROPERTY(bool showOtherPlaces READ showOtherPlaces WRITE setShowOtherPlaces)

    Q_PROPERTY(bool showRelief   READ showRelief      WRITE setShowRelief)

    Q_PROPERTY(bool showIceLayer READ showIceLayer    WRITE setShowIceLayer)
    Q_PROPERTY(bool showBorders  READ showBorders     WRITE setShowBorders)
    Q_PROPERTY(bool showRivers   READ showRivers      WRITE setShowRivers)
    Q_PROPERTY(bool showLakes    READ showLakes       WRITE setShowLakes)

    Q_PROPERTY( RenderStatus renderStatus READ renderStatus NOTIFY renderStatusChanged )

    Q_PROPERTY(quint64 volatileTileCacheLimit    READ volatileTileCacheLimit    WRITE setVolatileTileCacheLimit)

 public:

    explicit MarbleWidget( QWidget *parent = 0 );

    virtual ~MarbleWidget();



    MarbleModel *model();
    const MarbleModel *model() const;

    ViewportParams *viewport();
    const ViewportParams *viewport() const;

    MarbleWidgetPopupMenu *popupMenu();

    MarbleWidgetInputHandler *inputHandler() const;

    void setInputHandler( MarbleWidgetInputHandler *handler );

    QList<RenderPlugin *> renderPlugins() const;

    QList<AbstractFloatItem *> floatItems() const;

    AbstractFloatItem * floatItem( const QString &nameId ) const;

    void readPluginSettings( QSettings& settings );

    void writePluginSettings( QSettings& settings ) const;

    ViewContext viewContext() const;

    GeoSceneDocument * mapTheme() const;

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

    void addLayer( LayerInterface *layer );

    void removeLayer( LayerInterface *layer );

    RoutingLayer* routingLayer();

    PopupLayer* popupLayer();

    Projection projection() const;
//    int projection() const;




    QString mapThemeId() const;

    QRegion mapRegion() const;

    int radius() const;

    int zoom() const;

    int tileZoomLevel() const;

    qreal distance() const;

    QString distanceString() 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;

    qreal moveStep() const;

    GeoDataLookAt lookAt() const;

    GeoDataCoordinates focusPoint() const;

    void setFocusPoint( const GeoDataCoordinates &focusPoint );

    void resetFocusPoint();

    qreal radiusFromDistance( qreal distance ) const;

    qreal distanceFromRadius( qreal radius ) const;

    qreal zoomFromDistance( qreal distance ) const;

    qreal distanceFromZoom( qreal zoom ) const;




    QVector<const GeoDataPlacemark*> whichFeatureAt( const QPoint& ) 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;

    MapQuality mapQuality( ViewContext = Still ) const;

    bool animationsEnabled() const;

    AngleUnit defaultAngleUnit() const;
    void setDefaultAngleUnit( AngleUnit angleUnit );

    QFont defaultFont() const;
    void setDefaultFont( const QFont& font );




    quint64 volatileTileCacheLimit() const;




    QPixmap mapScreenShot();


    // @deprecated Please use setZoom
    //MARBLE_DEPRECATED( void zoomView( int zoom, FlyToMode mode = Instant ) );

    RenderStatus renderStatus() const;

    RenderState renderState() const;

 public Q_SLOTS:



    void setRadius( int radius );

    void setZoom( int zoom, FlyToMode mode = Instant );

    void zoomView( int zoom, FlyToMode mode = Instant );

    void zoomViewBy( int zoomStep, FlyToMode mode = Instant );

    void zoomIn( FlyToMode mode = Automatic );
    void zoomOut( FlyToMode mode = Automatic );

    void setDistance( qreal distance );

    void rotateBy( const qreal deltaLon, const qreal deltaLat, FlyToMode mode = Instant );

    void centerOn( const qreal lon, const qreal lat, bool animated = false );

    void centerOn( const GeoDataCoordinates &point, bool animated = false );

    void centerOn( const GeoDataLatLonBox& box, bool animated = false );

    void centerOn( const GeoDataPlacemark& placemark, bool animated = false );

    void setCenterLatitude( qreal lat, FlyToMode mode = Instant );

    void setCenterLongitude( qreal lon, FlyToMode mode = Instant );

    void moveLeft( FlyToMode mode = Automatic );

    void moveRight( FlyToMode mode = Automatic );

    void moveUp( FlyToMode mode = Automatic );

    void moveDown( FlyToMode mode = Automatic );

    void goHome( FlyToMode mode = Automatic );

    void flyTo( const GeoDataLookAt &lookAt, FlyToMode mode = Automatic );




    void setProjection( int        projection );
    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 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 setShowBackground( bool visible );

    void setShowTileId( bool visible );

    void setShowRuntimeTrace( bool visible );

    void setMapQualityForViewContext( MapQuality quality, ViewContext viewContext );

    void setViewContext( ViewContext viewContext );

    void setAnimationsEnabled( bool enabled );




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

    void creatingTilesStart( TileCreator *creator, const QString& name, const QString& description );

    void reloadMap();

    void downloadRegion( QVector<TileCoordsPyramid> const & );




    void notifyMouseClick( int x, int y );

    void setSelection( const QRect& region );

    void setInputEnabled( bool );

    TextureLayer *textureLayer() const;


 Q_SIGNALS:
    void zoomChanged( int zoom );
    void distanceChanged( const QString& distanceString );

    void tileLevelChanged( int level );

    void themeChanged( const QString& theme );

    void projectionChanged( Projection );

    void mouseMoveGeoPosition( const QString& );

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

    void framesPerSecond( qreal fps );

    void regionSelected( const QList<double>& );

    void pluginSettingsChanged();
    
    void renderPluginInitialized( RenderPlugin *renderPlugin );

    void visibleLatLonAltBoxChanged( const GeoDataLatLonAltBox& visibleLatLonAltBox );

    void renderStatusChanged( RenderStatus status );

    void renderStateChanged( const RenderState &state );

 protected:
    virtual void leaveEvent( QEvent *event );

    virtual void paintEvent( QPaintEvent *event );

    virtual void resizeEvent( QResizeEvent *event );

#if QT_VERSION < 0x050000
    void connectNotify( const char * signal );
    void disconnectNotify( const char * signal );
#else
    virtual void connectNotify(const QMetaMethod &signal);
    virtual void disconnectNotify(const QMetaMethod &signal);
#endif

    virtual void changeEvent( QEvent * event );

    virtual void customPaint( GeoPainter *painter );

 private:
    Q_PRIVATE_SLOT( d, void updateMapTheme() )
    Q_PRIVATE_SLOT( d, void updateSystemBackgroundAttribute() )

 private:
    Q_DISABLE_COPY( MarbleWidget )
    MarbleWidgetPrivate  * const d;
    friend class MarbleWidgetPrivate;

    class CustomPaintLayer;
    friend class CustomPaintLayer;

    friend class MarbleWidgetDefaultInputHandler;
};

}

#endif