qgslabelposition.h

Go to the documentation of this file.

/***************************************************************************
  qgslabelposition.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 QGSLABELPOSITION_H
#define QGSLABELPOSITION_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsgeometry.h"
#include "qgspointxy.h"
#include "qgsrectangle.h"
 
#include <QFont>
#include <QString>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsLabelPosition
{
  public:
    QgsLabelPosition(
      QgsFeatureId id,
      double r,
      const QVector< QgsPointXY > &corners,
      const QgsRectangle &rect,
      double w,
      double h,
      const QString &layer,
      const QString &labeltext,
      const QFont &labelfont,
      bool upside_down,
      bool diagram = false,
      bool pinned = false,
      const QString &providerId = QString(),
      const QgsGeometry &labelGeometry = QgsGeometry(),
      bool isUnplaced = false
    )
      : featureId( id )
      , rotation( r )
      , cornerPoints( corners )
      , labelRect( rect )
      , labelGeometry( labelGeometry )
      , width( w )
      , height( h )
      , layerID( layer )
      , labelText( labeltext )
      , labelFont( labelfont )
      , upsideDown( upside_down )
      , isDiagram( diagram )
      , isPinned( pinned )
      , providerID( providerId )
      , isUnplaced( isUnplaced )
    {}
 
    QgsLabelPosition() = default;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    const QString text = sipCpp->labelText;
    QString str = u"<QgsLabelPosition: \"%1\"%2>"_s.arg( text, sipCpp->isUnplaced ? u" (unplaced)"_s : QString() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif

        QgsFeatureId featureId
      = FID_NULL;

    double rotation = 0;
 
    QVector< QgsPointXY > cornerPoints;
    QgsRectangle labelRect;

    QgsGeometry labelGeometry;

    double width = 0;

    double height = 0;

    QString layerID;

    QString labelText;

    QFont labelFont;

    bool upsideDown = false;

    bool isDiagram = false;

    bool isPinned = false;

    QString providerID;

    bool isUnplaced = false;

    long long groupedLabelId = 0;

    long long groupedPositionIndex = 0;

    long long subPartId = 0;
};
 
#endif // QGSLABELPOSITION_H