qgs3dmapscene.h

Go to the documentation of this file.

/***************************************************************************
  qgs3dmapscene.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 QGS3DMAPSCENE_H
#define QGS3DMAPSCENE_H
 
#include "qgis_3d.h"
#include "qgsmapoverlayentity.h"
#include "qgsrectangle.h"
#include "qobjectuniqueptr.h"
 
#include <QVector4D>
#include <Qt3DCore/QEntity>
 
#ifndef SIP_RUN
namespace Qt3DRender
{
  class QRenderSettings;
  class QCamera;
} // namespace Qt3DRender
 
namespace Qt3DLogic
{
  class QFrameAction;
}
 
namespace Qt3DExtras
{
  class QForwardRenderer;
  class QSkyboxEntity;
} // namespace Qt3DExtras
#endif
 
 
class Qgs3DAxis;
class QgsAbstract3DEngine;
class QgsAbstract3DRenderer;
class QgsMapLayer;
class Qgs3DMapSettings;
class QgsTerrainEntity;
class QgsGlobeEntity;
class QgsChunkedEntity;
class QgsSkyboxEntity;
class QgsSkyboxSettings;
class QgsGradientBackgroundEntity;
class Qgs3DMapExportSettings;
class QgsChunkNode;
class QgsDoubleRange;
class Qgs3DMapSceneEntity;
class QgsCameraController;
 

#ifndef SIP_RUN
class _3D_EXPORT Qgs3DMapScene : public Qt3DCore::QEntity
{
#else
class _3D_EXPORT Qgs3DMapScene : public QObject
{
#endif
 
    Q_OBJECT
  public:
    Qgs3DMapScene( Qgs3DMapSettings &map, QgsAbstract3DEngine *engine ) SIP_SKIP;

    QgsCameraController *cameraController() const { return mCameraController; }

    QgsTerrainEntity *terrainEntity() SIP_SKIP { return mTerrain; }

    QgsGlobeEntity *globeEntity() SIP_SKIP { return mGlobe; }

    void viewZoomFull();

    void setViewFrom2DExtent( const QgsRectangle &extent );

    QVector<QgsPointXY> viewFrustum2DExtent() const;

    int totalPendingJobsCount() const;

    enum SceneState
    {
      Ready,    
      Updating, 
    };

    SceneState sceneState() const { return mSceneState; }

    double worldSpaceError( double epsilon, double distance ) const;

    bool exportScene( const Qgs3DMapExportSettings &exportSettings );

    QVector<const QgsChunkNode *> getLayerActiveChunkNodes( QgsMapLayer *layer ) SIP_SKIP;

    QList<QgsMapLayer *> layers() const SIP_SKIP { return mLayerEntities.keys(); }

    Qt3DCore::QEntity *layerEntity( QgsMapLayer *layer ) const SIP_SKIP { return mLayerEntities.value( layer ); }

    QgsRectangle sceneExtent() const;

    QgsDoubleRange elevationRange( bool ignoreTerrain = false ) const;

    Qgs3DAxis *get3DAxis() const SIP_SKIP { return m3DAxis; }

    QgsAbstract3DEngine *engine() const SIP_SKIP { return mEngine; }

    Qgs3DMapSettings *mapSettings() const { return &mMap; }

    bool hasSceneUpdatesEnabled() const { return mSceneUpdatesEnabled; }

    void setSceneUpdatesEnabled( bool enabled ) { mSceneUpdatesEnabled = enabled; }

    bool hasSceneOriginShiftEnabled() const { return mSceneOriginShiftEnabled; }

    void setSceneOriginShiftEnabled( bool enabled ) { mSceneOriginShiftEnabled = enabled; }

    Q_DECL_DEPRECATED static QMap<QString, Qgs3DMapScene *> openScenes() SIP_DEPRECATED;

    void enableClipping( const QList<QVector4D> &clipPlaneEquations );

    void disableClipping();

    void addSceneEntity( Qgs3DMapSceneEntity *entity ) SIP_SKIP;

    void removeSceneEntity( Qgs3DMapSceneEntity *entity ) SIP_SKIP;

    QList<QVector4D> clipPlaneEquations() const { return mClipPlanesEquations; };
 
#ifndef SIP_RUN
    static std::function<QMap<QString, Qgs3DMapScene *>()> sOpenScenesFunction;
#endif
 
  signals:
    void terrainEntityChanged();

    void totalPendingJobsCountChanged();
    void sceneStateChanged();

    void fpsCountChanged( float fpsCount );
    void fpsCounterEnabledChanged( bool fpsCounterEnabled );

    void viewed2DExtentFrom3DChanged( QVector<QgsPointXY> extent );

    void gpuMemoryLimitReached();
 
  public slots:
    void updateTemporal();
 
  private slots:
    void onCameraChanged();
    void onFrameTriggered( float dt );
    void createTerrain();
    void onLayerRenderer3DChanged();
    void onLayersChanged();
    void createTerrainDeferred();
    void onBackgroundColorChanged();
    void updateLights();
    void updateCameraLens();
    void onBackgroundSettingsChanged();
    void onShadowSettingsChanged();
    void onAmbientOcclusionSettingsChanged();
    void onEyeDomeShadingSettingsChanged();
    void onMsaaEnabledChanged();
    void onDebugShadowMapSettingsChanged();
    void onDebugDepthMapSettingsChanged();
    void onCameraMovementSpeedChanged();
    void onCameraNavigationModeChanged();
    void onDebugOverlayEnabledChanged();
    void onStopUpdatesChanged();
    void on3DAxisSettingsChanged();
    void onShowMapOverlayChanged();
 
    void onOriginChanged();
 
    bool updateCameraNearFarPlanes();
 
    void applyPendingOverlayUpdate();
 
  private:
#ifdef SIP_RUN
    Qgs3DMapScene();
    Qgs3DMapScene( const Qgs3DMapScene &other );
#endif
 
    void addLayerEntity( QgsMapLayer *layer );
    void removeLayerEntity( QgsMapLayer *layer );
    void addCameraViewCenterEntity( Qt3DRender::QCamera *camera );
    void addCameraRotationCenterEntity( QgsCameraController *controller );
    void setSceneState( SceneState state );
    void updateSceneState();
    bool updateScene( bool forceUpdate = false );
    void finalizeNewEntity( Qt3DCore::QEntity *newEntity );
    int maximumTextureSize() const;
 
    void handleClippingOnEntity( QEntity *entity ) const;
    void handleClippingOnAllEntities() const;
 
    void schedule2DMapOverlayUpdate();
    void update2DMapOverlay( const QVector<QgsPointXY> &extent2DAsPoints );
 
  private:
    Qgs3DMapSettings &mMap;
    QgsAbstract3DEngine *mEngine = nullptr;
    Qt3DLogic::QFrameAction *mFrameAction = nullptr;
    QgsCameraController *mCameraController = nullptr;
    QgsTerrainEntity *mTerrain = nullptr;
    QgsGlobeEntity *mGlobe = nullptr;
    QList<Qgs3DMapSceneEntity *> mSceneEntities;
    Qt3DCore::QEntity *mEntityCameraViewCenter = nullptr;
    QMap<QgsMapLayer *, Qt3DCore::QEntity *> mLayerEntities;
    bool mTerrainUpdateScheduled = false;
    SceneState mSceneState = Ready;
    QList<Qt3DCore::QEntity *> mLightEntities;
    QList<QgsMapLayer *> mModelVectorLayers;
    Qt3DCore::QEntity *mBackgroundEntity = nullptr; // used for skybox and gradient background
    Qt3DCore::QEntity *mEntityRotationCenter = nullptr;

    Qgs3DAxis *m3DAxis = nullptr;
 
    bool mSceneUpdatesEnabled = true;
    bool mSceneOriginShiftEnabled = true;
 
    QList<QVector4D> mClipPlanesEquations;
    int mMaxClipPlanes = 6;

    QObjectUniquePtr<QgsMapOverlayEntity> mMapOverlayEntity = nullptr;
    QTimer *mOverlayUpdateTimer = nullptr;
 
    friend class TestQgs3DRendering;
};
#endif // QGS3DMAPSCENE_H