pal.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 _PAL_H
#define _PAL_H

#include "qgsgeometry.h"
#include <QList>
#include <iostream>
#include <ctime>
#include <QMutex>
#include <QStringList>

// TODO ${MAJOR} ${MINOR} etc instead of 0.2

class QgsAbstractLabelProvider;

namespace pal
{
  GEOSContextHandle_t geosContext();

  class Layer;
  class LabelPosition;
  class PalStat;
  class Problem;
  class PointSet;

  enum SearchMethod
  {
    CHAIN = 0, 
    POPMUSIC_TABU_CHAIN = 1, 
    POPMUSIC_TABU = 2, 
    POPMUSIC_CHAIN = 3, 
    FALP = 4 
  };

  enum Arrangement
  {
    P_POINT = 0, 
    P_POINT_OVER, 
    P_LINE, 
    P_CURVED, 
    P_HORIZ, 
    P_FREE 
  };

  enum LineArrangementFlag
  {
    FLAG_ON_LINE     = 1,
    FLAG_ABOVE_LINE  = 2,
    FLAG_BELOW_LINE  = 4,
    FLAG_MAP_ORIENTATION = 8
  };
  Q_DECLARE_FLAGS( LineArrangementFlags, LineArrangementFlag )

  enum ObstacleType
  {
    PolygonInterior,
    PolygonBoundary
  };

  class CORE_EXPORT Pal
  {
      friend class Problem;
      friend class FeaturePart;
      friend class Layer;

    public:

      Pal();

      ~Pal();

      Layer* addLayer( QgsAbstractLabelProvider* provider, const QString& layerName, Arrangement arrangement, double defaultPriority, bool active, bool toLabel, bool displayAll = false );

      void removeLayer( Layer *layer );

      std::list<LabelPosition*> *labeller( double bbox[4], PalStat **stats, bool displayAll );

      typedef bool ( *FnIsCancelled )( void* ctx );

      void registerCancellationCallback( FnIsCancelled fnCancelled, void* context );

      inline bool isCancelled() { return fnIsCancelled ? fnIsCancelled( fnIsCancelledContext ) : false; }

      Problem* extractProblem( double bbox[4] );

      std::list<LabelPosition*>* solveProblem( Problem* prob, bool displayAll );

      void setShowPartial( bool show );

      bool getShowPartial();

      void setPointP( int point_p );

      void setLineP( int line_p );

      void setPolyP( int poly_p );

      int getPointP();

      int getLineP();

      int getPolyP();

      void setSearch( SearchMethod method );

      SearchMethod getSearch();

    private:

      QHash< QgsAbstractLabelProvider*, Layer* > mLayers;

      QMutex mMutex;

      int point_p;

      int line_p;

      int poly_p;

      SearchMethod searchMethod;

      /*
       * POPMUSIC Tuning
       */
      int popmusic_r;

      int tabuMaxIt;
      int tabuMinIt;

      int ejChainDeg;
      int tenure;
      double candListSize;

      bool showPartial;

      FnIsCancelled fnIsCancelled;
      void* fnIsCancelledContext;

      Problem* extract( double lambda_min, double phi_min,
                        double lambda_max, double phi_max );


      void setPopmusicR( int r );

      void setMinIt( int min_it );

      void setMaxIt( int max_it );

      void setTenure( int tenure );

      void setEjChainDeg( int degree );

      void setCandListSize( double fact );


      int getMinIt();
      int getMaxIt();
  };

} // end namespace pal

Q_DECLARE_OPERATORS_FOR_FLAGS( pal::LineArrangementFlags )

#endif