layer.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_LAYER_H_
#define PAL_LAYER_H_
 
#define SIP_NO_FILE
 
 
#include "qgis_core.h"
#include "pal.h" // for LineArrangementFlags enum
#include "qgsgeos.h"
#include "qgsgenericspatialindex.h"
#include <QMutex>
#include <QLinkedList>
#include <QHash>
#include <fstream>
 
class QgsLabelFeature;
 
namespace pal
{
 
  class FeaturePart;
 
  class Pal;
  class LabelInfo;
 
  class CORE_EXPORT Layer
  {
      friend class Pal;
      friend class FeaturePart;
 
      friend class Problem;
 
      friend class LabelPosition;
 
    public:
      enum UpsideDownLabels
      {
        Upright, // upside-down labels (90 <= angle < 270) are shown upright
        ShowDefined, // show upside down when rotation is layer- or data-defined
        ShowAll // show upside down for all labels, including dynamic ones
      };
 
      Layer( QgsAbstractLabelProvider *provider, const QString &name, QgsPalLayerSettings::Placement arrangement, double defaultPriority, bool active, bool toLabel, Pal *pal, bool displayAll = false );
 
      virtual ~Layer();
 
      bool displayAll() const { return mDisplayAll; }
 
      int featureCount() { return mHashtable.size(); }
 
      std::size_t maximumPointLabelCandidates() const
      {
        // when an extreme number of features exist in the layer, we limit the number of candidates
        // to avoid the engine processing endlessly...
        const int size = mHashtable.size();
        if ( size > 1000 )
          return static_cast< std::size_t >( mPal->globalCandidatesLimitPoint() > 0 ? std::min( mPal->globalCandidatesLimitPoint(), 4 ) : 4 );
        else if ( size > 500 )
          return static_cast< std::size_t >( mPal->globalCandidatesLimitPoint() > 0 ? std::min( mPal->globalCandidatesLimitPoint(), 6 ) : 6 );
        else if ( size > 200 )
          return static_cast< std::size_t >( mPal->globalCandidatesLimitPoint() > 0 ? std::min( mPal->globalCandidatesLimitPoint(), 8 ) : 8 );
        else if ( size > 100 )
          return static_cast< std::size_t >( mPal->globalCandidatesLimitPoint() > 0 ? std::min( mPal->globalCandidatesLimitPoint(), 12 ) : 12 );
        else
          return static_cast< std::size_t >( std::max( mPal->globalCandidatesLimitPoint(), 0 ) );
      }
 
      std::size_t maximumLineLabelCandidates() const
      {
        // when an extreme number of features exist in the layer, we limit the number of candidates
        // to avoid the engine processing endlessly...
        const int size = mHashtable.size();
        if ( size > 1000 )
          return static_cast< std::size_t >( mPal->globalCandidatesLimitLine() > 0 ? std::min( mPal->globalCandidatesLimitLine(), 5 ) : 5 );
        else if ( size > 500 )
          return static_cast< std::size_t >( mPal->globalCandidatesLimitLine() > 0 ? std::min( mPal->globalCandidatesLimitLine(), 10 ) : 10 );
        else if ( size > 200 )
          return static_cast< std::size_t >( mPal->globalCandidatesLimitLine() > 0 ? std::min( mPal->globalCandidatesLimitLine(), 20 ) : 20 );
        else if ( size > 100 )
          return static_cast< std::size_t >( mPal->globalCandidatesLimitLine() > 0 ? std::min( mPal->globalCandidatesLimitLine(), 40 ) : 40 );
        else
          return static_cast< std::size_t >( std::max( mPal->globalCandidatesLimitLine(), 0 ) );
      }
 
      std::size_t maximumPolygonLabelCandidates() const
      {
        // when an extreme number of features exist in the layer, we limit the number of candidates
        // to avoid the engine processing endlessly...
        const int size = mHashtable.size();
        if ( size > 1000 )
          return static_cast< std::size_t >( mPal->globalCandidatesLimitPolygon() > 0 ? std::min( mPal->globalCandidatesLimitPolygon(), 5 ) : 5 );
        else if ( size > 500 )
          return static_cast< std::size_t >( mPal->globalCandidatesLimitPolygon() > 0 ? std::min( mPal->globalCandidatesLimitPolygon(), 15 ) : 15 );
        else if ( size > 200 )
          return static_cast< std::size_t >( mPal->globalCandidatesLimitPolygon() > 0 ? std::min( mPal->globalCandidatesLimitPolygon(), 20 ) : 20 );
        else if ( size > 100 )
          return static_cast< std::size_t >( mPal->globalCandidatesLimitPolygon() > 0 ? std::min( mPal->globalCandidatesLimitPolygon(), 25 ) : 25 );
        else
          return static_cast< std::size_t >( std::max( mPal->globalCandidatesLimitPolygon(), 0 ) );
      }
 
      QgsAbstractLabelProvider *provider() const { return mProvider; }
 
      QString name() const { return mName; }
 
      QgsPalLayerSettings::Placement arrangement() const { return mArrangement; }
 
      bool isCurved() const { return mArrangement == QgsPalLayerSettings::Curved || mArrangement == QgsPalLayerSettings::PerimeterCurved; }
 
      void setArrangement( QgsPalLayerSettings::Placement arrangement ) { mArrangement = arrangement; }
 
      void setActive( bool active ) { mActive = active; }
 
      bool active() const { return mActive; }
 
      void setLabelLayer( bool toLabel ) { mLabelLayer = toLabel; }
 
      bool labelLayer() const { return mLabelLayer; }
 
      QgsLabelObstacleSettings::ObstacleType obstacleType() const { return mObstacleType; }
 
      void setObstacleType( QgsLabelObstacleSettings::ObstacleType obstacleType ) { mObstacleType = obstacleType; }
 
      void setPriority( double priority );
 
      double priority() const { return mDefaultPriority; }
 
      void setMergeConnectedLines( bool merge ) { mMergeLines = merge; }
 
      bool mergeConnectedLines() const { return mMergeLines; }
 
      void setUpsidedownLabels( UpsideDownLabels ud ) { mUpsidedownLabels = ud; }
 
      UpsideDownLabels upsidedownLabels() const { return mUpsidedownLabels; }
 
      void setCentroidInside( bool forceInside ) { mCentroidInside = forceInside; }
 
      bool centroidInside() const { return mCentroidInside; }
 
      bool registerFeature( QgsLabelFeature *label );
 
      void joinConnectedFeatures();
 
      int connectedFeatureId( QgsFeatureId featureId ) const;
 
      void chopFeaturesAtRepeatDistance();
 
    protected:
      QgsAbstractLabelProvider *mProvider; // not owned
      QString mName;
 
      std::deque< std::unique_ptr< FeaturePart > > mFeatureParts;
 
      QList<FeaturePart *> mObstacleParts;
 
      std::vector< geos::unique_ptr > mGeosObstacleGeometries;
 
      Pal *mPal = nullptr;
 
      double mDefaultPriority;
 
      QgsLabelObstacleSettings::ObstacleType mObstacleType = QgsLabelObstacleSettings::PolygonBoundary;
      bool mActive;
      bool mLabelLayer;
      bool mDisplayAll;
      bool mCentroidInside;
 
      QgsPalLayerSettings::Placement mArrangement;
 
      bool mMergeLines;
 
      UpsideDownLabels mUpsidedownLabels;
 
      QHash< QgsFeatureId, QgsLabelFeature *> mHashtable;
 
      QHash< QString, QVector<FeaturePart *> > mConnectedHashtable;
      QHash< QgsFeatureId, int > mConnectedFeaturesIds;
 
      QMutex mMutex;
 
      void addFeaturePart( std::unique_ptr< FeaturePart > fpart, const QString &labelText = QString() );
 
      void addObstaclePart( FeaturePart *fpart );
 
  };
 
} // end namespace pal
 
 
#endif