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 <Qt3DCore/QEntity>
 
#include "qgsfeatureid.h"
#include "qgsshadowrenderingframegraph.h"
#include "qgsray3d.h"
#include "qgscameracontroller.h"
 
#ifndef SIP_RUN
namespace Qt3DRender
{
  class QRenderSettings;
  class QCamera;
  class QPickEvent;
  class QObjectPicker;
}
 
namespace Qt3DLogic
{
  class QFrameAction;
}
 
namespace Qt3DExtras
{
  class QForwardRenderer;
  class QSkyboxEntity;
}
#endif
 
 
class Qgs3DAxis;
class QgsAbstract3DEngine;
class QgsAbstract3DRenderer;
class QgsMapLayer;
class Qgs3DMapScenePickHandler;
class Qgs3DMapSettings;
class QgsTerrainEntity;
class QgsChunkedEntity;
class QgsSkyboxEntity;
class QgsSkyboxSettings;
class Qgs3DMapExportSettings;
class QgsShadowRenderingFrameGraph;
class QgsPostprocessingEntity;
class QgsChunkNode;
class QgsDoubleRange;
 
#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() { return mCameraController; }
 
    QgsTerrainEntity *terrainEntity() SIP_SKIP { return mTerrain; }
 
    void viewZoomFull();
 
    void setViewFrom2DExtent( const QgsRectangle &extent );
 
    QVector<QgsPointXY> viewFrustum2DExtent();
 
    int terrainPendingJobsCount() const;
 
    int totalPendingJobsCount() const;
 
    enum SceneState
    {
      Ready,     
      Updating,  
    };
 
    SceneState sceneState() const { return mSceneState; }
 
    void registerPickHandler( Qgs3DMapScenePickHandler *pickHandler ) SIP_SKIP;
    void unregisterPickHandler( Qgs3DMapScenePickHandler *pickHandler ) SIP_SKIP;
 
    float worldSpaceError( float epsilon, float distance );
 
    void exportScene( const Qgs3DMapExportSettings &exportSettings );
 
    QVector<const QgsChunkNode *> getLayerActiveChunkNodes( QgsMapLayer *layer ) SIP_SKIP;
 
    QgsRectangle sceneExtent();
 
    QgsDoubleRange elevationRange() const;
 
    Qgs3DAxis *get3DAxis() SIP_SKIP { return m3DAxis; }
 
    QgsAbstract3DEngine *engine() SIP_SKIP { return mEngine; }
 
    Qgs3DMapSettings *mapSettings() const { return &mMap; }
 
    static QMap< QString, Qgs3DMapScene * > openScenes();
 
#ifndef SIP_RUN
    static std::function< QMap< QString, Qgs3DMapScene * >() > sOpenScenesFunction;
#endif
 
  signals:
    void terrainEntityChanged();
    void terrainPendingJobsCountChanged();
 
    void totalPendingJobsCountChanged();
    void sceneStateChanged();
 
    void fpsCountChanged( float fpsCount );
    void fpsCounterEnabledChanged( bool fpsCounterEnabled );
 
    void viewed2DExtentFrom3DChanged( QVector<QgsPointXY> extent );
 
  public slots:
    void updateTemporal();
 
  private slots:
    void onCameraChanged();
    void onFrameTriggered( float dt );
    void createTerrain();
    void onLayerRenderer3DChanged();
    void onLayersChanged();
    void createTerrainDeferred();
    void onBackgroundColorChanged();
    void onLayerEntityPickedObject( Qt3DRender::QPickEvent *pickEvent, QgsFeatureId fid );
    void updateLights();
    void updateCameraLens();
    void onRenderersChanged();
    void onSkyboxSettingsChanged();
    void onShadowSettingsChanged();
    void onAmbientOcclusionSettingsChanged();
    void onEyeDomeShadingSettingsChanged();
    void onDebugShadowMapSettingsChanged();
    void onDebugDepthMapSettingsChanged();
    void onCameraMovementSpeedChanged();
    void onCameraNavigationModeChanged();
    void onDebugOverlayEnabledChanged();
 
    void on3DAxisSettingsChanged();
 
    bool updateCameraNearFarPlanes();
 
  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();
    void updateScene();
    void finalizeNewEntity( Qt3DCore::QEntity *newEntity );
    int maximumTextureSize() const;
 
  private:
    Qgs3DMapSettings &mMap;
    QgsAbstract3DEngine *mEngine = nullptr;
    Qt3DLogic::QFrameAction *mFrameAction = nullptr;
    QgsCameraController *mCameraController = nullptr;
    QgsTerrainEntity *mTerrain = nullptr;
    QList<QgsChunkedEntity *> mChunkEntities;
    Qt3DCore::QEntity *mEntityCameraViewCenter = nullptr;
    QMap<QgsMapLayer *, Qt3DCore::QEntity *> mLayerEntities;
    QMap<const QgsAbstract3DRenderer *, Qt3DCore::QEntity *> mRenderersEntities;
    bool mTerrainUpdateScheduled = false;
    SceneState mSceneState = Ready;
    QList<Qgs3DMapScenePickHandler *> mPickHandlers;
    QList<Qt3DCore::QEntity *> mLightEntities;
    QList<QgsMapLayer *> mModelVectorLayers;
    QgsSkyboxEntity *mSkybox = nullptr;
    Qt3DCore::QEntity *mEntityRotationCenter = nullptr;
 
    Qgs3DAxis *m3DAxis = nullptr;
 
};
 
#endif // QGS3DMAPSCENE_H