QGIS API Documentation  2.99.0-Master (e077efd)
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 #include "pal.h" // for LineArrangementFlags enum
34 #include "rtree.hpp"
35 #include <QMutex>
36 #include <QLinkedList>
37 #include <QHash>
38 #include <fstream>
39 
40 class QgsLabelFeature;
41 
42 namespace pal
43 {
44 
46  template<class DATATYPE, class ELEMTYPE, int NUMDIMS, class ELEMTYPEREAL, int TMAXNODES, int TMINNODES> class RTree;
48 
49  class FeaturePart;
50  class Pal;
51  class LabelInfo;
52 
59  class CORE_EXPORT Layer
60  {
61  friend class Pal;
62  friend class FeaturePart;
63 
64  friend class Problem;
65 
66  friend class LabelPosition;
67 
68  public:
69  enum LabelMode { LabelPerFeature, LabelPerFeaturePart };
71  {
72  Upright, // upside-down labels (90 <= angle < 270) are shown upright
73  ShowDefined, // show upside down when rotation is layer- or data-defined
74  ShowAll // show upside down for all labels, including dynamic ones
75  };
76 
77  virtual ~Layer();
78 
79  bool displayAll() const { return mDisplayAll; }
80 
83  int featureCount() { return mHashtable.size(); }
84 
86  QgsAbstractLabelProvider* provider() const { return mProvider; }
87 
90  QString name() const { return mName; }
91 
95  QgsPalLayerSettings::Placement arrangement() const { return mArrangement; }
96 
99  bool isCurved() const { return mArrangement == QgsPalLayerSettings::Curved || mArrangement == QgsPalLayerSettings::PerimeterCurved; }
100 
105  void setArrangement( QgsPalLayerSettings::Placement arrangement ) { mArrangement = arrangement; }
106 
110  LineArrangementFlags arrangementFlags() const { return mArrangementFlags; }
111 
116  void setArrangementFlags( LineArrangementFlags flags ) { mArrangementFlags = flags; }
117 
128  void setActive( bool active ) { mActive = active; }
129 
133  bool active() const { return mActive; }
134 
141  void setLabelLayer( bool toLabel ) { mLabelLayer = toLabel; }
142 
146  bool labelLayer() const { return mLabelLayer; }
147 
152  QgsPalLayerSettings::ObstacleType obstacleType() const { return mObstacleType; }
153 
159  void setObstacleType( QgsPalLayerSettings::ObstacleType obstacleType ) { mObstacleType = obstacleType; }
160 
166  void setPriority( double priority );
167 
172  double priority() const { return mDefaultPriority; }
173 
178  void setLabelMode( LabelMode mode ) { mMode = mode; }
179 
183  LabelMode labelMode() const { return mMode; }
184 
189  void setMergeConnectedLines( bool merge ) { mMergeLines = merge; }
190 
194  bool mergeConnectedLines() const { return mMergeLines; }
195 
200  void setUpsidedownLabels( UpsideDownLabels ud ) { mUpsidedownLabels = ud; }
201 
205  UpsideDownLabels upsidedownLabels() const { return mUpsidedownLabels; }
206 
213  void setCentroidInside( bool forceInside ) { mCentroidInside = forceInside; }
214 
219  bool centroidInside() const { return mCentroidInside; }
220 
229  bool registerFeature( QgsLabelFeature* label );
230 
232  void joinConnectedFeatures();
233 
238  int connectedFeatureId( QgsFeatureId featureId ) const;
239 
241  void chopFeaturesAtRepeatDistance();
242 
243  protected:
245  QString mName;
246 
248  QLinkedList<FeaturePart*> mFeatureParts;
249 
251  QList<FeaturePart*> mObstacleParts;
252 
254 
256 
258  bool mActive;
262 
265  LineArrangementFlags mArrangementFlags;
268 
270 
271  // indexes (spatial and id)
272  RTree<FeaturePart*, double, 2, double, 8, 4> *mFeatureIndex;
274  QHash< QgsFeatureId, QgsLabelFeature*> mHashtable;
275 
276  //obstacle r-tree
277  RTree<FeaturePart*, double, 2, double, 8, 4> *mObstacleIndex;
278 
279  QHash< QString, QLinkedList<FeaturePart*>* > mConnectedHashtable;
280  QStringList mConnectedTexts;
281  QHash< QgsFeatureId, int > mConnectedFeaturesIds;
282 
283  QMutex mMutex;
284 
298  Layer( QgsAbstractLabelProvider* provider, const QString& name, QgsPalLayerSettings::Placement arrangement, double defaultPriority, bool active, bool toLabel, Pal *pal, bool displayAll = false );
299 
301  void addFeaturePart( FeaturePart* fpart, const QString &labelText = QString() );
302 
304  void addObstaclePart( FeaturePart* fpart );
305 
306  };
307 
308 } // end namespace pal
309 
310 #endif
bool labelLayer() const
Returns whether the layer will be labeled or not.
Definition: layer.h:146
QgsAbstractLabelProvider * provider() const
Returns pointer to the associated provider.
Definition: layer.h:86
bool centroidInside() const
Returns whether labels placed at the centroid of features within the layer are forced to be placed in...
Definition: layer.h:219
QHash< QgsFeatureId, int > mConnectedFeaturesIds
Definition: layer.h:281
bool mergeConnectedLines() const
Returns whether connected lines will be merged before labeling.
Definition: layer.h:194
bool mMergeLines
Definition: layer.h:267
bool mActive
Definition: layer.h:258
bool mLabelLayer
Definition: layer.h:259
QLinkedList< FeaturePart * > mFeatureParts
List of feature parts.
Definition: layer.h:248
QStringList mConnectedTexts
Definition: layer.h:280
A set of features which influence the labelling process.
Definition: layer.h:59
QHash< QgsFeatureId, QgsLabelFeature * > mHashtable
Lookup table of label features (owned by the label feature provider that created them) ...
Definition: layer.h:274
double mDefaultPriority
Definition: layer.h:255
Main Pal labelling class.
Definition: pal.h:84
UpsideDownLabels
Definition: layer.h:70
void setUpsidedownLabels(UpsideDownLabels ud)
Sets how upside down labels will be handled within the layer.
Definition: layer.h:200
UpsideDownLabels upsidedownLabels() const
Returns how upside down labels are handled within the layer.
Definition: layer.h:205
void setObstacleType(QgsPalLayerSettings::ObstacleType obstacleType)
Sets the obstacle type, which controls how features within the layer act as obstacles for labels...
Definition: layer.h:159
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:213
QgsPalLayerSettings::ObstacleType obstacleType() const
Returns the obstacle type, which controls how features within the layer act as obstacles for labels...
Definition: layer.h:152
QString mName
Definition: layer.h:245
bool displayAll() const
Definition: layer.h:79
double priority() const
Returns the layer&#39;s priority, between 0 and 1.
Definition: layer.h:172
void setArrangement(QgsPalLayerSettings::Placement arrangement)
Sets the layer&#39;s arrangement policy.
Definition: layer.h:105
QgsPalLayerSettings::Placement arrangement() const
Returns the layer&#39;s arrangement policy.
Definition: layer.h:95
int featureCount()
Returns the number of features in layer.
Definition: layer.h:83
bool mCentroidInside
Definition: layer.h:261
QgsPalLayerSettings::ObstacleType mObstacleType
Definition: layer.h:257
QList< FeaturePart * > mObstacleParts
List of obstacle parts.
Definition: layer.h:251
Main class to handle feature.
Definition: feature.h:89
The QgsAbstractLabelProvider class is an interface class.
LineArrangementFlags mArrangementFlags
Definition: layer.h:265
RTree< FeaturePart *, double, 2, double, 8, 4 > * mObstacleIndex
Definition: layer.h:277
Placement
Placement modes which determine how label candidates are generated for a feature. ...
Pal * pal
Definition: layer.h:253
QHash< QString, QLinkedList< FeaturePart * > *> mConnectedHashtable
Definition: layer.h:279
LabelMode
Definition: layer.h:69
bool mDisplayAll
Definition: layer.h:260
void setActive(bool active)
Sets whether the layer is currently active.
Definition: layer.h:128
void setLabelLayer(bool toLabel)
Sets whether the layer will be labeled.
Definition: layer.h:141
QgsAbstractLabelProvider * mProvider
Definition: layer.h:244
The QgsLabelFeature class describes a feature that should be used within the labeling engine...
RTree< FeaturePart *, double, 2, double, 8, 4 > * mFeatureIndex
Definition: layer.h:272
void setLabelMode(LabelMode mode)
Sets the layer&#39;s labeling mode.
Definition: layer.h:178
QMutex mMutex
Definition: layer.h:283
QString name() const
Returns the layer&#39;s name.
Definition: layer.h:90
bool active() const
Returns whether the layer is currently active.
Definition: layer.h:133
LabelPosition is a candidate feature label position.
Definition: labelposition.h:51
LabelMode mMode
Definition: layer.h:266
qint64 QgsFeatureId
Definition: qgsfeature.h:32
Representation of a labeling problem.
Definition: problem.h:103
void setArrangementFlags(LineArrangementFlags flags)
Sets the layer&#39;s arrangement flags.
Definition: layer.h:116
LineArrangementFlags arrangementFlags() const
Returns the layer&#39;s arrangement flags.
Definition: layer.h:110
QgsPalLayerSettings::Placement mArrangement
Optional flags used for some placement methods.
Definition: layer.h:264
LabelMode labelMode() const
Returns the layer&#39;s labeling mode.
Definition: layer.h:183
bool isCurved() const
Returns true if the layer has curved labels.
Definition: layer.h:99
UpsideDownLabels mUpsidedownLabels
Definition: layer.h:269
void setMergeConnectedLines(bool merge)
Sets whether connected lines should be merged before labeling.
Definition: layer.h:189
ObstacleType
Valid obstacle types, which affect how features within the layer will act as obstacles for labels...