qgslabelfeature.h

Go to the documentation of this file.

#ifndef QGSLABELFEATURE_H
#define QGSLABELFEATURE_H

#include "qgsgeometry.h"

#include "qgspallabeling.h"

namespace pal
{
  class LabelInfo;
}

class QgsAbstractLabelProvider;
class QgsRenderContext;
class QgsGeometry;


class CORE_EXPORT QgsLabelFeature
{
  public:

    struct VisualMargin
    {
      VisualMargin()
          : left( 0.0 )
          , right( 0.0 )
          , top( 0.0 )
          , bottom( 0.0 )
      {}

      VisualMargin( double top, double right, double bottom, double left )
          : left( left )
          , right( right )
          , top( top )
          , bottom( bottom )
      {}

      double left;
      double right;
      double top;
      double bottom;

      VisualMargin& operator *=( double value )
      {
        left *= value;
        right *= value;
        top *= value;
        bottom *= value;
        return *this;
      }
    };

    QgsLabelFeature( QgsFeatureId id, GEOSGeometry* geometry, QSizeF size );
    virtual ~QgsLabelFeature();

    QgsFeatureId id() const { return mId; }

    GEOSGeometry* geometry() const { return mGeometry; }

    void setObstacleGeometry( GEOSGeometry* obstacleGeom );

    GEOSGeometry* obstacleGeometry() const { return mObstacleGeometry; }

    void setPermissibleZone( const QgsGeometry& geometry );

    QgsGeometry permissibleZone() const { return mPermissibleZone; }

    //TODO - remove when QgsGeometry caches GEOS preparedness
    const GEOSPreparedGeometry* permissibleZonePrepared() const { return mPermissibleZoneGeosPrepared; }

    QSizeF size() const { return mSize; }

    void setVisualMargin( const VisualMargin& margin ) { mVisualMargin = margin; }

    const VisualMargin& visualMargin() const { return mVisualMargin; }

    void setSymbolSize( QSizeF size ) { mSymbolSize = size; }

    const QSizeF& symbolSize() const { return mSymbolSize; }

    double priority() const { return mPriority; }
    void setPriority( double priority ) { mPriority = priority; }

    double zIndex() const { return mZIndex; }

    void setZIndex( double zIndex ) { mZIndex = zIndex; }

    bool hasFixedPosition() const { return mHasFixedPosition; }
    void setHasFixedPosition( bool enabled ) { mHasFixedPosition = enabled; }
    QgsPoint fixedPosition() const { return mFixedPosition; }
    void setFixedPosition( const QgsPoint& point ) { mFixedPosition = point; }

    bool hasFixedAngle() const { return mHasFixedAngle; }
    void setHasFixedAngle( bool enabled ) { mHasFixedAngle = enabled; }
    double fixedAngle() const { return mFixedAngle; }
    void setFixedAngle( double angle ) { mFixedAngle = angle; }

    bool hasFixedQuadrant() const { return mHasFixedQuadrant; }
    void setHasFixedQuadrant( bool enabled ) { mHasFixedQuadrant = enabled; }
    QPointF quadOffset() const { return mQuadOffset; }
    void setQuadOffset( QPointF quadOffset ) { mQuadOffset = quadOffset; }
    QgsPoint positionOffset() const { return mPositionOffset; }
    void setPositionOffset( const QgsPoint& offset ) { mPositionOffset = offset; }

    QgsPalLayerSettings::OffsetType offsetType() const { return mOffsetType; }

    void setOffsetType( QgsPalLayerSettings::OffsetType type ) { mOffsetType = type; }

    double distLabel() const { return mDistLabel; }
    void setDistLabel( double dist ) { mDistLabel = dist; }

    QVector< QgsPalLayerSettings::PredefinedPointPosition > predefinedPositionOrder() const { return mPredefinedPositionOrder; }

    void setPredefinedPositionOrder( const QVector< QgsPalLayerSettings::PredefinedPointPosition >& order ) { mPredefinedPositionOrder = order; }

    double repeatDistance() const { return mRepeatDistance; }
    void setRepeatDistance( double dist ) { mRepeatDistance = dist; }

    bool alwaysShow() const { return mAlwaysShow; }
    void setAlwaysShow( bool enabled ) { mAlwaysShow = enabled; }

    bool isObstacle() const { return mIsObstacle; }
    void setIsObstacle( bool enabled ) { mIsObstacle = enabled; }
    double obstacleFactor() const { return mObstacleFactor; }
    void setObstacleFactor( double factor ) { mObstacleFactor = factor; }

    QString labelText() const { return mLabelText; }
    void setLabelText( const QString& text ) { mLabelText = text; }

    pal::LabelInfo* curvedLabelInfo() const { return mInfo; }
    void setCurvedLabelInfo( pal::LabelInfo* info ) { mInfo = info; }

    pal::Layer* layer() const { return mLayer; }
    void setLayer( pal::Layer* layer ) { mLayer = layer; }

    QgsAbstractLabelProvider* provider() const;

  protected:
    pal::Layer* mLayer;

    QgsFeatureId mId;
    GEOSGeometry* mGeometry;
    GEOSGeometry* mObstacleGeometry;
    QgsGeometry mPermissibleZone;
    QSizeF mSize;
    VisualMargin mVisualMargin;
    QSizeF mSymbolSize;
    double mPriority;
    double mZIndex;
    bool mHasFixedPosition;
    QgsPoint mFixedPosition;
    bool mHasFixedAngle;
    double mFixedAngle;
    bool mHasFixedQuadrant;
    QPointF mQuadOffset;
    QgsPoint mPositionOffset;
    double mDistLabel;
    QgsPalLayerSettings::OffsetType mOffsetType;
    QVector< QgsPalLayerSettings::PredefinedPointPosition > mPredefinedPositionOrder;
    double mRepeatDistance;
    bool mAlwaysShow;
    bool mIsObstacle;
    double mObstacleFactor;
    QString mLabelText;
    pal::LabelInfo* mInfo;

  private:

    // TODO - not required when QgsGeometry caches geos preparedness
    const GEOSPreparedGeometry* mPermissibleZoneGeosPrepared;

};

#endif // QGSLABELFEATURE_H