feature.h

Go to the documentation of this file.

/*
 *   libpal - Automated Placement of Labels Library
 *
 *   Copyright (C) 2008 Maxence Laurent, MIS-TIC, HEIG-VD
 *                      University of Applied Sciences, Western Switzerland
 *                      http://www.hes-so.ch
 *
 *   Contact:
 *      maxence.laurent <at> heig-vd <dot> ch
 *    or
 *      eric.taillard <at> heig-vd <dot> ch
 *
 * This file is part of libpal.
 *
 * libpal 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 3 of the License, or
 * (at your option) any later version.
 *
 * libpal is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with libpal.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef FEATURE_H
#define FEATURE_H
 
 
#include <cmath>
#include <fstream>
#include <iostream>
 
#include "labelposition.h"
#include "pointset.h"
#include "qgis_core.h"
#include "qgslabelfeature.h"
#include "qgstextrendererutils.h"
 
#include <QString>
 
#define SIP_NO_FILE
 
namespace pal
{
  class LabelPosition;
  class FeaturePart;

  class CORE_EXPORT FeaturePart : public PointSet
  {
    public:
      enum PathOffset
      {
        NoOffset,
        PositiveOffset,
        NegativeOffset
      };

      FeaturePart( QgsLabelFeature *lf, const GEOSGeometry *geom );
 
      FeaturePart( const FeaturePart &other );

      ~FeaturePart() override;

      QgsLabelFeature *feature() { return mLF; }

      Layer *layer();

      QgsFeatureId featureId() const;

      int subPartId() const;

      std::size_t maximumPointCandidates() const;

      std::size_t maximumLineCandidates() const;

      std::size_t maximumPolygonCandidates() const;

      std::vector<std::unique_ptr<LabelPosition> > createCandidates( Pal *pal );

      std::size_t createCandidatesAroundPoint( double x, double y, std::vector<std::unique_ptr<LabelPosition> > &lPos, double angle );

      std::size_t createCandidatesOverPoint( double x, double y, std::vector<std::unique_ptr<LabelPosition> > &lPos, double angle );

      std::size_t createCandidateCenteredOverPoint( double x, double y, std::vector<std::unique_ptr<LabelPosition> > &lPos, double angle );

      std::unique_ptr< LabelPosition > createCandidatePointOnSurface( PointSet *mapShape );

      std::size_t createCandidatesAtOrderedPositionsOverPoint( double x, double y, std::vector<std::unique_ptr<LabelPosition> > &lPos, double angle );

      std::size_t createCandidatesAlongLine( std::vector<std::unique_ptr<LabelPosition> > &lPos, PointSet *mapShape, bool allowOverrun, Pal *pal );

      std::size_t createHorizontalCandidatesAlongLine( std::vector<std::unique_ptr<LabelPosition> > &lPos, PointSet *mapShape, Pal *pal, double angle );

      std::size_t createCandidatesAlongLineNearStraightSegments( std::vector<std::unique_ptr<LabelPosition> > &lPos, PointSet *mapShape, Pal *pal );

      std::size_t createCandidatesAlongLineNearMidpoint( std::vector<std::unique_ptr<LabelPosition> > &lPos, PointSet *mapShape, double initialCost = 0.0, Pal *pal = nullptr );

      std::unique_ptr< LabelPosition > curvedPlacementAtOffset(
        PointSet *mapShape,
        const std::vector<double> &pathDistances,
        QgsTextRendererUtils::LabelLineDirection direction,
        double distance,
        bool &labeledLineSegmentIsRightToLeft,
        bool applyAngleConstraints,
        Qgis::CurvedTextFlags flags,
        double additionalCharacterSpacing,
        double additionalWordSpacing
      );

      std::size_t createCurvedCandidatesAlongLine( std::vector<std::unique_ptr<LabelPosition> > &lPos, PointSet *mapShape, bool allowOverrun, Pal *pal );

      std::size_t createDefaultCurvedCandidatesAlongLine( std::vector<std::unique_ptr<LabelPosition> > &lPos, PointSet *mapShape, bool allowOverrun, Pal *pal );

      std::size_t createCurvedCandidateWithCharactersAtVertices( std::vector<std::unique_ptr<LabelPosition> > &lPos, PointSet *mapShape, Pal *pal );

      std::size_t createCandidatesForPolygon( std::vector<std::unique_ptr<LabelPosition> > &lPos, PointSet *mapShape, Pal *pal );

      std::size_t createCandidatesOutsidePolygon( std::vector<std::unique_ptr<LabelPosition> > &lPos, Pal *pal );

      bool hasSameLabelFeatureAs( FeaturePart *part ) const;

      double getLabelWidth( double angle = 0.0 ) const { return mLF->size( angle ).width(); }

      double getLabelHeight( double angle = 0.0 ) const { return mLF->size( angle ).height(); }

      double getLabelDistance() const { return mLF->distLabel(); }

      bool hasFixedRotation() const { return mLF->hasFixedAngle(); }

      double fixedAngle() const { return mLF->fixedAngle(); }

      bool hasFixedPosition() const { return mLF->hasFixedPosition(); }

      bool alwaysShow() const { return mLF->alwaysShow(); }

      const QgsLabelObstacleSettings &obstacleSettings() const { return mLF->obstacleSettings(); }

      double repeatDistance() const { return mLF->repeatDistance(); }

      int getNumSelfObstacles() const { return mHoles.count(); }
      FeaturePart *getSelfObstacle( int i ) { return mHoles.at( i ); }

      bool isConnected( FeaturePart *p2 );

      bool mergeWithFeaturePart( FeaturePart *other );

      void addSizePenalty( std::vector<std::unique_ptr<LabelPosition> > &lPos, double bbx[4], double bby[4] ) const;

      double calculatePriority() const;

      bool onlyShowUprightLabels() const;

      int totalRepeats() const;

      void setTotalRepeats( int repeats );
 
    protected:
      QgsLabelFeature *mLF = nullptr;
      QList<FeaturePart *> mHoles;

      void extractCoords( const GEOSGeometry *geom );
 
    private:
      Qgis::LabelQuadrantPosition quadrantFromOffset() const;
 
      int mTotalRepeats = 0;
 
      mutable std::size_t mCachedMaxLineCandidates = 0;
      mutable std::size_t mCachedMaxPolygonCandidates = 0;
 
      FeaturePart &operator=( const FeaturePart & ) = delete;
  };
 
} // end namespace pal
 
#endif