qgs3d.h

Go to the documentation of this file.

/***************************************************************************
                         qgs3d.h
                         --------
    begin                : July 2020
    copyright            : (C) 2020 by Nyall Dawson
    email                : nyall dot dawson 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 QGS3D_H
#define QGS3D_H
 
#include <memory>
 
#include "qgis.h"
#include "qgis_3d.h"
#include "qgis_sip.h"
 
class QgsMaterialRegistry;
class Qgs3DTerrainRegistry;
class QgsAbstractMaterial3DHandler;
class QgsAbstractMaterialSettings;
class QgsMaterial;
class QgsMaterialContext;
class QgsExpressionContext;
class QgsSettingsEntryBool;
template<class T> class QgsSettingsEntryEnumFlag;
 
#ifndef SIP_RUN
namespace Qt3DCore
{
  class QGeometry;
}
 
namespace Qt3DRender
{
  class QEffect;
}
#endif

class _3D_EXPORT Qgs3D
{
  public:
    static const QgsSettingsEntryBool *settingMsaaEnabled SIP_SKIP;
    static const QgsSettingsEntryEnumFlag<Qgis::TextureFilterQuality> *settingTextureFilterQuality SIP_SKIP;
    static const QgsSettingsEntryEnumFlag<Qgis::ShadowQuality> *settingShadowQuality SIP_SKIP;
 
    Qgs3D( const Qgs3D &other ) = delete;
    Qgs3D &operator=( const Qgs3D &other ) = delete;

    static Qgs3D *instance();
 
    ~Qgs3D();

    static void initialize();

    static QgsMaterialRegistry *materialRegistry();

    static Qgs3DTerrainRegistry *terrainRegistry();
 
#ifndef SIP_RUN
    static QgsMaterial *toMaterial( const QgsAbstractMaterialSettings *settings, Qgis::MaterialRenderingTechnique technique, const QgsMaterialContext &context );

    static QMap<QString, QString> toMaterialExportParameters( const QgsAbstractMaterialSettings *settings );

    static void addMaterialParametersToEffect( Qt3DRender::QEffect *effect, const QgsAbstractMaterialSettings *settings, const QgsMaterialContext &materialContext );

    static void applyMaterialDataDefinedToGeometry( const QgsAbstractMaterialSettings *settings, Qt3DCore::QGeometry *geometry, int vertexCount, const QByteArray &dataDefinedBytes );

    static QByteArray materialDataDefinedVertexColorsAsByte( const QgsAbstractMaterialSettings *settings, const QgsExpressionContext &expressionContext );

    static int materialDataDefinedByteStride( const QgsAbstractMaterialSettings *settings );

    static const QgsAbstractMaterial3DHandler *handlerForMaterialSettings( const QgsAbstractMaterialSettings *settings );
 
    // if you change this, also update the corresponding constant in shadows.inc.frag!
    static constexpr int NUM_SHADOW_CASCADES = 4;
 
#endif
 
  private:
    Qgs3D();
 
#ifdef SIP_RUN
    Qgs3D( const Qgs3D &other );
#endif
 
    bool mInitialized = false;
 
    Qgs3DTerrainRegistry *mTerrainRegistry = nullptr;
    std::unique_ptr< QgsAbstractMaterial3DHandler > mNullMaterialHandler;
    std::unique_ptr< QgsAbstractMaterial3DHandler > mPhongMaterialHandler;
    std::unique_ptr< QgsAbstractMaterial3DHandler > mPhongTexturedMaterialHandler;
    std::unique_ptr< QgsAbstractMaterial3DHandler > mSimpleLineMaterialHandler;
    std::unique_ptr< QgsAbstractMaterial3DHandler > mGoochMaterialHandler;
    std::unique_ptr< QgsAbstractMaterial3DHandler > mMetalRoughMaterialHandler;
    std::unique_ptr< QgsAbstractMaterial3DHandler > mMetalRoughTexturedMaterialHandler;
};
 
#endif // QGS3D_H