pal.h

Go to the documentation of this file.

/*
 *   libpal - Automated Placement of Labels Library
 *
 *   Copyright (C) 2008 Maxence Laurent, MIS-TIC, HEIG-VD
 *                      University of Applied Sciences, Western Switzerland
 *                      http://www.hes-so.ch
 *
 *   Contact:
 *      maxence.laurent <at> heig-vd <dot> ch
 *    or
 *      eric.taillard <at> heig-vd <dot> ch
 *
 * This file is part of libpal.
 *
 * libpal 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 3 of the License, or
 * (at your option) any later version.
 *
 * libpal is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with libpal.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef PAL_H
#define PAL_H
 
 
#include <ctime>
#include <iostream>
#include <unordered_map>
 
#include "qgis_core.h"
#include "qgsgeometry.h"
#include "qgsgeos.h"
#include "qgssettingstree.h"
 
#include <QList>
#include <QMutex>
#include <QString>
#include <QStringList>
 
#define SIP_NO_FILE
 
using namespace Qt::StringLiterals;
 
class QgsSettingsEntryInteger;
 
// TODO ${MAJOR} ${MINOR} etc instead of 0.2
 
class QgsAbstractLabelProvider;
class QgsRenderContext;
class QgsAbstractLabelingEngineRule;
 
namespace pal
{
  class Layer;
  class LabelPosition;
  class Problem;
  class PointSet;

  enum SearchMethod
  {
    CHAIN = 0,               
    POPMUSIC_TABU_CHAIN = 1, 
    POPMUSIC_TABU = 2,       
    POPMUSIC_CHAIN = 3,      
    FALP = 4                 
  };

  class CORE_EXPORT Pal
  {
      friend class Problem;
      friend class FeaturePart;
      friend class Layer;
 
    public:
      static inline QgsSettingsTreeNode *sTreePal = QgsSettingsTree::sTreeRendering->createChildNode( u"pal"_s );
 
      static const QgsSettingsEntryInteger *settingsRenderingLabelCandidatesLimitPoints;
      static const QgsSettingsEntryInteger *settingsRenderingLabelCandidatesLimitLines;
      static const QgsSettingsEntryInteger *settingsRenderingLabelCandidatesLimitPolygons;

      Pal( Qgis::LabelingFlags flags );
      ~Pal();
 
      Pal( const Pal &other ) = delete;
      Pal &operator=( const Pal &other ) = delete;

      Qgis::LabelingFlags flags() const { return mFlags; }

      Layer *addLayer( QgsAbstractLabelProvider *provider, const QString &layerName, Qgis::LabelPlacement arrangement, double defaultPriority, bool active, bool toLabel );

      void removeLayer( Layer *layer );

      typedef bool ( *FnIsCanceled )( void *ctx );

      void registerCancellationCallback( FnIsCanceled fnCanceled, void *context );

      inline bool isCanceled() { return fnIsCanceled ? fnIsCanceled( fnIsCanceledContext ) : false; }

      std::unique_ptr< Problem > extractProblem( const QgsRectangle &extent, const QgsGeometry &mapBoundary, QgsRenderContext &context );

      QList<LabelPosition *> solveProblem( Problem *prob, QgsRenderContext &context, bool displayAll, QList<pal::LabelPosition *> *unlabeled = nullptr );

      void setShowPartialLabels( bool show );
 
      static constexpr bool DEFAULT_SHOW_PARTIAL_LABELS = true;

      bool showPartialLabels() const;

      double maximumLineCandidatesPerMapUnit() const { return mMaxLineCandidatesPerMapUnit; }

      void setMaximumLineCandidatesPerMapUnit( double candidates ) { mMaxLineCandidatesPerMapUnit = candidates; }

      double maximumPolygonCandidatesPerMapUnitSquared() const { return mMaxPolygonCandidatesPerMapUnitSquared; }

      void setMaximumPolygonCandidatesPerMapUnitSquared( double candidates ) { mMaxPolygonCandidatesPerMapUnitSquared = candidates; }

      Qgis::LabelPlacementEngineVersion placementVersion() const;

      void setPlacementVersion( Qgis::LabelPlacementEngineVersion placementVersion );

      int globalCandidatesLimitPoint() const { return mGlobalCandidatesLimitPoint; }

      int globalCandidatesLimitLine() const { return mGlobalCandidatesLimitLine; }

      int globalCandidatesLimitPolygon() const { return mGlobalCandidatesLimitPolygon; }

      bool candidatesAreConflicting( const LabelPosition *lp1, const LabelPosition *lp2 ) const;

      void setRules( const QList< QgsAbstractLabelingEngineRule * > &rules );

      QList< QgsAbstractLabelingEngineRule * > rules() const { return mRules; }
 
    private:
      Qgis::LabelingFlags mFlags;
 
      std::vector< std::pair< QgsAbstractLabelProvider *, std::unique_ptr< Layer > > > mLayers;
 
      QList< QgsAbstractLabelingEngineRule * > mRules;
 
      QMutex mMutex;
 
      /*
       * POPMUSIC Tuning
       */
      int mPopmusicR = 30;
 
      int mTabuMaxIt = 4;
      int mTabuMinIt = 2;
 
      int mEjChainDeg = 50;
      int mTenure = 10;
      double mCandListSize = 0.2;
 
      unsigned int mNextCandidateId = 1;
      mutable QHash< QPair< unsigned int, unsigned int >, bool > mCandidateConflicts;

      bool mShowPartialLabels = DEFAULT_SHOW_PARTIAL_LABELS;
 
      double mMaxLineCandidatesPerMapUnit = 0;
      double mMaxPolygonCandidatesPerMapUnitSquared = 0;
 
      int mGlobalCandidatesLimitPoint = 0;
      int mGlobalCandidatesLimitLine = 0;
      int mGlobalCandidatesLimitPolygon = 0;
 
      Qgis::LabelPlacementEngineVersion mPlacementVersion = Qgis::LabelPlacementEngineVersion::Version2;

      FnIsCanceled fnIsCanceled = nullptr;
      void *fnIsCanceledContext = nullptr;

      void setPopmusicR( int r );

      void setMinIt( int min_it );

      void setMaxIt( int max_it );

      void setTenure( int tenure );

      void setEjChainDeg( int degree );

      void setCandListSize( double fact );
 

      int getMinIt() const;

      int getMaxIt() const;
  };
 
} // end namespace pal
 
#endif