QGIS API Documentation  3.23.0-Master (b5237dafc3)
qgslabelsearchtree.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgslabelsearchtree.cpp
3  ---------------------
4  begin : November 2010
5  copyright : (C) 2010 by Marco Hugentobler
6  email : marco dot hugentobler at sourcepole dot ch
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 #include "qgslabelsearchtree.h"
16 #include "labelposition.h"
17 
19 
21 
22 void QgsLabelSearchTree::label( const QgsPointXY &point, QList<QgsLabelPosition *> &posList ) const
23 {
24  const QgsPointXY p( point );
25 
26  QList<QgsLabelPosition *> searchResults;
27  mSpatialIndex.intersects( QgsRectangle( p.x() - 0.1, p.y() - 0.1, p.x() + 0.1, p.y() + 0.1 ), [&searchResults]( const QgsLabelPosition * pos ) -> bool
28  {
29  searchResults.push_back( const_cast< QgsLabelPosition * >( pos ) );
30  return true;
31  } );
32 
33  //tolerance +-0.1 could be high in case of degree crs, so check if p is really contained in the results
34  posList.clear();
35  QList<QgsLabelPosition *>::const_iterator resultIt = searchResults.constBegin();
36  for ( ; resultIt != searchResults.constEnd(); ++resultIt )
37  {
38  if ( ( *resultIt )->labelGeometry.contains( &p ) )
39  {
40  posList.push_back( *resultIt );
41  }
42  }
43 }
44 
45 QList<QgsLabelPosition> QgsLabelSearchTree::allLabels() const
46 {
47  QList<QgsLabelPosition> res;
48  res.reserve( mOwnedPositions.size() );
49  for ( const std::unique_ptr< QgsLabelPosition > &pos : mOwnedPositions )
50  {
51  res.append( * pos );
52  }
53  return res;
54 }
55 
56 void QgsLabelSearchTree::labelsInRect( const QgsRectangle &r, QList<QgsLabelPosition *> &posList ) const
57 {
58  QList<QgsLabelPosition *> searchResults;
59  mSpatialIndex.intersects( r, [&searchResults]( const QgsLabelPosition * pos )->bool
60  {
61  searchResults.push_back( const_cast< QgsLabelPosition * >( pos ) );
62  return true;
63  } );
64 
65  posList.clear();
66  QList<QgsLabelPosition *>::const_iterator resultIt = searchResults.constBegin();
67  for ( ; resultIt != searchResults.constEnd(); ++resultIt )
68  {
69  if ( ( *resultIt )->labelGeometry.intersects( r ) )
70  {
71  posList.push_back( *resultIt );
72  }
73  }
74 }
75 
76 bool QgsLabelSearchTree::insertLabel( pal::LabelPosition *labelPos, QgsFeatureId featureId, const QString &layerName, const QString &labeltext, const QFont &labelfont, bool diagram, bool pinned, const QString &providerId, bool isUnplaced )
77 {
78  if ( !labelPos )
79  {
80  return false;
81  }
82 
83  QVector<QgsPointXY> cornerPoints;
84  cornerPoints.reserve( 4 );
85  double xMin = std::numeric_limits< double >::max();
86  double yMin = std::numeric_limits< double >::max();
87  double xMax = std::numeric_limits< double >::lowest();
88  double yMax = std::numeric_limits< double >::lowest();
89  for ( int i = 0; i < 4; ++i )
90  {
91  // we have to transform the bounding box to convert pre-rotated label positions back to real world locations
92  const QPointF res = mTransform.map( QPointF( labelPos->getX( i ), labelPos->getY( i ) ) );
93  cornerPoints.push_back( QgsPointXY( res ) );
94  xMin = std::min( xMin, res.x() );
95  xMax = std::max( xMax, res.x() );
96  yMin = std::min( yMin, res.y() );
97  yMax = std::max( yMax, res.y() );
98  }
99 
100  const QgsRectangle bounds( xMin, yMin, xMax, yMax );
101  const QgsGeometry labelGeometry( QgsGeometry::fromPolygonXY( QVector<QgsPolylineXY>() << cornerPoints ) );
102  std::unique_ptr< QgsLabelPosition > newEntry = std::make_unique< QgsLabelPosition >( featureId, labelPos->getAlpha() + mMapSettings.rotation(), cornerPoints, bounds,
103  labelPos->getWidth(), labelPos->getHeight(), layerName, labeltext, labelfont, labelPos->getUpsideDown(), diagram, pinned, providerId, labelGeometry, isUnplaced );
104  mSpatialIndex.insert( newEntry.get(), bounds );
105  mOwnedPositions.emplace_back( std::move( newEntry ) );
106 
107  if ( pal::LabelPosition *next = labelPos->nextPart() )
108  {
109  return insertLabel( next, featureId, layerName, labeltext, labelfont, diagram, pinned, providerId, isUnplaced );
110  }
111  return true;
112 }
113 
115 {
116  const QPointF origin = position.origin();
117  const QPointF destination = position.destination();
118 
119  std::unique_ptr< QgsCalloutPosition > newEntry = std::make_unique< QgsCalloutPosition >( position );
120 
121  mCalloutIndex.insert( newEntry.get(), QgsRectangle( origin.x(), origin.y(), origin.x(), origin.y() ) );
122  mCalloutIndex.insert( newEntry.get(), QgsRectangle( destination.x(), destination.y(), destination.x(), destination.y() ) );
123 
124  mOwnedCalloutPositions.emplace_back( std::move( newEntry ) );
125 
126  return true;
127 }
128 
129 QList<const QgsCalloutPosition *> QgsLabelSearchTree::calloutsInRectangle( const QgsRectangle &rectangle ) const
130 {
131  QList<const QgsCalloutPosition *> searchResults;
132  mCalloutIndex.intersects( rectangle, [&searchResults]( const QgsCalloutPosition * pos )->bool
133  {
134  searchResults.push_back( pos );
135  return true;
136  } );
137 
138  std::sort( searchResults.begin(), searchResults.end() );
139  searchResults.erase( std::unique( searchResults.begin(), searchResults.end() ), searchResults.end() );
140 
141  return searchResults;
142 }
143 
145 {
146  mMapSettings = settings;
147 
148  if ( !qgsDoubleNear( mMapSettings.rotation(), 0.0 ) )
149  {
150  // build a transform to convert points from real world to pre-rotated label positions
151  const QgsPointXY center = mMapSettings.visibleExtent().center();
152  mTransform = QTransform::fromTranslate( center.x(), center.y() );
153  mTransform.rotate( mMapSettings.rotation() );
154  mTransform.translate( -center.x(), -center.y() );
155  }
156  else
157  {
158  mTransform = QTransform();
159  }
160 }
161 
162 
164 {
165 
166 }
Represents the calculated placement of a map label callout line.
QPointF origin() const
Returns the origin of the callout line, in map coordinates.
QPointF destination() const
Returns the destination of the callout line, in map coordinates.
bool intersects(const QgsRectangle &bounds, const std::function< bool(T *data)> &callback) const
Performs an intersection check against the index, for data intersecting the specified bounds.
bool insert(T *data, const QgsRectangle &bounds)
Inserts new data into the spatial index, with the specified bounds.
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:125
static QgsGeometry fromPolygonXY(const QgsPolygonXY &polygon)
Creates a new geometry from a QgsPolygonXY.
Represents the calculated placement of a map label.
Q_DECL_DEPRECATED void clear()
Removes and deletes all the entries.
QgsLabelSearchTree()
Constructor for QgsLabelSearchTree.
void label(const QgsPointXY &p, QList< QgsLabelPosition * > &posList) const
Returns label position(s) at a given point.
void labelsInRect(const QgsRectangle &r, QList< QgsLabelPosition * > &posList) const
Returns label position(s) in given rectangle.
QList< const QgsCalloutPosition * > calloutsInRectangle(const QgsRectangle &rectangle) const
Returns the list of callouts with origins or destinations inside the given rectangle.
bool insertCallout(const QgsCalloutPosition &position)
Inserts a rendered callout position.
bool insertLabel(pal::LabelPosition *labelPos, QgsFeatureId featureId, const QString &layerName, const QString &labeltext, const QFont &labelfont, bool diagram=false, bool pinned=false, const QString &providerId=QString(), bool isUnplaced=false)
Inserts label position.
void setMapSettings(const QgsMapSettings &settings)
Sets the map settings associated with the labeling run.
QList< QgsLabelPosition > allLabels() const
Returns a list of all labels generated by the labeling run.
The QgsMapSettings class contains configuration for rendering of the map.
QgsRectangle visibleExtent() const
Returns the actual extent derived from requested extent that takes output image size into account.
double rotation() const
Returns the rotation of the resulting map image, in degrees clockwise.
A class to represent a 2D point.
Definition: qgspointxy.h:59
double y
Definition: qgspointxy.h:63
Q_GADGET double x
Definition: qgspointxy.h:62
A rectangle specified with double values.
Definition: qgsrectangle.h:42
QgsPointXY center() const SIP_HOLDGIL
Returns the center point of the rectangle.
Definition: qgsrectangle.h:251
LabelPosition is a candidate feature label position.
Definition: labelposition.h:56
double getAlpha() const
Returns the angle to rotate text (in rad).
double getHeight() const
double getWidth() const
LabelPosition * nextPart() const
Returns the next part of this label position (i.e.
double getX(int i=0) const
Returns the down-left x coordinate.
double getY(int i=0) const
Returns the down-left y coordinate.
bool getUpsideDown() const
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
Definition: qgis.h:1533
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
Definition: qgsfeatureid.h:28