qgslabelingenginerule_impl.h

Go to the documentation of this file.

/***************************************************************************
    qgslabelingenginerule_impl.h
    ---------------------
  Date                 : August 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 QGSLABELINGENGINERULEIMPL_H
#define QGSLABELINGENGINERULEIMPL_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgslabelingenginerule.h"
#include "qgsmapunitscale.h"
#include "qgsvectorlayerref.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsSpatialIndex;
 

class CORE_EXPORT QgsAbstractLabelingEngineRuleDistanceFromFeature : public QgsAbstractLabelingEngineRule
{
  public:
    QgsAbstractLabelingEngineRuleDistanceFromFeature();
    ~QgsAbstractLabelingEngineRuleDistanceFromFeature() override;
    bool prepare( QgsRenderContext &context ) override;
    void writeXml( QDomDocument &doc, QDomElement &element, const QgsReadWriteContext &context ) const override;
    void readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
    void resolveReferences( const QgsProject *project ) override;
    bool candidateIsIllegal( const pal::LabelPosition *candidate, QgsLabelingEngineContext &context ) const override SIP_SKIP;
    void alterCandidateCost( pal::LabelPosition *candidate, QgsLabelingEngineContext &context ) const override SIP_SKIP;
    bool isAvailable() const override;

    QgsMapLayer *labeledLayer() const;

    void setLabeledLayer( QgsMapLayer *layer );

    QgsVectorLayer *targetLayer() const;

    void setTargetLayer( QgsVectorLayer *layer );

    double distance() const { return mDistance; }

    void setDistance( double distance ) { mDistance = distance; }

    Qgis::RenderUnit distanceUnit() const { return mDistanceUnit; }

    void setDistanceUnit( Qgis::RenderUnit unit ) { mDistanceUnit = unit; }

    const QgsMapUnitScale &distanceUnitScale() const { return mDistanceUnitScale; }

    void setDistanceUnitScale( const QgsMapUnitScale &scale ) { mDistanceUnitScale = scale; }

    double cost() const { return mCost; }

    void setCost( double cost ) { mCost = cost; }
 
  protected:
    void copyCommonProperties( QgsAbstractLabelingEngineRule *other ) const override;

    bool mMustBeDistant = true;
 
  private:
#ifdef SIP_RUN
    QgsAbstractLabelingEngineRuleDistanceFromFeature( const QgsAbstractLabelingEngineRuleDistanceFromFeature &other );
#endif
 
    void initialize( QgsLabelingEngineContext &context );

    bool candidateExceedsTolerance( const pal::LabelPosition *candidate, QgsLabelingEngineContext &context ) const;

    QgsMapLayerRef mLabeledLayer;
    QgsVectorLayerRef mTargetLayer;
    double mDistance = 5;
    Qgis::RenderUnit mDistanceUnit = Qgis::RenderUnit::Millimeters;
    QgsMapUnitScale mDistanceUnitScale;
    double mCost = 10;
 
    // cached variables
    double mDistanceMapUnits = 0;
    std::unique_ptr< QgsAbstractFeatureSource > mTargetLayerSource;
    std::unique_ptr< QgsSpatialIndex > mIndex;
    bool mInitialized = false;
};
 

class CORE_EXPORT QgsLabelingEngineRuleMinimumDistanceLabelToFeature : public QgsAbstractLabelingEngineRuleDistanceFromFeature
{
  public:
    QgsLabelingEngineRuleMinimumDistanceLabelToFeature();
    ~QgsLabelingEngineRuleMinimumDistanceLabelToFeature() override;
    QgsLabelingEngineRuleMinimumDistanceLabelToFeature *clone() const override SIP_FACTORY;
    QString id() const override;
    QString displayType() const override;
    QString description() const override;
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    const QString str = u"<QgsLabelingEngineRuleMinimumDistanceLabelToFeature: %1>"_s.arg( sipCpp->name() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
    // clang-format off
    private:
    // clang-format on
#ifdef SIP_RUN
    QgsLabelingEngineRuleMinimumDistanceLabelToFeature( const QgsLabelingEngineRuleMinimumDistanceLabelToFeature & );
#endif
};
 

class CORE_EXPORT QgsLabelingEngineRuleMaximumDistanceLabelToFeature : public QgsAbstractLabelingEngineRuleDistanceFromFeature
{
  public:
    QgsLabelingEngineRuleMaximumDistanceLabelToFeature();
    ~QgsLabelingEngineRuleMaximumDistanceLabelToFeature() override;
    QgsLabelingEngineRuleMaximumDistanceLabelToFeature *clone() const override SIP_FACTORY;
    QString id() const override;
    QString displayType() const override;
    QString description() const override;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    const QString str = u"<QgsLabelingEngineRuleMaximumDistanceLabelToFeature: %1>"_s.arg( sipCpp->name() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
    // clang-format off
    private:
    // clang-format on
#ifdef SIP_RUN
    QgsLabelingEngineRuleMaximumDistanceLabelToFeature( const QgsLabelingEngineRuleMaximumDistanceLabelToFeature & );
#endif
};

class CORE_EXPORT QgsLabelingEngineRuleMinimumDistanceLabelToLabel : public QgsAbstractLabelingEngineRule
{
  public:
    QgsLabelingEngineRuleMinimumDistanceLabelToLabel();
    ~QgsLabelingEngineRuleMinimumDistanceLabelToLabel() override;
 
    QgsLabelingEngineRuleMinimumDistanceLabelToLabel *clone() const override SIP_FACTORY;
    QString id() const override;
    QString displayType() const override;
    QString description() const override;
    bool isAvailable() const override;
    void writeXml( QDomDocument &doc, QDomElement &element, const QgsReadWriteContext &context ) const override;
    void readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
    void resolveReferences( const QgsProject *project ) override;
    bool prepare( QgsRenderContext &context ) override;
    QgsRectangle modifyCandidateConflictSearchBoundingBox( const QgsRectangle &candidateBounds ) const override SIP_SKIP;
    bool candidatesAreConflicting( const pal::LabelPosition *lp1, const pal::LabelPosition *lp2 ) const override SIP_SKIP;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    const QString str = u"<QgsLabelingEngineRuleMinimumDistanceLabelToLabel: %1>"_s.arg( sipCpp->name() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif

      QgsMapLayer *labeledLayer() const;

    void setLabeledLayer( QgsMapLayer *layer );

    QgsMapLayer *targetLayer() const;

    void setTargetLayer( QgsMapLayer *layer );

    double distance() const { return mDistance; }

    void setDistance( double distance ) { mDistance = distance; }

    Qgis::RenderUnit distanceUnit() const { return mDistanceUnit; }

    void setDistanceUnit( Qgis::RenderUnit unit ) { mDistanceUnit = unit; }

    const QgsMapUnitScale &distanceUnitScale() const { return mDistanceUnitScale; }

    void setDistanceUnitScale( const QgsMapUnitScale &scale ) { mDistanceUnitScale = scale; }
 
  private:
#ifdef SIP_RUN
    QgsLabelingEngineRuleMinimumDistanceLabelToLabel( const QgsLabelingEngineRuleMinimumDistanceLabelToLabel & );
#endif
 
    QgsMapLayerRef mLabeledLayer;
    QgsMapLayerRef mTargetLayer;
    double mDistance = 5;
    Qgis::RenderUnit mDistanceUnit = Qgis::RenderUnit::Millimeters;
    QgsMapUnitScale mDistanceUnitScale;
 
    // cached variables
    double mDistanceMapUnits = 0;
};
 

class CORE_EXPORT QgsLabelingEngineRuleAvoidLabelOverlapWithFeature : public QgsAbstractLabelingEngineRule
{
  public:
    QgsLabelingEngineRuleAvoidLabelOverlapWithFeature();
    ~QgsLabelingEngineRuleAvoidLabelOverlapWithFeature() override;
    QgsLabelingEngineRuleAvoidLabelOverlapWithFeature *clone() const override SIP_FACTORY;
    QString id() const override;
    QString displayType() const override;
    QString description() const override;
    bool prepare( QgsRenderContext &context ) override;
    void writeXml( QDomDocument &doc, QDomElement &element, const QgsReadWriteContext &context ) const override;
    void readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
    void resolveReferences( const QgsProject *project ) override;
    bool candidateIsIllegal( const pal::LabelPosition *candidate, QgsLabelingEngineContext &context ) const override SIP_SKIP;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    const QString str = u"<QgsLabelingEngineRuleAvoidLabelOverlapWithFeature: %1>"_s.arg( sipCpp->name() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif

      QgsMapLayer *labeledLayer() const;

    void setLabeledLayer( QgsMapLayer *layer );

    QgsVectorLayer *targetLayer() const;

    void setTargetLayer( QgsVectorLayer *layer );
 
  private:
#ifdef SIP_RUN
    QgsLabelingEngineRuleAvoidLabelOverlapWithFeature( const QgsLabelingEngineRuleAvoidLabelOverlapWithFeature & );
#endif
    void initialize( QgsLabelingEngineContext &context );
 
    QgsMapLayerRef mLabeledLayer;
    QgsVectorLayerRef mTargetLayer;
 
    // cached variables
    std::unique_ptr< QgsAbstractFeatureSource > mTargetLayerSource;
    std::unique_ptr< QgsSpatialIndex > mIndex;
    bool mInitialized = false;
};
 
 
#endif // QGSLABELINGENGINERULEIMPL_H