qgspointcloudrendererregistry.h

Go to the documentation of this file.

/***************************************************************************
    qgspointcloudrendererregistry.h
    ---------------------
    begin                : November 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 QGSPOINTCLOUDRENDERERREGISTRY_H
#define QGSPOINTCLOUDRENDERERREGISTRY_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgspointcloudclassifiedrenderer.h"
 
#include <QDomElement>
#include <QIcon>
#include <QMap>
#include <QStringList>
 
class QgsPointCloudRenderer;
class QgsReadWriteContext;
class QgsPointCloudLayer;
class QgsStyle;
#ifndef SIP_RUN
class QgsPointCloudRendererWidget SIP_EXTERNAL;
#endif
 
class QgsPointCloudAttributeCollection;
class QgsPointCloudDataProvider;

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

    QString name() const { return mName; }

    QString visibleName() const { return mVisibleName; }

    QIcon icon() const { return mIcon; }

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

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

    virtual QgsPointCloudRendererWidget *createRendererWidget( QgsPointCloudLayer *layer, QgsStyle *style, QgsPointCloudRenderer *oldRenderer ) SIP_FACTORY
    {
      Q_UNUSED( layer )
      Q_UNUSED( style );
      Q_UNUSED( oldRenderer );
      return nullptr;
    }
#endif
 
  protected:
    QString mName;
    QString mVisibleName;
    QIcon mIcon;
};
 
typedef QgsPointCloudRenderer *( *QgsPointCloudRendererCreateFunc )( QDomElement &, const QgsReadWriteContext & ) SIP_SKIP;
typedef QgsPointCloudRendererWidget *( *QgsPointCloudRendererWidgetFunc )( QgsPointCloudLayer *, QgsStyle *, QgsPointCloudRenderer * ) SIP_SKIP;

class CORE_EXPORT QgsPointCloudRendererMetadata : public QgsPointCloudRendererAbstractMetadata
{
  public:
    QgsPointCloudRendererMetadata( const QString &name, const QString &visibleName, QgsPointCloudRendererCreateFunc pfCreate, const QIcon &icon = QIcon(), QgsPointCloudRendererWidgetFunc pfWidget = nullptr )
      SIP_SKIP : QgsPointCloudRendererAbstractMetadata( name, visibleName, icon ),
                 mCreateFunc( pfCreate ),
                 mWidgetFunc( pfWidget )
    {}
 
    QgsPointCloudRenderer *createRenderer( QDomElement &elem, const QgsReadWriteContext &context ) override SIP_FACTORY { return mCreateFunc ? mCreateFunc( elem, context ) : nullptr; }
 
#ifndef SIP_RUN
    QgsPointCloudRendererWidget *createRendererWidget( QgsPointCloudLayer *layer, QgsStyle *style, QgsPointCloudRenderer *renderer ) override SIP_FACTORY
    {
      return mWidgetFunc ? mWidgetFunc( layer, style, renderer ) : nullptr;
    }
#endif

    QgsPointCloudRendererCreateFunc createFunction() const SIP_SKIP { return mCreateFunc; }
    QgsPointCloudRendererWidgetFunc widgetFunction() const SIP_SKIP { return mWidgetFunc; }

    void setWidgetFunction( QgsPointCloudRendererWidgetFunc f ) SIP_SKIP { mWidgetFunc = f; }
 
  protected:
    QgsPointCloudRendererCreateFunc mCreateFunc;
    QgsPointCloudRendererWidgetFunc mWidgetFunc;
 
  private:
#ifdef SIP_RUN
    QgsPointCloudRendererMetadata();
#endif
};
 

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

    bool addRenderer( QgsPointCloudRendererAbstractMetadata *metadata SIP_TRANSFER );

    bool removeRenderer( const QString &rendererName );

    QgsPointCloudRendererAbstractMetadata *rendererMetadata( const QString &rendererName );

    QStringList renderersList() const;

    static QgsPointCloudRenderer *defaultRenderer( const QgsPointCloudLayer *layer ) SIP_FACTORY;

    static QgsPointCloudCategoryList classificationAttributeCategories( const QgsPointCloudLayer *layer );
 
  private:
#ifdef SIP_RUN
    QgsPointCloudRendererRegistry( const QgsPointCloudRendererRegistry &rh );
#endif

    QMap<QString, QgsPointCloudRendererAbstractMetadata *> mRenderers;

    QStringList mRenderersOrder;
};
 
#endif // QGSPOINTCLOUDRENDERERREGISTRY_H