qgslabelthinningsettings.h

Go to the documentation of this file.

/***************************************************************************
  qgslabelthinningsettings.h
  --------------------------
  Date                 : December 2019
  Copyright            : (C) 2019 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 QGSLABELTHINNINGSETTINGS_H
#define QGSLABELTHINNINGSETTINGS_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsmapunitscale.h"
 
class QgsPropertyCollection;
class QgsExpressionContext;

class CORE_EXPORT QgsLabelThinningSettings
{
  public:
    bool limitNumberOfLabelsEnabled() const { return mLimitNumLabels; }

    void setLimitNumberLabelsEnabled( bool enabled ) { mLimitNumLabels = enabled; }

    int maximumNumberLabels() const { return mMaxNumLabels; }

    void setMaximumNumberLabels( int number ) { mMaxNumLabels = number; }

    double minimumFeatureSize() const { return mMinFeatureSize; }

    void setMinimumFeatureSize( double size ) { mMinFeatureSize = size; }

    double labelMarginDistance() const { return mLabelMarginDistance; }

    void setLabelMarginDistance( double distance ) { mLabelMarginDistance = distance; }

    void setLabelMarginDistanceUnit( Qgis::RenderUnit unit ) { mLabelMarginDistanceUnits = unit; }

    Qgis::RenderUnit labelMarginDistanceUnit() const { return mLabelMarginDistanceUnits; }

    void setLabelMarginDistanceMapUnitScale( const QgsMapUnitScale &scale ) { mLabelMarginDistanceScale = scale; }

    const QgsMapUnitScale &labelMarginDistanceMapUnitScale() const { return mLabelMarginDistanceScale; }
 
#ifndef SIP_RUN
    static constexpr double DEFAULT_MINIMUM_DISTANCE_TO_DUPLICATE = 20;
#endif

    double minimumDistanceToDuplicate() const { return mMinDistanceToDuplicate; }

    void setMinimumDistanceToDuplicate( double distance ) { mMinDistanceToDuplicate = distance; }

    void setMinimumDistanceToDuplicateUnit( Qgis::RenderUnit unit ) { mMinDistanceToDuplicateUnits = unit; }

    Qgis::RenderUnit minimumDistanceToDuplicateUnit() const { return mMinDistanceToDuplicateUnits; }

    void setMinimumDistanceToDuplicateMapUnitScale( const QgsMapUnitScale &scale ) { mMinDistanceToDuplicateScale = scale; }

    const QgsMapUnitScale &minimumDistanceToDuplicateMapUnitScale() const { return mMinDistanceToDuplicateScale; }

    bool allowDuplicateRemoval() const { return mAllowDuplicateRemoval; }

    void setAllowDuplicateRemoval( bool allow ) { mAllowDuplicateRemoval = allow; }

    void updateDataDefinedProperties( const QgsPropertyCollection &properties, QgsExpressionContext &context );
 
  private:
    bool mLimitNumLabels = false;
    int mMaxNumLabels = 2000;
    double mMinFeatureSize = 0;
 
    double mLabelMarginDistance = 0;
    Qgis::RenderUnit mLabelMarginDistanceUnits = Qgis::RenderUnit::Millimeters;
    QgsMapUnitScale mLabelMarginDistanceScale;
 
    bool mAllowDuplicateRemoval = false;
    double mMinDistanceToDuplicate = QgsLabelThinningSettings::DEFAULT_MINIMUM_DISTANCE_TO_DUPLICATE;
    Qgis::RenderUnit mMinDistanceToDuplicateUnits = Qgis::RenderUnit::Millimeters;
    QgsMapUnitScale mMinDistanceToDuplicateScale;
};
 
#ifndef SIP_RUN

class CORE_EXPORT QgsLabelFeatureThinningSettings
{
  public:
    double labelMarginDistance() const { return mLabelMarginDistance; }

    void setLabelMarginDistance( double distance ) { mLabelMarginDistance = distance; }

    double noRepeatDistance() const { return mNoRepeatDistance; }

    void setNoRepeatDistance( double distance ) { mNoRepeatDistance = distance; }
 
  private:
    double mLabelMarginDistance = 0;
    double mNoRepeatDistance = 0;
};
 
#endif
 
#endif // QGSLABELTHINNINGSETTINGS_H