qgs3dsymbolregistry.h

Go to the documentation of this file.

/***************************************************************************
  qgs3dsymbolregistry.h
  --------------------------------------
  Date                 : 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 QGS3DSYMBOLREGISTRY_H
#define QGS3DSYMBOLREGISTRY_H

#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgswkbtypes.h"

#include <QDomElement>
#include <QMap>

class QgsAbstract3DSymbol;
class QgsReadWriteContext;
class Qgs3DSymbolWidget;
class QgsVectorLayer;
class QgsFeature3DHandler;

class CORE_EXPORT Qgs3DSymbolAbstractMetadata
{
  public:

    Qgs3DSymbolAbstractMetadata( const QString &type, const QString &visibleName )
      : mType( type )
      , mVisibleName( visibleName )
    {}

    virtual ~Qgs3DSymbolAbstractMetadata() = default;

    QString type() const { return mType; }

    QString visibleName() const { return mVisibleName; }

    virtual QgsAbstract3DSymbol *create() = 0 SIP_FACTORY;

#ifndef SIP_RUN

    virtual Qgs3DSymbolWidget *createSymbolWidget( QgsVectorLayer * ) SIP_FACTORY { return nullptr; }

    virtual QgsFeature3DHandler *createFeatureHandler( QgsVectorLayer *layer, const QgsAbstract3DSymbol *symbol ) SIP_FACTORY { Q_UNUSED( layer ); Q_UNUSED( symbol ); return nullptr; }
#endif

  private:
    QString mType;
    QString mVisibleName;
};

typedef QgsAbstract3DSymbol *( *Qgs3DSymbolCreateFunc )() SIP_SKIP;

typedef QgsFeature3DHandler *( *Qgs3DSymbolFeatureHandlerFunc )( QgsVectorLayer *, const QgsAbstract3DSymbol * ) SIP_SKIP;

typedef Qgs3DSymbolWidget *( *Qgs3DSymbolWidgetFunc )( QgsVectorLayer * ) SIP_SKIP;

#ifndef SIP_RUN

class CORE_EXPORT Qgs3DSymbolMetadata : public Qgs3DSymbolAbstractMetadata
{
  public:

    Qgs3DSymbolMetadata( const QString &type, const QString &visibleName,
                         Qgs3DSymbolCreateFunc pfCreate,
                         Qgs3DSymbolWidgetFunc pfWidget = nullptr,
                         Qgs3DSymbolFeatureHandlerFunc pfHandler = nullptr ) SIP_SKIP
  : Qgs3DSymbolAbstractMetadata( type, visibleName )
    , mCreateFunc( pfCreate )
    , mWidgetFunc( pfWidget )
    , mFeatureHandlerFunc( pfHandler )
    {}

    Qgs3DSymbolCreateFunc createFunction() const { return mCreateFunc; }

    Qgs3DSymbolWidgetFunc widgetFunction() const { return mWidgetFunc; }

    void setWidgetFunction( Qgs3DSymbolWidgetFunc function ) { mWidgetFunc = function; }

    void setFeatureHandlerFunction( Qgs3DSymbolFeatureHandlerFunc function ) { mFeatureHandlerFunc = function; }

    QgsAbstract3DSymbol *create() override SIP_FACTORY { return mCreateFunc ? mCreateFunc() : nullptr; }
    Qgs3DSymbolWidget *createSymbolWidget( QgsVectorLayer *vl ) override SIP_FACTORY { return mWidgetFunc ? mWidgetFunc( vl ) : nullptr; }
    QgsFeature3DHandler *createFeatureHandler( QgsVectorLayer *layer, const QgsAbstract3DSymbol *symbol ) override SIP_FACTORY { return mFeatureHandlerFunc ? mFeatureHandlerFunc( layer, symbol ) : nullptr; }

  private:
    Qgs3DSymbolCreateFunc mCreateFunc;
    Qgs3DSymbolWidgetFunc mWidgetFunc;
    Qgs3DSymbolFeatureHandlerFunc mFeatureHandlerFunc;

};
#endif


class CORE_EXPORT Qgs3DSymbolRegistry
{
  public:

    Qgs3DSymbolRegistry();
    ~Qgs3DSymbolRegistry();

    Qgs3DSymbolRegistry( const Qgs3DSymbolRegistry &rh ) = delete;
    Qgs3DSymbolRegistry &operator=( const Qgs3DSymbolRegistry &rh ) = delete;

    Qgs3DSymbolAbstractMetadata *symbolMetadata( const QString &type ) const;

    QStringList symbolTypes() const;

    bool addSymbolType( Qgs3DSymbolAbstractMetadata *metadata SIP_TRANSFER );

    QgsAbstract3DSymbol *createSymbol( const QString &type ) const SIP_FACTORY;

    QgsAbstract3DSymbol *defaultSymbolForGeometryType( QgsWkbTypes::GeometryType type ) SIP_FACTORY;

#ifndef SIP_RUN

    QgsFeature3DHandler *createHandlerForSymbol( QgsVectorLayer *layer, const QgsAbstract3DSymbol *symbol ) SIP_FACTORY;
#endif

  private:
#ifdef SIP_RUN
    Qgs3DSymbolRegistry( const Qgs3DSymbolRegistry &rh );
#endif

    QMap<QString, Qgs3DSymbolAbstractMetadata *> mMetadata;
};


#endif // QGS3DSYMBOLREGISTRY_H