QGIS API Documentation  3.4.15-Madeira (e83d02e274)
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 
126  void setActive( bool active ) { mActive = active; }
127 
132  bool active() const { return mActive; }
133 
141  void setLabelLayer( bool toLabel ) { mLabelLayer = toLabel; }
142 
147  bool labelLayer() const { return mLabelLayer; }
148 
154  QgsPalLayerSettings::ObstacleType obstacleType() const { return mObstacleType; }
155 
162  void setObstacleType( QgsPalLayerSettings::ObstacleType obstacleType ) { mObstacleType = obstacleType; }
163 
170  void setPriority( double priority );
171 
177  double priority() const { return mDefaultPriority; }
178 
184  void setLabelMode( LabelMode mode ) { mMode = mode; }
185 
190  LabelMode labelMode() const { return mMode; }
191 
197  void setMergeConnectedLines( bool merge ) { mMergeLines = merge; }
198 
203  bool mergeConnectedLines() const { return mMergeLines; }
204 
210  void setUpsidedownLabels( UpsideDownLabels ud ) { mUpsidedownLabels = ud; }
211 
216  UpsideDownLabels upsidedownLabels() const { return mUpsidedownLabels; }
217 
225  void setCentroidInside( bool forceInside ) { mCentroidInside = forceInside; }
226 
232  bool centroidInside() const { return mCentroidInside; }
233 
243  bool registerFeature( QgsLabelFeature *label );
244 
246  void joinConnectedFeatures();
247 
253  int connectedFeatureId( QgsFeatureId featureId ) const;
254 
256  void chopFeaturesAtRepeatDistance();
257 
258  protected:
260  QString mName;
261 
263  QLinkedList<FeaturePart *> mFeatureParts;
264 
266  QList<FeaturePart *> mObstacleParts;
267 
268  Pal *pal = nullptr;
269 
271 
273  bool mActive;
277 
280 
283 
285 
286  // indexes (spatial and id)
287  RTree<FeaturePart *, double, 2, double, 8, 4> *mFeatureIndex;
289  QHash< QgsFeatureId, QgsLabelFeature *> mHashtable;
290 
291  //obstacle r-tree
292  RTree<FeaturePart *, double, 2, double, 8, 4> *mObstacleIndex;
293 
294  QHash< QString, QVector<FeaturePart *> > mConnectedHashtable;
295  QHash< QgsFeatureId, int > mConnectedFeaturesIds;
296 
297  QMutex mMutex;
298 
312  Layer( QgsAbstractLabelProvider *provider, const QString &name, QgsPalLayerSettings::Placement arrangement, double defaultPriority, bool active, bool toLabel, Pal *pal, bool displayAll = false );
313 
315  void addFeaturePart( FeaturePart *fpart, const QString &labelText = QString() );
316 
318  void addObstaclePart( FeaturePart *fpart );
319 
320  };
321 
322 } // end namespace pal
323 
324 #endif
QList< FeaturePart * > mObstacleParts
List of obstacle parts.
Definition: layer.h:266
QHash< QgsFeatureId, int > mConnectedFeaturesIds
Definition: layer.h:295
UpsideDownLabels upsidedownLabels() const
Returns how upside down labels are handled within the layer.
Definition: layer.h:216
bool mMergeLines
Definition: layer.h:282
bool mActive
Definition: layer.h:273
bool mLabelLayer
Definition: layer.h:274
bool active() const
Returns whether the layer is currently active.
Definition: layer.h:132
bool labelLayer() const
Returns whether the layer will be labeled or not.
Definition: layer.h:147
QHash< QgsFeatureId, QgsLabelFeature * > mHashtable
Lookup table of label features (owned by the label feature provider that created them) ...
Definition: layer.h:289
A set of features which influence the labeling process.
Definition: layer.h:63
double mDefaultPriority
Definition: layer.h:270
qint64 QgsFeatureId
Definition: qgsfeatureid.h:25
Main Pal labeling class.
Definition: pal.h:87
UpsideDownLabels
Definition: layer.h:74
bool displayAll() const
Definition: layer.h:83
double priority() const
Returns the layer&#39;s priority, between 0 and 1.
Definition: layer.h:177
bool centroidInside() const
Returns whether labels placed at the centroid of features within the layer are forced to be placed in...
Definition: layer.h:232
void setUpsidedownLabels(UpsideDownLabels ud)
Sets how upside down labels will be handled within the layer.
Definition: layer.h:210
void setObstacleType(QgsPalLayerSettings::ObstacleType obstacleType)
Sets the obstacle type, which controls how features within the layer act as obstacles for labels...
Definition: layer.h:162
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:225
QString mName
Definition: layer.h:260
bool mergeConnectedLines() const
Returns whether connected lines will be merged before labeling.
Definition: layer.h:203
QHash< QString, QVector< FeaturePart * > > mConnectedHashtable
Definition: layer.h:294
QgsPalLayerSettings::Placement arrangement() const
Returns the layer&#39;s arrangement policy.
Definition: layer.h:102
RTree< FeaturePart *, double, 2, double, 8, 4 > * mFeatureIndex
Definition: layer.h:287
QgsPalLayerSettings::ObstacleType obstacleType() const
Returns the obstacle type, which controls how features within the layer act as obstacles for labels...
Definition: layer.h:154
void setArrangement(QgsPalLayerSettings::Placement arrangement)
Sets the layer&#39;s arrangement policy.
Definition: layer.h:114
int featureCount()
Returns the number of features in layer.
Definition: layer.h:88
QgsAbstractLabelProvider * provider() const
Returns pointer to the associated provider.
Definition: layer.h:91
bool mCentroidInside
Definition: layer.h:276
QgsPalLayerSettings::ObstacleType mObstacleType
Definition: layer.h:272
Main class to handle feature.
Definition: feature.h:96
The QgsAbstractLabelProvider class is an interface class.
Placement
Placement modes which determine how label candidates are generated for a feature. ...
LabelMode
Definition: layer.h:73
bool mDisplayAll
Definition: layer.h:275
void setActive(bool active)
Sets whether the layer is currently active.
Definition: layer.h:126
void setLabelLayer(bool toLabel)
Sets whether the layer will be labeled.
Definition: layer.h:141
QgsAbstractLabelProvider * mProvider
Definition: layer.h:259
The QgsLabelFeature class describes a feature that should be used within the labeling engine...
QLinkedList< FeaturePart * > mFeatureParts
List of feature parts.
Definition: layer.h:263
RTree< FeaturePart *, double, 2, double, 8, 4 > * mObstacleIndex
Definition: layer.h:292
void setLabelMode(LabelMode mode)
Sets the layer&#39;s labeling mode.
Definition: layer.h:184
QMutex mMutex
Definition: layer.h:297
LabelPosition is a candidate feature label position.
Definition: labelposition.h:55
QString name() const
Returns the layer&#39;s name.
Definition: layer.h:96
LabelMode mMode
Definition: layer.h:281
Representation of a labeling problem.
Definition: problem.h:107
QgsPalLayerSettings::Placement mArrangement
Optional flags used for some placement methods.
Definition: layer.h:279
bool isCurved() const
Returns true if the layer has curved labels.
Definition: layer.h:107
LabelMode labelMode() const
Returns the layer&#39;s labeling mode.
Definition: layer.h:190
UpsideDownLabels mUpsidedownLabels
Definition: layer.h:284
void setMergeConnectedLines(bool merge)
Sets whether connected lines should be merged before labeling.
Definition: layer.h:197
ObstacleType
Valid obstacle types, which affect how features within the layer will act as obstacles for labels...