qgstiledscenerendererregistry.h

Go to the documentation of this file.

/***************************************************************************
    qgstiledscenerendererregistry.h
    ---------------------
    begin                : August 2023
    copyright            : (C) 2023 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 QGSTILEDSCENERENDERERREGISTRY_H
#define QGSTILEDSCENERENDERERREGISTRY_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QDomElement>
#include <QIcon>
#include <QMap>
#include <QStringList>
 
class QgsTiledSceneRenderer;
class QgsReadWriteContext;
class QgsTiledSceneLayer;
class QgsStyle;
#ifndef SIP_RUN
class QgsTiledSceneRendererWidget SIP_EXTERNAL;
#endif
 

class CORE_EXPORT QgsTiledSceneRendererAbstractMetadata
{
  public:

    QgsTiledSceneRendererAbstractMetadata( const QString &name, const QString &visibleName, const QIcon &icon = QIcon() )
      : mName( name )
      , mVisibleName( visibleName )
      , mIcon( icon )
    {}
    virtual ~QgsTiledSceneRendererAbstractMetadata() = default;

    QString name() const { return mName; }

    QString visibleName() const { return mVisibleName; }

    QIcon icon() const { return mIcon; }

    void setIcon( const QIcon &icon ) { mIcon = icon; }

    virtual QgsTiledSceneRenderer *createRenderer( QDomElement &elem, const QgsReadWriteContext &context ) = 0 SIP_FACTORY;
 
#ifndef SIP_RUN

    virtual QgsTiledSceneRendererWidget *createRendererWidget( QgsTiledSceneLayer *layer, QgsStyle *style, QgsTiledSceneRenderer *oldRenderer ) SIP_FACTORY
    { Q_UNUSED( layer ) Q_UNUSED( style ); Q_UNUSED( oldRenderer ); return nullptr; }
#endif
 
  protected:
    QString mName;
    QString mVisibleName;
    QIcon mIcon;
};
 
typedef QgsTiledSceneRenderer *( *QgsTiledSceneRendererCreateFunc )( QDomElement &, const QgsReadWriteContext & ) SIP_SKIP;
typedef QgsTiledSceneRendererWidget *( *QgsTiledSceneRendererWidgetFunc )( QgsTiledSceneLayer *, QgsStyle *, QgsTiledSceneRenderer * ) SIP_SKIP;

class CORE_EXPORT QgsTiledSceneRendererMetadata : public QgsTiledSceneRendererAbstractMetadata
{
  public:

    QgsTiledSceneRendererMetadata( const QString &name,
                                   const QString &visibleName,
                                   QgsTiledSceneRendererCreateFunc pfCreate,
                                   const QIcon &icon = QIcon(),
                                   QgsTiledSceneRendererWidgetFunc pfWidget = nullptr ) SIP_SKIP
  : QgsTiledSceneRendererAbstractMetadata( name, visibleName, icon )
    , mCreateFunc( pfCreate )
    , mWidgetFunc( pfWidget )
    {}
 
    QgsTiledSceneRenderer *createRenderer( QDomElement &elem, const QgsReadWriteContext &context ) override SIP_FACTORY
    { return mCreateFunc ? mCreateFunc( elem, context ) : nullptr; }
 
#ifndef SIP_RUN
    QgsTiledSceneRendererWidget *createRendererWidget( QgsTiledSceneLayer *layer, QgsStyle *style, QgsTiledSceneRenderer *renderer ) override SIP_FACTORY
    { return mWidgetFunc ? mWidgetFunc( layer, style, renderer ) : nullptr; }
#endif

    QgsTiledSceneRendererCreateFunc createFunction() const SIP_SKIP { return mCreateFunc; }
    QgsTiledSceneRendererWidgetFunc widgetFunction() const SIP_SKIP { return mWidgetFunc; }

    void setWidgetFunction( QgsTiledSceneRendererWidgetFunc f ) SIP_SKIP { mWidgetFunc = f; }
 
  protected:
    QgsTiledSceneRendererCreateFunc mCreateFunc;
    QgsTiledSceneRendererWidgetFunc mWidgetFunc;
 
  private:
#ifdef SIP_RUN
    QgsTiledSceneRendererMetadata();
#endif
 
};
 

class CORE_EXPORT QgsTiledSceneRendererRegistry
{
  public:
 
    QgsTiledSceneRendererRegistry();
    ~QgsTiledSceneRendererRegistry();
 
    QgsTiledSceneRendererRegistry( const QgsTiledSceneRendererRegistry &rh ) = delete;
    QgsTiledSceneRendererRegistry &operator=( const QgsTiledSceneRendererRegistry &rh ) = delete;

    bool addRenderer( QgsTiledSceneRendererAbstractMetadata *metadata SIP_TRANSFER );

    bool removeRenderer( const QString &rendererName );

    QgsTiledSceneRendererAbstractMetadata *rendererMetadata( const QString &rendererName );

    QStringList renderersList() const;

    static QgsTiledSceneRenderer *defaultRenderer( const QgsTiledSceneLayer *layer ) SIP_FACTORY;
 
  private:
#ifdef SIP_RUN
    QgsTiledSceneRendererRegistry( const QgsTiledSceneRendererRegistry &rh );
#endif

    QMap<QString, QgsTiledSceneRendererAbstractMetadata *> mRenderers;

    QStringList mRenderersOrder;
};
 
#endif // QGSTILEDSCENERENDERERREGISTRY_H