qgsframegraph.h

Go to the documentation of this file.

/***************************************************************************
  qgsframegraph.h
  --------------------------------------
  Date                 : August 2020
  Copyright            : (C) 2020 by Belgacem Nedjima
  Email                : gb underscore nedjima at esi dot dz
 ***************************************************************************
 *                                                                         *
 *   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 QGSFRAMEGRAPH_H
#define QGSFRAMEGRAPH_H
 
#include <map>
 
#include "qgis_3d.h"
#include "qgsabstractrenderview.h"
 
#include <QSize>
#include <QWindow>
#include <Qt3DRender/QBlitFramebuffer>
#include <Qt3DRender/QCamera>
#include <Qt3DRender/QCameraSelector>
#include <Qt3DRender/QClearBuffers>
#include <Qt3DRender/QCullFace>
#include <Qt3DRender/QDebugOverlay>
#include <Qt3DRender/QDepthTest>
#include <Qt3DRender/QFrustumCulling>
#include <Qt3DRender/QLayer>
#include <Qt3DRender/QLayerFilter>
#include <Qt3DRender/QParameter>
#include <Qt3DRender/QPolygonOffset>
#include <Qt3DRender/QRenderCapture>
#include <Qt3DRender/QRenderPassFilter>
#include <Qt3DRender/QRenderStateSet>
#include <Qt3DRender/QRenderSurfaceSelector>
#include <Qt3DRender/QRenderTarget>
#include <Qt3DRender/QRenderTargetSelector>
#include <Qt3DRender/QTexture>
#include <Qt3DRender/QViewport>
 
#define SIP_NO_FILE
 
namespace Qt3DRender
{
  class QRenderCaptureReply;
}
 
class Qgs3DMapSettings;
class QgsAmbientOcclusionRenderView;
class QgsAmbientOcclusionSettings;
class QgsCameraController;
class QgsDepthRenderView;
class QgsDirectionalLightSettings;
class QgsForwardRenderView;
class QgsHighlightsRenderView;
class QgsLightSource;
class QgsOverlayTextureEntity;
class QgsOverlayTextureRenderView;
class QgsPostprocessingEntity;
class QgsPostprocessingRenderView;
class QgsRubberBandRenderView;
class QgsRectangle;
class QgsShadowRenderView;
class QgsShadowSettings;
class QgsBloomRenderView;
class QgsBloomSettings;
class QgsColorGradingSettings;

class _3D_EXPORT QgsFrameGraph : public Qt3DCore::QEntity
{
    Q_OBJECT
 
  public:
    QgsFrameGraph( QSurface *surface, QSize s, Qt3DRender::QCamera *mainCamera, Qt3DCore::QEntity *root );

    Qt3DRender::QFrameGraphNode *frameGraphRoot() { return mRenderSurfaceSelector; }

    Qt3DRender::QCamera *mainCamera() { return mMainCamera; }

    Qt3DRender::QRenderCapture *renderCapture();

    Qt3DRender::QRenderCapture *depthRenderCapture();

    void addGlobalParameters( const QList<Qt3DRender::QParameter *> &parameters );

    void setFrustumCullingEnabled( bool enabled );

    void setClearColor( const QColor &clearColor );

    void setSize( QSize s );

    void setRenderCaptureEnabled( bool enabled );

    void setDebugOverlayEnabled( bool enabled );

    void setMsaaEnabled( bool enabled );

    bool msaaEnabled() const { return mMsaaEnabled; }

    QString dumpFrameGraph() const;

    QString dumpSceneGraph() const;

    void addClipPlanes( int nrClipPlanes );

    void removeClipPlanes();

    bool registerRenderView( std::unique_ptr<QgsAbstractRenderView> renderView, const QString &name, Qt3DRender::QFrameGraphNode *topNode = nullptr );

    void unregisterRenderView( const QString &name );

    void setRenderViewEnabled( const QString &name, bool enable );

    bool isRenderViewEnabled( const QString &name );

    QgsAbstractRenderView *renderView( const QString &name );

    QgsShadowRenderView &shadowRenderView();

    QgsForwardRenderView &forwardRenderView();

    QgsDepthRenderView &depthRenderView();

    QgsAmbientOcclusionRenderView &ambientOcclusionRenderView();

    QgsBloomRenderView &bloomRenderView();

    QgsOverlayTextureRenderView &overlayTextureRenderView();

    QgsHighlightsRenderView &highlightsRenderView();

    QgsPostprocessingRenderView &postprocessingRenderView();

    QgsRubberBandRenderView &rubberBandRenderView();

    void updateShadowSettings( const Qgs3DMapSettings &mapSettings );

    void updateDebugDepthMapSettings( const Qgs3DMapSettings &settings );

    void updateAmbientOcclusionSettings( const QgsAmbientOcclusionSettings &settings );

    void updateEyeDomeSettings( const Qgs3DMapSettings &settings );

    void updateBloomSettings( const QgsBloomSettings &settings );

    void updateColorGradingSettings( const QgsColorGradingSettings &settings );
 
    static const QString sForwardRenderView;
    static const QString sShadowRenderView;
    static const QString sAxiS3DRenderView;
    static const QString sDepthRenderView;
    static const QString sOverlayRenderView;
    static const QString sAmbientOcclusionRenderView;
    static const QString sBloomRenderView;
    static const QString sPostprocRenderView;
    static const QString sHighlightsRenderView;
    static const QString sRubberRenderView;
 
  private:
    Qt3DRender::QRenderSurfaceSelector *mRenderSurfaceSelector = nullptr;
    Qt3DRender::QViewport *mMainViewPort = nullptr;
 
    Qt3DRender::QCamera *mMainCamera = nullptr;
 
    // Storage for global parameters
    // QRenderPassFilter has dual usage -- one for storage of filtering keys,
    // the other for storage of parameters for use in shaders. Here we are
    // using it for storage of parameters only, not for filtering!
    Qt3DRender::QRenderPassFilter *mGlobalParamsStorage = nullptr;
 
    // Separate thumbnail capture pass to save scaled-down images of the
    // rendered view to aid in debugging (e.g., Tracy profiler frame images).
    Qt3DRender::QRenderCapture *mThumbnailCapture = nullptr;
    Qt3DRender::QTexture2D *mThumbnailTexture = nullptr;
 
    QSize mSize = QSize( 1024, 768 );
 
    QVector3D mLightDirection = QVector3D( 0.0, -1.0f, 0.0f );
 
    Qt3DCore::QEntity *mRootEntity = nullptr;

    QgsOverlayTextureEntity *mDepthTextureDebugging = nullptr;
 
    void constructShadowRenderPass();
    void constructForwardRenderPass();
    void constructHighlightsPass();
    void constructOverlayTexturePass( Qt3DRender::QFrameGraphNode *topNode = nullptr );
    void constructPostprocessingPass( Qt3DRender::QFrameGraphNode *topNode = nullptr );
    void constructDepthRenderPass();
    void constructAmbientOcclusionRenderPass();
    void constructBloomRenderPass();
    void constructRubberBandsPass( Qt3DRender::QFrameGraphNode *topNode = nullptr );
    void constructMsaaBlitNodes();
 
    void constructThumbnailCapturePass();
    void updateThumbnailTextureSize();
    void onThumbnailCaptureCompleted( Qt3DRender::QRenderCaptureReply *reply );
 
    bool mMsaaEnabled = false;
    bool mMsaaBlitConfigured = false;
    Qt3DRender::QBlitFramebuffer *mMsaaBlitNode = nullptr;
    Qt3DRender::QBlitFramebuffer *mMsaaDepthBlitNode = nullptr;
    Qt3DRender::QClearBuffers *mMsaaClearBuffers = nullptr;
 
    // holds renderviews according to their name
    std::map<QString, std::unique_ptr<QgsAbstractRenderView>> mRenderViewMap;
 
    Q_DISABLE_COPY( QgsFrameGraph )
};
 
#endif // QGSFRAMEGRAPH_H