QGIS API Documentation  2.15.0-Master (972fc9f)
feature.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 FEATURE_H
31 #define FEATURE_H
32 
33 #include "qgsgeometry.h"
34 #include "pointset.h"
35 #include "util.h"
36 #include "labelposition.h"
37 #include <iostream>
38 #include <fstream>
39 #include <cmath>
40 #include <QString>
41 
42 #include "qgslabelfeature.h"
43 
49 namespace pal
50 {
52  class CORE_EXPORT LabelInfo
53  {
54  public:
55  typedef struct
56  {
57  double width;
58  } CharacterInfo;
59 
60  LabelInfo( int num, double height, double maxinangle = 20.0, double maxoutangle = -20.0 )
61  {
62  max_char_angle_inside = maxinangle;
63  // outside angle should be negative
64  max_char_angle_outside = maxoutangle > 0 ? -maxoutangle : maxoutangle;
65  label_height = height;
66  char_num = num;
67  char_info = new CharacterInfo[num];
68  }
69  ~LabelInfo() { delete [] char_info; }
70 
73  double label_height;
74  int char_num;
76  private:
77 
78  LabelInfo( const LabelInfo& rh );
79  LabelInfo& operator=( const LabelInfo& rh );
80  };
81 
82  class LabelPosition;
83  class FeaturePart;
84 
90  class CORE_EXPORT FeaturePart : public PointSet
91  {
92 
93  public:
94 
99  FeaturePart( QgsLabelFeature* lf, const GEOSGeometry* geom );
100 
101  FeaturePart( const FeaturePart& other );
102 
105  virtual ~FeaturePart();
106 
109  QgsLabelFeature* feature() { return mLF; }
110 
113  Layer* layer();
114 
117  QgsFeatureId featureId() const;
118 
127  int createCandidates( QList<LabelPosition *> &lPos, double bboxMin[2], double bboxMax[2], PointSet *mapShape, RTree<LabelPosition*, double, 2, double>* candidates );
128 
137  int createCandidatesAroundPoint( double x, double y, QList<LabelPosition *> &lPos, double angle, PointSet *mapShape = nullptr );
138 
147  int createCandidatesOverPoint( double x, double y, QList<LabelPosition *> &lPos, double angle, PointSet *mapShape = nullptr );
148 
156  int createCandidatesAtOrderedPositionsOverPoint( double x, double y, QList<LabelPosition *> &lPos, double angle );
157 
163  int createCandidatesAlongLine( QList<LabelPosition *> &lPos, PointSet *mapShape );
164 
165  LabelPosition* curvedPlacementAtOffset( PointSet* path_positions, double* path_distances,
166  int orientation, int index, double distance );
167 
173  int createCurvedCandidatesAlongLine( QList<LabelPosition *> &lPos, PointSet* mapShape );
174 
180  int createCandidatesForPolygon( QList<LabelPosition *> &lPos, PointSet *mapShape );
181 
187  bool hasSameLabelFeatureAs( FeaturePart* part ) const;
188 
189 #if 0
190 
194  void print();
195 #endif
196 
197  double getLabelWidth() const { return mLF->size().width(); }
198  double getLabelHeight() const { return mLF->size().height(); }
199  double getLabelDistance() const { return mLF->distLabel(); }
200 
201  bool getFixedRotation() { return mLF->hasFixedAngle(); }
202  double getLabelAngle() { return mLF->fixedAngle(); }
203  bool getFixedPosition() { return mLF->hasFixedPosition(); }
204  bool getAlwaysShow() { return mLF->alwaysShow(); }
205  bool isObstacle() { return mLF->isObstacle(); }
206  double obstacleFactor() { return mLF->obstacleFactor(); }
207  double repeatDistance() { return mLF->repeatDistance(); }
208 
210  int getNumSelfObstacles() const { return mHoles.count(); }
212  FeaturePart* getSelfObstacle( int i ) { return mHoles.at( i ); }
213 
215  bool isConnected( FeaturePart* p2 );
216 
219  bool mergeWithFeaturePart( FeaturePart* other );
220 
221  void addSizePenalty( int nbp, QList<LabelPosition *> &lPos, double bbx[4], double bby[4] );
222 
228  double calculatePriority() const;
229 
230 
231  protected:
232 
235 
237  void extractCoords( const GEOSGeometry* geom );
238 
239  private:
240 
241  LabelPosition::Quadrant quadrantFromOffset() const;
242  };
243 
244 } // end namespace pal
245 
246 #endif
bool getAlwaysShow()
Definition: feature.h:204
static unsigned index
bool getFixedRotation()
Definition: feature.h:201
QList< FeaturePart * > mHoles
Definition: feature.h:234
double max_char_angle_outside
Definition: feature.h:72
QgsLabelFeature * feature()
Returns the parent feature.
Definition: feature.h:109
double getLabelHeight() const
Definition: feature.h:198
int getNumSelfObstacles() const
Get number of holes (inner rings) - they are considered as obstacles.
Definition: feature.h:210
A set of features which influence the labelling process.
Definition: layer.h:55
double getLabelWidth() const
Definition: feature.h:197
LabelInfo(int num, double height, double maxinangle=20.0, double maxoutangle=-20.0)
Definition: feature.h:60
double repeatDistance()
Definition: feature.h:207
CharacterInfo * char_info
Definition: feature.h:75
double getLabelDistance() const
Definition: feature.h:199
bool getFixedPosition()
Definition: feature.h:203
Optional additional info about label (for curved labels)
Definition: feature.h:52
double label_height
Definition: feature.h:73
Main class to handle feature.
Definition: feature.h:90
double getLabelAngle()
Definition: feature.h:202
double ANALYSIS_EXPORT angle(Point3D *p1, Point3D *p2, Point3D *p3, Point3D *p4)
Calculates the angle between two segments (in 2 dimension, z-values are ignored)
The QgsLabelFeature class describes a feature that should be used within the labeling engine...
double max_char_angle_inside
Definition: feature.h:71
double obstacleFactor()
Definition: feature.h:206
FeaturePart * getSelfObstacle(int i)
Get hole (inner ring) - considered as obstacle.
Definition: feature.h:212
LabelPosition is a candidate feature label position.
Definition: labelposition.h:50
QgsLabelFeature * mLF
Definition: feature.h:233
qint64 QgsFeatureId
Definition: qgsfeature.h:31
Quadrant
Position of label candidate relative to feature.
Definition: labelposition.h:60
bool isObstacle()
Definition: feature.h:205
int char_num
Definition: feature.h:74