qgsrasterlabeling.h

Go to the documentation of this file.

/***************************************************************************
                         qgsrasterlabeling.h
                         ---------------
    begin                : December 2024
    copyright            : (C) 2024 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 QGSRASTERLABELING_H
#define QGSRASTERLABELING_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgslabelingengine.h"
#include "qgslabelplacementsettings.h"
#include "qgslabelthinningsettings.h"
#include "qgstextformat.h"
 
class QgsRasterLayer;
class QgsNumericFormat;
class QgsRasterPipe;
struct QgsRasterViewPort;
class QgsRasterLayerRendererFeedback;
 
#ifndef SIP_RUN

class CORE_EXPORT QgsRasterLayerLabelProvider final : public QgsAbstractLabelProvider
{
  public:
    explicit QgsRasterLayerLabelProvider( QgsRasterLayer *layer );
 
    ~QgsRasterLayerLabelProvider() final;
    QList<QgsLabelFeature *> labelFeatures( QgsRenderContext & ) final;
    void drawLabel( QgsRenderContext &context, pal::LabelPosition *label ) const final;
    void startRender( QgsRenderContext &context ) final;

    void generateLabels( QgsRenderContext &context, QgsRasterPipe *pipe, QgsRasterViewPort *rasterViewPort, QgsRasterLayerRendererFeedback *feedback );

    void addLabel( const QgsPoint &mapPoint, const QString &text, QgsRenderContext &context );

    void setTextFormat( const QgsTextFormat &format );

    void setNumericFormat( std::unique_ptr< QgsNumericFormat > format );

    QgsNumericFormat *numericFormat();

    int band() const { return mBandNumber; }

    void setBand( int band ) { mBandNumber = band; }

    void setPriority( double priority ) { mPriority = priority; }

    void setPlacementSettings( const QgsLabelPlacementSettings &settings ) { mPlacementSettings = settings; }

    void setZIndex( double index ) { mZIndex = index; }

    void setThinningSettings( const QgsLabelThinningSettings &settings ) { mThinningSettings = settings; }

    void setResampleMethod( Qgis::RasterResamplingMethod method );

    void setResampleOver( int pixels );
 
  private:
    QgsTextFormat mFormat;
    int mBandNumber = 1;
    std::unique_ptr< QgsNumericFormat > mNumericFormat;
 
    QgsLabelPlacementSettings mPlacementSettings;
    QgsLabelThinningSettings mThinningSettings;
    double mZIndex = 0;
 
    Qgis::RasterResamplingMethod mResampleMethod = Qgis::RasterResamplingMethod::Average;
    int mResampleOver = 1;
 
    QList<QgsLabelFeature *> mLabels;
};
 
#endif
 

class CORE_EXPORT QgsAbstractRasterLayerLabeling SIP_ABSTRACT
{
  public:
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( sipCpp->type() == "simple" )
      sipType = sipType_QgsRasterLayerSimpleLabeling;
    else
      sipType = 0;
    SIP_END
#endif
 
    QgsAbstractRasterLayerLabeling()
      = default;
    virtual ~QgsAbstractRasterLayerLabeling() = default;
#ifndef SIP_RUN
    QgsAbstractRasterLayerLabeling( const QgsAbstractRasterLayerLabeling &rhs ) = delete;
    QgsAbstractRasterLayerLabeling &operator=( const QgsAbstractRasterLayerLabeling &rhs ) = delete;
#endif

    static QgsAbstractRasterLayerLabeling *defaultLabelingForLayer( QgsRasterLayer *layer ) SIP_FACTORY;

    virtual QString type() const = 0;

    virtual QgsAbstractRasterLayerLabeling *clone() const = 0 SIP_FACTORY;

    virtual std::unique_ptr< QgsRasterLayerLabelProvider > provider( QgsRasterLayer *layer ) const SIP_SKIP = 0;

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

    virtual bool requiresAdvancedEffects() const = 0;

    virtual bool hasNonDefaultCompositionMode() const = 0;

    virtual void multiplyOpacity( double opacityFactor );

    virtual bool isInScaleRange( double scale ) const;
 
    // static stuff

    static QgsAbstractRasterLayerLabeling *createFromElement( const QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;

    virtual void toSld( QDomNode &parent, const QVariantMap &props ) const;

    virtual bool accept( QgsStyleEntityVisitorInterface *visitor ) const;
 
  private:
#ifdef SIP_RUN
    QgsAbstractRasterLayerLabeling( const QgsAbstractRasterLayerLabeling &rhs );
#endif
};
 

class CORE_EXPORT QgsRasterLayerSimpleLabeling : public QgsAbstractRasterLayerLabeling
{
  public:
    explicit QgsRasterLayerSimpleLabeling();
    ~QgsRasterLayerSimpleLabeling() override;
 
    QString type() const override;
    QgsRasterLayerSimpleLabeling *clone() const override SIP_FACTORY;
    std::unique_ptr< QgsRasterLayerLabelProvider > provider( QgsRasterLayer *layer ) const override SIP_SKIP;
    QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const override;
    bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;
    bool requiresAdvancedEffects() const override;
    bool hasNonDefaultCompositionMode() const override;
    void multiplyOpacity( double opacityFactor ) override;

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

    QgsTextFormat textFormat() const;

    void setTextFormat( const QgsTextFormat &format );

    const QgsNumericFormat *numericFormat() const;

    void setNumericFormat( QgsNumericFormat *format SIP_TRANSFER );

    int band() const { return mBandNumber; }

    void setBand( int band ) { mBandNumber = band; }

    double priority() const { return mPriority; }

    void setPriority( double priority ) { mPriority = priority; }

    const QgsLabelPlacementSettings &placementSettings() const { return mPlacementSettings; }
    SIP_SKIP

    QgsLabelPlacementSettings &
      placementSettings()
    {
      return mPlacementSettings;
    }

    void setPlacementSettings( const QgsLabelPlacementSettings &settings ) { mPlacementSettings = settings; }

    const QgsLabelThinningSettings &thinningSettings() const { return mThinningSettings; }
    SIP_SKIP

    QgsLabelThinningSettings &
      thinningSettings()
    {
      return mThinningSettings;
    }

    void setThinningSettings( const QgsLabelThinningSettings &settings ) { mThinningSettings = settings; }

    double zIndex() const;

    void setZIndex( double index );

    double maximumScale() const;

    void setMaximumScale( double scale );

    double minimumScale() const;

    void setMinimumScale( double scale );

    void setScaleBasedVisibility( bool enabled );

    bool hasScaleBasedVisibility() const;
 
    bool isInScaleRange( double scale ) const override;

    Qgis::RasterResamplingMethod resampleMethod() const;

    void setResampleMethod( Qgis::RasterResamplingMethod method );

    int resampleOver() const;

    void setResampleOver( int pixels );
 
  private:
    int mBandNumber = 1;
 
    QgsTextFormat mTextFormat;
 
    std::unique_ptr< QgsNumericFormat > mNumericFormat;

    double mPriority = 0.5;
 
    QgsLabelPlacementSettings mPlacementSettings;
    QgsLabelThinningSettings mThinningSettings;
 
    double mZIndex = 0;
 
    bool mScaleVisibility = false;
    double mMaximumScale = 0;
    double mMinimumScale = 0;
 
    Qgis::RasterResamplingMethod mResampleMethod = Qgis::RasterResamplingMethod::Average;
    int mResampleOver = 1;
};
 
 
#endif // QGSRASTERLABELING_H