qgslabelobstaclesettings.h

Go to the documentation of this file.

/***************************************************************************
  qgslabelobstaclesettings.h
  --------------------------
  Date                 : December 2019
  Copyright            : (C) 2019 by 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 QGSLABELOBSTACLESETTINGS_H
#define QGSLABELOBSTACLESETTINGS_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsgeometry.h"
 
class QgsPropertyCollection;
class QgsExpressionContext;

class CORE_EXPORT QgsLabelObstacleSettings
{
  public:
    enum class ObstacleType SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsLabelObstacleSettings, ObstacleType ) : int
    {
      PolygonInterior, 
      PolygonBoundary, 
      PolygonWhole 
    };

    bool isObstacle() const { return mIsObstacle; }

    void setIsObstacle( bool isObstacle ) { mIsObstacle = isObstacle; }

    double factor() const { return mObstacleFactor; }

    void setFactor( double factor ) { mObstacleFactor = factor; }

    ObstacleType type() const { return mObstacleType; }

    void setType( ObstacleType type ) { mObstacleType = type; }

    void setObstacleGeometry( const QgsGeometry &obstacleGeom );

    QgsGeometry obstacleGeometry() const;

    void updateDataDefinedProperties( const QgsPropertyCollection &properties, QgsExpressionContext &context );
 
  private:
    bool mIsObstacle = true;
    double mObstacleFactor = 1.0;
    ObstacleType mObstacleType = ObstacleType::PolygonBoundary;

    QgsGeometry mObstacleGeometry;
};
 
#endif // QGSLABELOBSTACLESETTINGS_H