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/>.
 *
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#ifndef _PAL_H
#define _PAL_H


#include <QList>
#include <iostream>
#include <ctime>
#include <geos_c.h>

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

namespace pal
{
  GEOSContextHandle_t geosContext();

  template <class Type> class LinkedList;

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

  enum _Units
  {
    PIXEL = 0, 
    METER, 
    FOOT, 
    DEGREE 
  };

  typedef enum _Units Units;

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

  typedef enum _searchMethod SearchMethod;

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

  typedef enum _arrangement Arrangement;

  enum LineArrangementFlags
  {
    FLAG_ON_LINE     = 1,
    FLAG_ABOVE_LINE  = 2,
    FLAG_BELOW_LINE  = 4,
    FLAG_MAP_ORIENTATION = 8
  };

  class CORE_EXPORT Pal
  {
      friend class Problem;
      friend class FeaturePart;
      friend class Layer;
    private:
      QList<Layer*> *layers;

      SimpleMutex *lyrsMutex;

      // TODO remove after tests !!!
      clock_t tmpTime;

      Units map_unit;

      int point_p;

      int line_p;

      int poly_p;

      SearchMethod searchMethod;

      /*
       * POPMUSIC Tuning
       */
      int popmusic_r;

      int tabuMaxIt;
      int tabuMinIt;

      int dpi;

      int ejChainDeg;
      int tenure;
      double candListSize;

      bool showPartial;


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

      Problem* extract( int nbLayers, char **layersName, double *layersFactor,
                        double lambda_min, double phi_min,
                        double lambda_max, double phi_max,
                        double scale, std::ofstream *svgmap );


      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();


    public:

      Pal();

      ~Pal();

      Layer * addLayer( const char *lyrName, double min_scale, double max_scale, Arrangement arrangement, Units label_unit, double defaultPriority, bool obstacle, bool active, bool toLabel, bool displayAll = false );

      Layer *getLayer( const char *lyrName );

      QList<Layer*> *getLayers();

      void removeLayer( Layer *layer );

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


      std::list<LabelPosition*> *labeller( int nbLayers,
                                           char **layersName,
                                           double *layersFactor,
                                           double scale, double bbox[4],
                                           PalStat **stat,
                                           bool displayAll );

      void registerCancellationCallback( FnIsCancelled fnCancelled, void* context );

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

      Problem* extractProblem( double scale, double bbox[4] );

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

      void setDpi( int dpi );

      int getDpi();

      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();

      Units getMapUnit();

      void setMapUnit( Units map_unit );

      void setSearch( SearchMethod method );

      SearchMethod getSearch();
  };
} // end namespace pal
#endif