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 "rtree.hpp"
#include <QMutex>
#include <QLinkedList>
#include <QHash>
#include <fstream>

class QgsLabelFeature;

namespace pal
{

  template<class DATATYPE, class ELEMTYPE, int NUMDIMS, class ELEMTYPEREAL, int TMAXNODES, int TMINNODES> class RTree;

  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
      };

      virtual ~Layer();

      bool displayAll() const { return mDisplayAll; }

      int featureCount() { return mHashtable.size(); }

      int 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 std::min( pal->point_p, 4 );
        else if ( size > 500 )
          return std::min( pal->point_p, 6 );
        else if ( size > 200 )
          return std::min( pal->point_p, 8 );
        else if ( size > 100 )
          return std::min( pal->point_p, 12 );
        else
          return pal->point_p;
      }

      int 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 std::min( pal->line_p, 5 );
        else if ( size > 500 )
          return std::min( pal->line_p, 10 );
        else if ( size > 200 )
          return std::min( pal->line_p, 20 );
        else if ( size > 100 )
          return std::min( pal->line_p, 40 );
        else
          return pal->line_p;
      }

      int 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 std::min( pal->poly_p, 5 );
        else if ( size > 500 )
          return std::min( pal->poly_p, 15 );
        else if ( size > 200 )
          return std::min( pal->poly_p, 20 );
        else if ( size > 100 )
          return std::min( pal->poly_p, 25 );
        else
          return pal->poly_p;
      }

      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; }

      QgsPalLayerSettings::ObstacleType obstacleType() const { return mObstacleType; }

      void setObstacleType( QgsPalLayerSettings::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;

      QLinkedList<FeaturePart *> mFeatureParts;

      QList<FeaturePart *> mObstacleParts;

      Pal *pal = nullptr;

      double mDefaultPriority;

      QgsPalLayerSettings::ObstacleType mObstacleType;
      bool mActive;
      bool mLabelLayer;
      bool mDisplayAll;
      bool mCentroidInside;

      QgsPalLayerSettings::Placement mArrangement;

      bool mMergeLines;

      UpsideDownLabels mUpsidedownLabels;

      // indexes (spatial and id)
      RTree<FeaturePart *, double, 2, double, 8, 4> *mFeatureIndex;
      QHash< QgsFeatureId, QgsLabelFeature *> mHashtable;

      //obstacle r-tree
      RTree<FeaturePart *, double, 2, double, 8, 4> *mObstacleIndex;

      QHash< QString, QVector<FeaturePart *> > mConnectedHashtable;
      QHash< QgsFeatureId, int > mConnectedFeaturesIds;

      QMutex mMutex;

      Layer( QgsAbstractLabelProvider *provider, const QString &name, QgsPalLayerSettings::Placement arrangement, double defaultPriority, bool active, bool toLabel, Pal *pal, bool displayAll = false );

      void addFeaturePart( FeaturePart *fpart, const QString &labelText = QString() );

      void addObstaclePart( FeaturePart *fpart );

  };

} // end namespace pal

#endif