QGIS API Documentation  2.99.0-Master (cd0ba91)
layer.h
Go to the documentation of this file.
1 /*
2  * libpal - Automated Placement of Labels Library
3  *
4  * Copyright (C) 2008 Maxence Laurent, MIS-TIC, HEIG-VD
5  * University of Applied Sciences, Western Switzerland
6  * http://www.hes-so.ch
7  *
8  * Contact:
9  * maxence.laurent <at> heig-vd <dot> ch
10  * or
11  * eric.taillard <at> heig-vd <dot> ch
12  *
13  * This file is part of libpal.
14  *
15  * libpal is free software: you can redistribute it and/or modify
16  * it under the terms of the GNU General Public License as published by
17  * the Free Software Foundation, either version 3 of the License, or
18  * (at your option) any later version.
19  *
20  * libpal is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23  * GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License
26  * along with libpal. If not, see <http://www.gnu.org/licenses/>.
27  *
28  */
29 
30 #ifndef PAL_LAYER_H_
31 #define PAL_LAYER_H_
32 
33 #define SIP_NO_FILE
34 
35 
36 #include "qgis_core.h"
37 #include "pal.h" // for LineArrangementFlags enum
38 #include "rtree.hpp"
39 #include <QMutex>
40 #include <QLinkedList>
41 #include <QHash>
42 #include <fstream>
43 
44 class QgsLabelFeature;
45 
46 namespace pal
47 {
48 
50  template<class DATATYPE, class ELEMTYPE, int NUMDIMS, class ELEMTYPEREAL, int TMAXNODES, int TMINNODES> class RTree;
52 
53  class FeaturePart;
54  class Pal;
55  class LabelInfo;
56 
63  class CORE_EXPORT Layer
64  {
65  friend class Pal;
66  friend class FeaturePart;
67 
68  friend class Problem;
69 
70  friend class LabelPosition;
71 
72  public:
73  enum LabelMode { LabelPerFeature, LabelPerFeaturePart };
75  {
76  Upright, // upside-down labels (90 <= angle < 270) are shown upright
77  ShowDefined, // show upside down when rotation is layer- or data-defined
78  ShowAll // show upside down for all labels, including dynamic ones
79  };
80 
81  virtual ~Layer();
82 
83  bool displayAll() const { return mDisplayAll; }
84 
88  int featureCount() { return mHashtable.size(); }
89 
91  QgsAbstractLabelProvider *provider() const { return mProvider; }
92 
96  QString name() const { return mName; }
97 
102  QgsPalLayerSettings::Placement arrangement() const { return mArrangement; }
103 
107  bool isCurved() const { return mArrangement == QgsPalLayerSettings::Curved || mArrangement == QgsPalLayerSettings::PerimeterCurved; }
108 
114  void setArrangement( QgsPalLayerSettings::Placement arrangement ) { mArrangement = arrangement; }
115 
120  LineArrangementFlags arrangementFlags() const { return mArrangementFlags; }
121 
127  void setArrangementFlags( LineArrangementFlags flags ) { mArrangementFlags = flags; }
128 
139  void setActive( bool active ) { mActive = active; }
140 
145  bool active() const { return mActive; }
146 
154  void setLabelLayer( bool toLabel ) { mLabelLayer = toLabel; }
155 
160  bool labelLayer() const { return mLabelLayer; }
161 
167  QgsPalLayerSettings::ObstacleType obstacleType() const { return mObstacleType; }
168 
175  void setObstacleType( QgsPalLayerSettings::ObstacleType obstacleType ) { mObstacleType = obstacleType; }
176 
183  void setPriority( double priority );
184 
190  double priority() const { return mDefaultPriority; }
191 
197  void setLabelMode( LabelMode mode ) { mMode = mode; }
198 
203  LabelMode labelMode() const { return mMode; }
204 
210  void setMergeConnectedLines( bool merge ) { mMergeLines = merge; }
211 
216  bool mergeConnectedLines() const { return mMergeLines; }
217 
223  void setUpsidedownLabels( UpsideDownLabels ud ) { mUpsidedownLabels = ud; }
224 
229  UpsideDownLabels upsidedownLabels() const { return mUpsidedownLabels; }
230 
238  void setCentroidInside( bool forceInside ) { mCentroidInside = forceInside; }
239 
245  bool centroidInside() const { return mCentroidInside; }
246 
256  bool registerFeature( QgsLabelFeature *label );
257 
259  void joinConnectedFeatures();
260 
266  int connectedFeatureId( QgsFeatureId featureId ) const;
267 
269  void chopFeaturesAtRepeatDistance();
270 
271  protected:
273  QString mName;
274 
276  QLinkedList<FeaturePart *> mFeatureParts;
277 
279  QList<FeaturePart *> mObstacleParts;
280 
281  Pal *pal = nullptr;
282 
284 
286  bool mActive;
290 
293  LineArrangementFlags mArrangementFlags;
296 
298 
299  // indexes (spatial and id)
300  RTree<FeaturePart *, double, 2, double, 8, 4> *mFeatureIndex;
302  QHash< QgsFeatureId, QgsLabelFeature *> mHashtable;
303 
304  //obstacle r-tree
305  RTree<FeaturePart *, double, 2, double, 8, 4> *mObstacleIndex;
306 
307  QHash< QString, QLinkedList<FeaturePart *>* > mConnectedHashtable;
308  QStringList mConnectedTexts;
309  QHash< QgsFeatureId, int > mConnectedFeaturesIds;
310 
311  QMutex mMutex;
312 
326  Layer( QgsAbstractLabelProvider *provider, const QString &name, QgsPalLayerSettings::Placement arrangement, double defaultPriority, bool active, bool toLabel, Pal *pal, bool displayAll = false );
327 
329  void addFeaturePart( FeaturePart *fpart, const QString &labelText = QString() );
330 
332  void addObstaclePart( FeaturePart *fpart );
333 
334  };
335 
336 } // end namespace pal
337 
338 #endif
bool labelLayer() const
Returns whether the layer will be labeled or not.
Definition: layer.h:160
QgsAbstractLabelProvider * provider() const
Returns pointer to the associated provider.
Definition: layer.h:91
bool centroidInside() const
Returns whether labels placed at the centroid of features within the layer are forced to be placed in...
Definition: layer.h:245
QList< FeaturePart * > mObstacleParts
List of obstacle parts.
Definition: layer.h:279
QHash< QgsFeatureId, int > mConnectedFeaturesIds
Definition: layer.h:309
bool mergeConnectedLines() const
Returns whether connected lines will be merged before labeling.
Definition: layer.h:216
bool mMergeLines
Definition: layer.h:295
bool mActive
Definition: layer.h:286
bool mLabelLayer
Definition: layer.h:287
QStringList mConnectedTexts
Definition: layer.h:308
QHash< QgsFeatureId, QgsLabelFeature * > mHashtable
Lookup table of label features (owned by the label feature provider that created them) ...
Definition: layer.h:302
A set of features which influence the labeling process.
Definition: layer.h:63
double mDefaultPriority
Definition: layer.h:283
Main Pal labeling class.
Definition: pal.h:89
UpsideDownLabels
Definition: layer.h:74
void setUpsidedownLabels(UpsideDownLabels ud)
Sets how upside down labels will be handled within the layer.
Definition: layer.h:223
UpsideDownLabels upsidedownLabels() const
Returns how upside down labels are handled within the layer.
Definition: layer.h:229
void setObstacleType(QgsPalLayerSettings::ObstacleType obstacleType)
Sets the obstacle type, which controls how features within the layer act as obstacles for labels...
Definition: layer.h:175
void setCentroidInside(bool forceInside)
Sets whether labels placed at the centroid of features within the layer are forced to be placed insid...
Definition: layer.h:238
QgsPalLayerSettings::ObstacleType obstacleType() const
Returns the obstacle type, which controls how features within the layer act as obstacles for labels...
Definition: layer.h:167
QString mName
Definition: layer.h:273
bool displayAll() const
Definition: layer.h:83
QHash< QString, QLinkedList< FeaturePart * > *> mConnectedHashtable
Definition: layer.h:307
double priority() const
Returns the layer&#39;s priority, between 0 and 1.
Definition: layer.h:190
RTree< FeaturePart *, double, 2, double, 8, 4 > * mFeatureIndex
Definition: layer.h:300
void setArrangement(QgsPalLayerSettings::Placement arrangement)
Sets the layer&#39;s arrangement policy.
Definition: layer.h:114
QgsPalLayerSettings::Placement arrangement() const
Returns the layer&#39;s arrangement policy.
Definition: layer.h:102
int featureCount()
Returns the number of features in layer.
Definition: layer.h:88
bool mCentroidInside
Definition: layer.h:289
QgsPalLayerSettings::ObstacleType mObstacleType
Definition: layer.h:285
Main class to handle feature.
Definition: feature.h:96
The QgsAbstractLabelProvider class is an interface class.
LineArrangementFlags mArrangementFlags
Definition: layer.h:293
Placement
Placement modes which determine how label candidates are generated for a feature. ...
LabelMode
Definition: layer.h:73
bool mDisplayAll
Definition: layer.h:288
void setActive(bool active)
Sets whether the layer is currently active.
Definition: layer.h:139
void setLabelLayer(bool toLabel)
Sets whether the layer will be labeled.
Definition: layer.h:154
QgsAbstractLabelProvider * mProvider
Definition: layer.h:272
The QgsLabelFeature class describes a feature that should be used within the labeling engine...
QLinkedList< FeaturePart * > mFeatureParts
List of feature parts.
Definition: layer.h:276
RTree< FeaturePart *, double, 2, double, 8, 4 > * mObstacleIndex
Definition: layer.h:305
void setLabelMode(LabelMode mode)
Sets the layer&#39;s labeling mode.
Definition: layer.h:197
QMutex mMutex
Definition: layer.h:311
QString name() const
Returns the layer&#39;s name.
Definition: layer.h:96
bool active() const
Returns whether the layer is currently active.
Definition: layer.h:145
LabelPosition is a candidate feature label position.
Definition: labelposition.h:55
LabelMode mMode
Definition: layer.h:294
qint64 QgsFeatureId
Definition: qgsfeature.h:37
Representation of a labeling problem.
Definition: problem.h:107
void setArrangementFlags(LineArrangementFlags flags)
Sets the layer&#39;s arrangement flags.
Definition: layer.h:127
LineArrangementFlags arrangementFlags() const
Returns the layer&#39;s arrangement flags.
Definition: layer.h:120
QgsPalLayerSettings::Placement mArrangement
Optional flags used for some placement methods.
Definition: layer.h:292
LabelMode labelMode() const
Returns the layer&#39;s labeling mode.
Definition: layer.h:203
bool isCurved() const
Returns true if the layer has curved labels.
Definition: layer.h:107
UpsideDownLabels mUpsidedownLabels
Definition: layer.h:297
void setMergeConnectedLines(bool merge)
Sets whether connected lines should be merged before labeling.
Definition: layer.h:210
ObstacleType
Valid obstacle types, which affect how features within the layer will act as obstacles for labels...