qgsmeshlayerlabeling.h

Go to the documentation of this file.

/***************************************************************************
                         qgsmeshlayerlabeling.h
                         ---------------------
    begin                : November 2023
    copyright            : (C) 2023 by Alexander Bruy
    email                : alexander dot bruy 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 QGSMESHLAYERLABELING_H
#define QGSMESHLAYERLABELING_H
 
#include <memory>
 
#include "qgis.h"
 
#include <QDomNode>
#include <QString>
#include <QStringList>
 
using namespace Qt::StringLiterals;
 
class QDomDocument;
class QDomElement;
 
class QgsPalLayerSettings;
class QgsReadWriteContext;
class QgsMeshLayer;
class QgsMeshLayerLabelProvider;
class QgsStyleEntityVisitorInterface;
 

class CORE_EXPORT QgsAbstractMeshLayerLabeling
{
  public:
    QgsAbstractMeshLayerLabeling() = default;
    virtual ~QgsAbstractMeshLayerLabeling() = default;

    virtual QString type() const = 0;

    virtual QgsAbstractMeshLayerLabeling *clone() const = 0 SIP_FACTORY;

    virtual QgsMeshLayerLabelProvider *provider( QgsMeshLayer *layer ) const SIP_SKIP
    {
      Q_UNUSED( layer )
      return nullptr;
    }

    virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const = 0;

    virtual QStringList subProviders() const { return QStringList( QString() ); }

    virtual QgsPalLayerSettings settings( const QString &providerId = QString() ) const = 0;

    virtual void setSettings( QgsPalLayerSettings *settings SIP_TRANSFER, const QString &providerId = QString() ) = 0;

    virtual bool requiresAdvancedEffects() const = 0;

    virtual bool hasNonDefaultCompositionMode() const = 0;

    virtual void multiplyOpacity( double opacityFactor ) { Q_UNUSED( opacityFactor ); };
 
 
    // static stuff

    static QgsAbstractMeshLayerLabeling *create( const QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;

    virtual void toSld( QDomNode &parent, const QVariantMap &props ) const
    {
      Q_UNUSED( parent )
      Q_UNUSED( props )
      QDomDocument doc = parent.ownerDocument();
      parent.appendChild( doc.createComment( u"SE Export for %1 not implemented yet"_s.arg( type() ) ) );
    }

    virtual bool accept( QgsStyleEntityVisitorInterface *visitor ) const;

    static QgsPalLayerSettings defaultSettingsForLayer( const QgsMeshLayer *layer );
 
  private:
    Q_DISABLE_COPY( QgsAbstractMeshLayerLabeling )
 
#ifdef SIP_RUN
    QgsAbstractMeshLayerLabeling( const QgsAbstractMeshLayerLabeling &rhs );
#endif
};

class CORE_EXPORT QgsMeshLayerSimpleLabeling : public QgsAbstractMeshLayerLabeling
{
  public:
    explicit QgsMeshLayerSimpleLabeling( const QgsPalLayerSettings &settings, bool labelFaces = false );
 
    QString type() const override;
    QgsMeshLayerSimpleLabeling *clone() const override SIP_FACTORY;
    QgsMeshLayerLabelProvider *provider( QgsMeshLayer *layer ) const override SIP_SKIP;
    QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const override;
    QgsPalLayerSettings settings( const QString &providerId = QString() ) const override;
    bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;

    void setSettings( QgsPalLayerSettings *settings SIP_TRANSFER, const QString &providerId = QString() ) override;
 
    bool requiresAdvancedEffects() const override;
    bool hasNonDefaultCompositionMode() const override;
    void multiplyOpacity( double opacityFactor ) override;
    static QgsMeshLayerSimpleLabeling *create( const QDomElement &element, const QgsReadWriteContext &context ); // cppcheck-suppress duplInheritedMember
 
  private:
    std::unique_ptr<QgsPalLayerSettings> mSettings;
    bool mLabelFaces = false;
};
 
#endif // QGSMESHLAYERLABELING_H