qgsmaterialregistry.h

Go to the documentation of this file.

/***************************************************************************
  qgsmaterialregistry.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 QGSMATERIALREGISTRY_H
#define QGSMATERIALREGISTRY_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QDomElement>
#include <QIcon>
#include <QMap>
 
class QgsReadWriteContext;
class QgsMaterialSettingsWidget SIP_EXTERNAL;
class QgsAbstractMaterialSettings;
#ifndef SIP_RUN
class QgsAbstractMaterial3DHandler;
#endif

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

    QString type() const { return mType; }

    QString visibleName() const { return mVisibleName; }

    QIcon icon() const { return mIcon; }

    virtual QgsAbstractMaterialSettings *create() = 0 SIP_FACTORY;

    virtual bool supportsTechnique( Qgis::MaterialRenderingTechnique technique ) const = 0;
 
#ifndef SIP_RUN

    virtual QgsMaterialSettingsWidget *createWidget() SIP_FACTORY { return nullptr; }

    virtual const QgsAbstractMaterial3DHandler *material3DHandler() { return nullptr; }
#endif
 
  private:
    QString mType;
    QString mVisibleName;
    QIcon mIcon;
};

typedef QgsAbstractMaterialSettings *( *QgsMaterialSettingsCreateFunc )() SIP_SKIP;

typedef QgsMaterialSettingsWidget *( *QgsMaterialSettingsWidgetFunc )() SIP_SKIP;

typedef bool ( *QgsMaterialSettingsSupportsTechniqueFunc )( Qgis::MaterialRenderingTechnique ) SIP_SKIP;
 
#ifndef SIP_RUN

class CORE_EXPORT QgsMaterialSettingsMetadata : public QgsMaterialSettingsAbstractMetadata
{
  public:
    QgsMaterialSettingsMetadata(
      const QString &type,
      const QString &visibleName,
      QgsMaterialSettingsCreateFunc pfCreate,
      QgsMaterialSettingsSupportsTechniqueFunc pfSupportsTechnique,
      QgsMaterialSettingsWidgetFunc pfWidget = nullptr,
      const QIcon &icon = QIcon()
    )
      : QgsMaterialSettingsAbstractMetadata( type, visibleName, icon )
      , mCreateFunc( pfCreate )
      , mSupportsTechniqueFunc( pfSupportsTechnique )
      , mWidgetFunc( pfWidget )
    {}

    QgsMaterialSettingsCreateFunc createFunction() const { return mCreateFunc; }

    QgsMaterialSettingsWidgetFunc widgetFunction() const { return mWidgetFunc; }

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

    const QgsAbstractMaterial3DHandler *handler() const { return mHandler; }

    void setHandler( QgsAbstractMaterial3DHandler *handler ) { mHandler = handler; }
 
    QgsAbstractMaterialSettings *create() override SIP_FACTORY { return mCreateFunc ? mCreateFunc() : nullptr; }
    bool supportsTechnique( Qgis::MaterialRenderingTechnique technique ) const override { return mSupportsTechniqueFunc ? mSupportsTechniqueFunc( technique ) : true; }
    QgsMaterialSettingsWidget *createWidget() override SIP_FACTORY { return mWidgetFunc ? mWidgetFunc() : nullptr; }
 
  private:
    QgsMaterialSettingsCreateFunc mCreateFunc;
    QgsMaterialSettingsSupportsTechniqueFunc mSupportsTechniqueFunc;
    QgsMaterialSettingsWidgetFunc mWidgetFunc;
    QgsAbstractMaterial3DHandler *mHandler = nullptr;
};
#endif
 

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

    bool populate();

    QgsMaterialSettingsAbstractMetadata *materialSettingsMetadata( const QString &type ) const;

    QStringList materialSettingsTypes() const;

    bool addMaterialSettingsType( QgsMaterialSettingsAbstractMetadata *metadata SIP_TRANSFER );

    std::unique_ptr< QgsAbstractMaterialSettings > createMaterialSettings( const QString &type ) const;
 
  private:
#ifdef SIP_RUN
    QgsMaterialRegistry( const QgsMaterialRegistry &rh );
#endif
 
    QMap<QString, QgsMaterialSettingsAbstractMetadata *> mMetadata;
    QStringList mMaterialsOrder;
};
 
 
#endif // QGSMATERIALREGISTRY_H