qgs3dmapsettings.h

Go to the documentation of this file.

/***************************************************************************
  qgs3dmapsettings.h
  --------------------------------------
  Date                 : July 2017
  Copyright            : (C) 2017 by Martin Dobias
  Email                : wonder dot sk at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGS3DMAPSETTINGS_H
#define QGS3DMAPSETTINGS_H
 
#include <memory>
 
#include "qgis_3d.h"
#include "qgs3daxissettings.h"
#include "qgsabstractterrainsettings.h"
#include "qgsambientocclusionsettings.h"
#include "qgscoordinatereferencesystem.h"
#include "qgsmaplayerref.h"
#include "qgsphongmaterialsettings.h"
#include "qgsshadowsettings.h"
#include "qgsskyboxsettings.h"
#include "qgstemporalrangeobject.h"
#include "qgsterraingenerator.h"
#include "qgsvector3d.h"
 
#include <QColor>
#include <QMatrix4x4>
#include <Qt3DRender/QCamera>
 
class QgsMapLayer;
class QgsRasterLayer;
class QgsLightSource;
class QgsAbstract3DRenderer;
class QgsReadWriteContext;
class QgsProject;
 
class QDomElement;

class _3D_EXPORT Qgs3DMapSettings : public QObject, public QgsTemporalRangeObject
{
    Q_OBJECT
  public:
    enum class BackgroundType
    {
      NoBackground,
      Gradient,
      Skybox,
    };
    Q_ENUM( BackgroundType )
 
    Qgs3DMapSettings();
    Qgs3DMapSettings( const Qgs3DMapSettings &other );
    ~Qgs3DMapSettings() override;
 
    Qgs3DMapSettings &operator=( Qgs3DMapSettings const & ) = delete;

    void readXml( const QDomElement &elem, const QgsReadWriteContext &context );
    QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ) const;
    void resolveReferences( const QgsProject &project );

    QgsRectangle extent() const;

    void setExtent( const QgsRectangle &extent );

    void setOrigin( const QgsVector3D &origin );

    QgsVector3D origin() const;

    QgsVector3D mapToWorldCoordinates( const QgsVector3D &mapCoords ) const;
    QgsVector3D worldToMapCoordinates( const QgsVector3D &worldCoords ) const;

    void setCrs( const QgsCoordinateReferenceSystem &crs );

    QgsCoordinateReferenceSystem crs() const;

    Qgis::SceneMode sceneMode() const;

    QgsCoordinateTransformContext transformContext() const;

    void setTransformContext( const QgsCoordinateTransformContext &context );

    const QgsPathResolver &pathResolver() const;

    void setPathResolver( const QgsPathResolver &resolver );

    QgsMapThemeCollection *mapThemeCollection() const;

    void setMapThemeCollection( QgsMapThemeCollection *mapThemes );

    void setBackgroundColor( const QColor &color );
    QColor backgroundColor() const;

    BackgroundType backgroundType() const;

    void setBackgroundType( BackgroundType type );

    void setGradientBackgroundTopColor( const QColor &color );

    QColor gradientBackgroundTopColor() const;

    void setGradientBackgroundBottomColor( const QColor &color );

    QColor gradientBackgroundBottomColor() const;

    void setSelectionColor( const QColor &color );
    QColor selectionColor() const;

    void setLayers( const QList<QgsMapLayer *> &layers );

    QList<QgsMapLayer *> layers() const;
 
    //
    // terrain related config
    //

    void configureTerrainFromProject( QgsProjectElevationProperties *properties, const QgsRectangle &fullExtent ) SIP_SKIP;

    const QgsAbstractTerrainSettings *terrainSettings() const;

    void setTerrainSettings( QgsAbstractTerrainSettings *settings SIP_TRANSFER );

    Q_DECL_DEPRECATED void setTerrainVerticalScale( double zScale ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED double terrainVerticalScale() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setMapTileResolution( int res ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED int mapTileResolution() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setMaxTerrainScreenError( double error ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED double maxTerrainScreenError() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setMaxTerrainGroundError( double error ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED double maxTerrainGroundError() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setTerrainElevationOffset( double offset ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED double terrainElevationOffset() const SIP_DEPRECATED;

    void setTerrainGenerator( QgsTerrainGenerator *gen SIP_TRANSFER ) SIP_SKIP;

    QgsTerrainGenerator *terrainGenerator() const SIP_SKIP;

    void setTerrainShadingEnabled( bool enabled );

    bool isTerrainShadingEnabled() const;

    void setTerrainShadingMaterial( const QgsPhongMaterialSettings &material );

    QgsPhongMaterialSettings terrainShadingMaterial() const;

    void setTerrainMapTheme( const QString &theme );

    QString terrainMapTheme() const;
 
    //
    // misc configuration
    //

    void setShowTerrainBoundingBoxes( bool enabled );
    bool showTerrainBoundingBoxes() const;
    void setShowTerrainTilesInfo( bool enabled );
    bool showTerrainTilesInfo() const;

    void setShowCameraViewCenter( bool enabled );

    bool showCameraViewCenter() const;

    void setShowCameraRotationCenter( bool enabled );

    bool showCameraRotationCenter() const;

    void setShowLightSourceOrigins( bool enabled );

    bool showLightSourceOrigins() const;

    void setShowLabels( bool enabled );
    bool showLabels() const;

    void setEyeDomeLightingEnabled( bool enabled );
    bool eyeDomeLightingEnabled() const;

    void setEyeDomeLightingStrength( double strength );
    double eyeDomeLightingStrength() const;

    void setEyeDomeLightingDistance( int distance );
    int eyeDomeLightingDistance() const;

    void setStopUpdates( bool enabled );

    bool stopUpdates() const;

    void setDebugShadowMapSettings( bool enabled, Qt::Corner corner, double size );
    bool debugShadowMapEnabled() const;
    Qt::Corner debugShadowMapCorner() const;
    double debugShadowMapSize() const;

    void setDebugDepthMapSettings( bool enabled, Qt::Corner corner, double size );
    bool debugDepthMapEnabled() const;
    Qt::Corner debugDepthMapCorner() const;
    double debugDepthMapSize() const;

    QList<QgsLightSource *> lightSources() const;

    void setLightSources( const QList<QgsLightSource *> &lights SIP_TRANSFER );

    float fieldOfView() const;

    void setFieldOfView( const float fieldOfView );

    Qt3DRender::QCameraLens::ProjectionType projectionType() const SIP_SKIP;

    void setProjectionType( const Qt3DRender::QCameraLens::ProjectionType projectionType ) SIP_SKIP;
 
#ifndef SIP_RUN

    Qgis::NavigationMode cameraNavigationMode() const;

    void setCameraNavigationMode( Qgis::NavigationMode navigationMode );
#endif

    double cameraMovementSpeed() const;

    void setCameraMovementSpeed( double movementSpeed );

    void setOutputDpi( const double dpi );

    double outputDpi() const;

    QgsSkyboxSettings skyboxSettings() const SIP_SKIP;

    QgsShadowSettings shadowSettings() const SIP_SKIP;

    QgsAmbientOcclusionSettings ambientOcclusionSettings() const SIP_SKIP;

    void setSkyboxSettings( const QgsSkyboxSettings &skyboxSettings ) SIP_SKIP;

    void setShadowSettings( const QgsShadowSettings &shadowSettings ) SIP_SKIP;

    void setAmbientOcclusionSettings( const QgsAmbientOcclusionSettings &ambientOcclusionSettings ) SIP_SKIP;

    Q_DECL_DEPRECATED bool isSkyboxEnabled() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setIsSkyboxEnabled( bool enabled ) SIP_DEPRECATED;
    bool isFpsCounterEnabled() const;

    void setIsFpsCounterEnabled( bool fpsCounterEnabled );

    bool terrainRenderingEnabled() const;

    void setTerrainRenderingEnabled( bool terrainRenderingEnabled );

    Qgis::RendererUsage rendererUsage() const;

    void setRendererUsage( Qgis::RendererUsage rendererUsage );

    Qgis::ViewSyncModeFlags viewSyncMode() const;

    void setViewSyncMode( Qgis::ViewSyncModeFlags mode );

    bool viewFrustumVisualizationEnabled() const;

    void setViewFrustumVisualizationEnabled( bool enabled );

    Qgs3DAxisSettings get3DAxisSettings() const SIP_SKIP;

    void set3DAxisSettings( const Qgs3DAxisSettings &axisSettings, bool force = false ) SIP_SKIP;

    bool isDebugOverlayEnabled() const;

    void setIsDebugOverlayEnabled( bool debugOverlayEnabled );

    bool showExtentIn2DView() const;

    void setShowExtentIn2DView( bool show );

    void setShowDebugPanel( bool enabled );

    bool showDebugPanel() const;

    bool is2DMapOverlayEnabled() const;

    void setIs2DMapOverlayEnabled( bool enabled );

    void setMsaaEnabled( bool enabled );

    bool isMsaaEnabled() const;
 
  signals:

    void settingsChanged();

    void backgroundColorChanged();
    void selectionColorChanged();

    void layersChanged();

    void terrainGeneratorChanged();

    void terrainSettingsChanged();

    Q_DECL_DEPRECATED void terrainVerticalScaleChanged() SIP_DEPRECATED;

    Q_DECL_DEPRECATED void mapTileResolutionChanged() SIP_DEPRECATED;

    Q_DECL_DEPRECATED void maxTerrainScreenErrorChanged() SIP_DEPRECATED;

    Q_DECL_DEPRECATED void maxTerrainGroundErrorChanged() SIP_DEPRECATED;

    Q_DECL_DEPRECATED void terrainElevationOffsetChanged( double newElevation ) SIP_DEPRECATED;

    void terrainShadingChanged();

    void terrainMapThemeChanged();

    void renderersChanged();

    void showTerrainBoundingBoxesChanged();
    void showTerrainTilesInfoChanged();

    void showCameraViewCenterChanged();

    void showCameraRotationCenterChanged();

    void showLightSourceOriginsChanged();

    void showLabelsChanged();

    void stopUpdatesChanged();

    void eyeDomeLightingEnabledChanged();

    void eyeDomeLightingStrengthChanged();

    void eyeDomeLightingDistanceChanged();

    void msaaEnabledChanged();

    void debugShadowMapSettingsChanged();

    void debugDepthMapSettingsChanged();

    void pointLightsChanged();

    void lightSourcesChanged();

    void directionalLightsChanged();

    void fieldOfViewChanged();

    void projectionTypeChanged();

    void cameraNavigationModeChanged();

    void cameraMovementSpeedChanged();

    void skyboxSettingsChanged();

    void shadowSettingsChanged();
 

    void ambientOcclusionSettingsChanged();

    void fpsCounterEnabledChanged( bool fpsCounterEnabled );

    void viewFrustumVisualizationEnabledChanged();

    void axisSettingsChanged();

    void debugOverlayEnabledChanged( bool debugOverlayEnabled );

    void extentChanged();

    void showExtentIn2DViewChanged();

    void showDebugPanelChanged( bool shown );

    void originChanged();

    void show2DMapOverlayChanged();

    void backgroundTypeChanged();
 
  private:
#ifdef SIP_RUN
    Qgs3DMapSettings &operator=( const Qgs3DMapSettings & );
#endif
 
  private:
    void connectChangedSignalsToSettingsChanged();
 
  private:
    QgsVector3D mOrigin;
    QgsCoordinateReferenceSystem mCrs;                      
    QColor mBackgroundColor = Qt::black;                    
    QColor mSelectionColor;                                 
    std::unique_ptr<QgsTerrainGenerator> mTerrainGenerator; 
    std::unique_ptr<QgsAbstractTerrainSettings> mTerrainSettings;
    bool mTerrainShadingEnabled = false;              
    QgsPhongMaterialSettings mTerrainShadingMaterial; 
    QString mTerrainMapTheme;                         
    bool mShowTerrainBoundingBoxes = false;           
    bool mShowTerrainTileInfo = false;                
    bool mShowCameraViewCenter = false;               
    bool mShowCameraRotationCenter = false;           
    bool mShowLightSources = false;                   
    bool mShowLabels = false;                         
    bool mStopUpdates = false;                        
    bool mShowDebugPanel = false;                     
    QList<QgsLightSource *> mLightSources;            
    float mFieldOfView = 45.0f;                       //<! Camera lens field of view value
    Qt3DRender::QCameraLens::ProjectionType mProjectionType = Qt3DRender::QCameraLens::PerspectiveProjection; //<! Camera lens projection type
    Qgis::NavigationMode mCameraNavigationMode = Qgis::NavigationMode::TerrainBased;
    double mCameraMovementSpeed = 5.0;
    QList<QgsMapLayerRef> mLayers; 
    QgsCoordinateTransformContext mTransformContext;
    QgsPathResolver mPathResolver;
    QgsMapThemeCollection *mMapThemes = nullptr; 
    double mDpi = 96;                            
    bool mIsFpsCounterEnabled = false;
 
    BackgroundType mBackgroundType = BackgroundType::NoBackground;
    QColor mGradientBackgroundTopColor = QColor( 0, 128, 255 );
    QColor mGradientBackgroundBottomColor = Qt::black;
 
    QgsSkyboxSettings mSkyboxSettings;                     
    QgsShadowSettings mShadowSettings;                     
    QgsAmbientOcclusionSettings mAmbientOcclusionSettings; 
 
    bool mEyeDomeLightingEnabled = false;
    double mEyeDomeLightingStrength = 1000.0;
    int mEyeDomeLightingDistance = 1;
 
    bool mMsaaEnabled = false;
 
    Qgis::ViewSyncModeFlags mViewSyncMode;
    bool mVisualizeViewFrustum = false;
 
    bool mDebugShadowMapEnabled = false;
    Qt::Corner mDebugShadowMapCorner = Qt::Corner::TopLeftCorner;
    double mDebugShadowMapSize = 0.2;
 
    bool mDebugDepthMapEnabled = false;
    Qt::Corner mDebugDepthMapCorner = Qt::Corner::BottomLeftCorner;
    double mDebugDepthMapSize = 0.2;
 
    bool mTerrainRenderingEnabled = true;
 
    Qgis::RendererUsage mRendererUsage;
 
    Qgs3DAxisSettings m3dAxisSettings; 
 
    bool mIsDebugOverlayEnabled = false;
 
    QgsRectangle mExtent; 
 
    bool mShowExtentIn2DView = false;
 
    bool mShow2DMapOverlay = false;
};
 
 
#endif // QGS3DMAPSETTINGS_H