qgslabelsearchtree.h

Go to the documentation of this file.

/***************************************************************************
                          qgslabelsearchtree.h
            Node for raster calculator tree
                          --------------------
    begin                : 2010-11-02
    copyright            : (C) 2010 by Marco Hugentobler
    email                : marco dot hugentobler at sourcepole dot ch
***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSLABELSEARCHTREE_H
#define QGSLABELSEARCHTREE_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgscalloutposition.h"
#include "qgsgenericspatialindex.h"
#include "qgslabelposition.h"
#include "qgsmapsettings.h"
 
#include <QList>
#include <QVector>
 
class QgsPointXY;
 
#ifndef SIP_RUN
namespace pal
{
  class LabelPosition;
}
#endif
 
// TODO QGIS 5.0 - this should be private, not exposed to SIP

class CORE_EXPORT QgsLabelSearchTree
{
  public:
    QgsLabelSearchTree();
    ~QgsLabelSearchTree();
 
    QgsLabelSearchTree( const QgsLabelSearchTree &rh ) = delete;
    QgsLabelSearchTree &operator=( const QgsLabelSearchTree &rh ) = delete;

    Q_DECL_DEPRECATED void clear() SIP_DEPRECATED;
 
    //TODO: why does this break bindings with QList<QgsLabelPosition>?

    void label( const QgsPointXY &p, QList<QgsLabelPosition *> &posList ) const SIP_SKIP;
 
    //TODO: why does this break bindings with QList<QgsLabelPosition>?

    QList< QgsLabelPosition > allLabels() const;

    void labelsInRect( const QgsRectangle &r, QList<QgsLabelPosition *> &posList ) const SIP_SKIP;

    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,
      long long linkedId = 0
    ) SIP_SKIP;

    bool insertCallout( const QgsCalloutPosition &position ) SIP_SKIP;

    QList<const QgsCalloutPosition *> calloutsInRectangle( const QgsRectangle &rectangle ) const;

    QList<QgsLabelPosition *> groupedLabelPositions( long long groupId ) const SIP_SKIP;

    void setMapSettings( const QgsMapSettings &settings );
 
  private:
    QgsGenericSpatialIndex< QgsLabelPosition > mSpatialIndex;
    long long mNextFeatureId = 1;
    QHash< long long, QList< QgsLabelPosition * > > mLinkedLabelHash;
    std::vector< std::unique_ptr< QgsLabelPosition > > mOwnedPositions;
    QgsGenericSpatialIndex< QgsCalloutPosition > mCalloutIndex;
    std::vector< std::unique_ptr< QgsCalloutPosition > > mOwnedCalloutPositions;
    QgsMapSettings mMapSettings;
    QTransform mTransform;
 
#ifdef SIP_RUN
    QgsLabelSearchTree( const QgsLabelSearchTree &rh );
    QgsLabelSearchTree &operator=( const QgsLabelSearchTree & );
#endif
};
 
#endif // QGSLABELTREE_H