qgslabelingresults.h

Go to the documentation of this file.

/***************************************************************************
  qgslabelingresults.h
  -------------------
   begin                : February 2021
   copyright            : (C) Nyall Dawson
   email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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 QGSLABELINGRESULTS_H
#define QGSLABELINGRESULTS_H
 
#include <memory>
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgscalloutposition.h"
#include "qgslabelposition.h"
#include "qgsmapsettings.h"
 
#include <QTransform>
 
class QgsMapSettings;
class QgsLabelSearchTree;
 
#ifndef SIP_RUN
namespace pal
{
  class LabelPosition;
}
#endif

class CORE_EXPORT QgsLabelingResults
{
  public:
    QgsLabelingResults( bool enableSearchTree = true );
    ~QgsLabelingResults();
 
    QgsLabelingResults( const QgsLabelingResults & ) = delete;
    QgsLabelingResults &operator=( const QgsLabelingResults &rh ) = delete;

    bool hasSearchTree() const;
 
#ifndef SIP_RUN
    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,
      long long linkedPositionIndex = 0,
      long long subPartId = 0
    );
#endif

    bool insertCallout( const QgsCalloutPosition &position ) SIP_SKIP;

    QList< QgsLabelPosition > allLabels() const;

    QList<QgsLabelPosition> labelsAtPosition( const QgsPointXY &p ) const;

    QList<QgsLabelPosition> labelsWithinRect( const QgsRectangle &r ) const;

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

    QList<QgsCalloutPosition> calloutsWithinRectangle( const QgsRectangle &rectangle ) const;

    void setMapSettings( const QgsMapSettings &settings );
 
  private:
#ifdef SIP_RUN
    QgsLabelingResults( const QgsLabelingResults & );
#endif
 
    std::unique_ptr< QgsLabelSearchTree > mLabelSearchTree;
    // used only when mLabelSearchTree is nullptr
    QList< QgsLabelPosition > mAllLabels;
 
    QgsMapSettings mMapSettings;
    QTransform mTransform;
    long long mNextFeatureId = 1;
    QHash< long long, QList< QgsLabelPosition * > > mLinkedLabelHash;
 
    std::vector< std::unique_ptr< QgsLabelPosition > > mOwnedPositions;
    std::vector< std::unique_ptr< QgsCalloutPosition > > mOwnedCalloutPositions;
};
 
#endif // QGSLABELINGRESULTS_H