qgs3dterrainregistry.h

Go to the documentation of this file.

/***************************************************************************
  qgs3dterrainregistry.h
  --------------------------------------
  Date                 : November 2024
  Copyright            : (C) 2024 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 QGS3DTERRAINREGISTRY_H
#define QGS3DTERRAINREGISTRY_H
 
#include "qgis_3d.h"
#include "qgis_sip.h"
 
#include <QDomElement>
#include <QIcon>
#include <QMap>
#include <QString>
 
class QgsReadWriteContext;
class QgsAbstractTerrainSettings;
class QgsTerrainGenerator;
class QgsProjectElevationProperties;
class QgsRectangle;

class _3D_EXPORT Qgs3DTerrainAbstractMetadata
{
  public:

    Qgs3DTerrainAbstractMetadata( const QString &type, const QString &visibleName, const QIcon &icon = QIcon() )
      : mType( type )
      , mVisibleName( visibleName )
      , mIcon( icon )
    {}
 
    virtual ~Qgs3DTerrainAbstractMetadata() = default;

    QString type() const { return mType; }

    QString visibleName() const { return mVisibleName; }

    QIcon icon() const { return mIcon; }

    virtual QgsAbstractTerrainSettings *createTerrainSettings() = 0 SIP_FACTORY;

    SIP_SKIP virtual QgsTerrainGenerator *createTerrainGenerator() { return nullptr; }
 
  private:
    QString mType;
    QString mVisibleName;
    QIcon mIcon;
};

SIP_SKIP typedef QgsAbstractTerrainSettings *( *QgsTerrainSettingsCreateFunc )();
SIP_SKIP typedef QgsTerrainGenerator *( *QgsTerrainGeneratorCreateFunc )();
 
#ifndef SIP_RUN

class _3D_EXPORT Qgs3DTerrainMetadata : public Qgs3DTerrainAbstractMetadata
{
  public:

    Qgs3DTerrainMetadata( const QString &type, const QString &visibleName, QgsTerrainSettingsCreateFunc pfSettingsCreate, QgsTerrainGeneratorCreateFunc pfGeneratorCreate, const QIcon &icon = QIcon() )
      : Qgs3DTerrainAbstractMetadata( type, visibleName, icon )
      , mCreateFunc( pfSettingsCreate )
      , mGeneratorCreateFunc( pfGeneratorCreate )
    {}

    QgsTerrainSettingsCreateFunc createSettingsFunction() const { return mCreateFunc; }

    QgsTerrainGeneratorCreateFunc createGeneratorFunction() const { return mGeneratorCreateFunc; }
 
    QgsAbstractTerrainSettings *createTerrainSettings() override SIP_FACTORY { return mCreateFunc ? mCreateFunc() : nullptr; }
    QgsTerrainGenerator *createTerrainGenerator() override { return mGeneratorCreateFunc ? mGeneratorCreateFunc() : nullptr; }
 
  private:
    QgsTerrainSettingsCreateFunc mCreateFunc;
    QgsTerrainGeneratorCreateFunc mGeneratorCreateFunc;
};
#endif
 

class _3D_EXPORT Qgs3DTerrainRegistry
{
  public:
    Qgs3DTerrainRegistry();
    ~Qgs3DTerrainRegistry();
 
    Qgs3DTerrainRegistry( const Qgs3DTerrainRegistry &rh ) = delete;
    Qgs3DTerrainRegistry &operator=( const Qgs3DTerrainRegistry &rh ) = delete;

    Qgs3DTerrainAbstractMetadata *terrainMetadata( const QString &type ) const;

    QStringList types() const;

    bool addType( Qgs3DTerrainAbstractMetadata *metadata SIP_TRANSFER );

    QgsAbstractTerrainSettings *createTerrainSettings( const QString &type ) const SIP_FACTORY;

    SIP_SKIP QgsTerrainGenerator *createTerrainGenerator( const QString &type ) const;

    QgsAbstractTerrainSettings *configureTerrainFromProject( QgsProjectElevationProperties *properties ) SIP_FACTORY;
 
  private:
#ifdef SIP_RUN
    Qgs3DTerrainRegistry( const Qgs3DTerrainRegistry &rh );
#endif
 
    QMap<QString, Qgs3DTerrainAbstractMetadata *> mMetadata;
    QStringList mTerrainOrder;
};
 
 
#endif // QGS3DTERRAINREGISTRY_H