Pal main class. More...

#include <pal.h>

Public Member Functions
	Pal ()
	Create an new pal instance. More...

	~Pal ()
	delete an instance More...

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)
	add a new layer More...

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

int	getDpi ()
	get map resolution More...

Layer *	getLayer (const char *lyrName)
	Look for a layer. More...

QList< Layer * > *	getLayers ()
	get all layers More...

int	getLineP ()
	get maximum # candidates to generate for line features More...

Units	getMapUnit ()
	get current map unit More...

int	getPointP ()
	get # candidates to generate for point features More...

int	getPolyP ()
	get maximum # candidates to generate for polygon features More...

SearchMethod	getSearch ()
	get the search method in use More...

bool	getShowPartial ()
	Get flag show partial label. More...

bool	isCancelled ()
	Check whether the job has been cancelled. More...

std::list< LabelPosition * > *	labeller (double scale, double bbox[4], PalStat **stats, bool displayAll)
	the labeling machine Will extract all active layers More...

std::list< LabelPosition * > *	labeller (int nbLayers, char *layersName, double layersFactor, double scale, double bbox[4], PalStat **stat, bool displayAll)
	the labeling machine Active layers are specifiend through layersName array More...

void	registerCancellationCallback (FnIsCancelled fnCancelled, void *context)
	Register a function that returns whether this job has been cancelled - PAL calls it during the computation. More...

void	removeLayer (Layer *layer)
	remove a layer More...

void	setDpi (int dpi)
	Set map resolution. More...

void	setLineP (int line_p)
	set maximum # candidates to generate for lines features Higher the value is, longer Pal::labeller will spend time More...

void	setMapUnit (Units map_unit)
	set map unit More...

void	setPointP (int point_p)
	set # candidates to generate for points features Higher the value is, longer Pal::labeller will spend time More...

void	setPolyP (int poly_p)
	set maximum # candidates to generate for polygon features Higher the value is, longer Pal::labeller will spend time More...

void	setSearch (SearchMethod method)
	Select the search method to use. More...

void	setShowPartial (bool show)
	Set flag show partial label. More...

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

Friends
class	FeaturePart

class	Layer

class	Problem

Detailed Description

Pal main class.

A pal object will contains layers and global information such as which search method will be used, the map resolution (dpi) ....

Author: Maxence Laurent (maxence dot laurent at heig-vd dot ch)

Definition at line 126 of file pal.h.

Constructor & Destructor Documentation

pal::Pal::Pal ( )

Create an new pal instance.

Definition at line 92 of file pal.cpp.

pal::Pal::~Pal ( )

delete an instance

Definition at line 164 of file pal.cpp.

Member Function Documentation

Layer * pal::Pal::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`
	)

add a new layer

Parameters

lyrName	layer's name
min_scale	bellow this scale: no labelling (-1 to disable)
max_scale	above this scale: no labelling (-1 to disable)
arrangement	Howto place candidates
label_unit	Unit for labels sizes
defaultPriority	layer's prioriry (0 is the best, 1 the worst)
obstacle	'true' will discourage other label to be placed above features of this layer
active	is the layer is active (currently displayed)
toLabel	the layer will be labeled only if toLablel is true
displayAll	if true, all features will be labelled even though overlaps occur

Exceptions

PalException::LayerExists

Todo:: add symbolUnit

Definition at line 182 of file pal.cpp.

Problem * pal::Pal::extractProblem	(	double	scale,
		double	bbox[4]
	)

Definition at line 840 of file pal.cpp.

int pal::Pal::getDpi ( )

get map resolution

Returns: map resolution (dot per inch)

Definition at line 974 of file pal.cpp.

Layer * pal::Pal::getLayer ( const char * lyrName )

Look for a layer.

Parameters

lyrName name of layer to search

Exceptions

PalException::UnkownLayer

Returns: a pointer on layer or NULL if layer not exist

Definition at line 137 of file pal.cpp.

QList< Layer * > * pal::Pal::getLayers ( )

get all layers

Returns: a list of all layers

Definition at line 131 of file pal.cpp.

int pal::Pal::getLineP ( )

get maximum # candidates to generate for line features

Definition at line 954 of file pal.cpp.

Units pal::Pal::getMapUnit ( )

get current map unit

Definition at line 1036 of file pal.cpp.

int pal::Pal::getPointP ( )

get # candidates to generate for point features

Definition at line 949 of file pal.cpp.

int pal::Pal::getPolyP ( )

get maximum # candidates to generate for polygon features

Definition at line 959 of file pal.cpp.

SearchMethod pal::Pal::getSearch ( )

get the search method in use

Returns: the search method

Definition at line 984 of file pal.cpp.

bool pal::Pal::getShowPartial ( )

Get flag show partial label.

Returns: value of flag

Definition at line 979 of file pal.cpp.

bool pal::Pal::isCancelled ( )

inline

Check whether the job has been cancelled.

Definition at line 352 of file pal.h.

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

the labeling machine Will extract all active layers

Parameters

scale	map scale is 1:scale
bbox	map extent
stats	A PalStat object (can be NULL)
displayAll	if true, all feature will be labelled even though overlaps occur

Returns: A list of label to display on map

Definition at line 664 of file pal.cpp.

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

the labeling machine Active layers are specifiend through layersName array

Todo:: add obstacles and tolabel arrays

Parameters

nbLayers	# layers
layersName	names of layers to label
layersFactor	layers priorities array
scale	map scale is '1:scale'
bbox	map extent
stat	will be filled with labelling process statistics, can be NULL
displayAll	if true, all feature will be labelled even though overlaps occur

Todo:: UnknownLayer will be ignored ? should throw exception or not ???

Returns: A list of label to display on map

Definition at line 699 of file pal.cpp.

void pal::Pal::registerCancellationCallback	(	Pal::FnIsCancelled	fnCancelled,
		void *	context
	)

Register a function that returns whether this job has been cancelled - PAL calls it during the computation.

Definition at line 834 of file pal.cpp.

void pal::Pal::removeLayer ( Layer * layer )

remove a layer

Parameters

layer layer to remove

Definition at line 152 of file pal.cpp.

void pal::Pal::setDpi ( int dpi )

Set map resolution.

Parameters

dpi	map resolution (dot per inch)

Definition at line 938 of file pal.cpp.

void pal::Pal::setLineP ( int line_p )

set maximum # candidates to generate for lines features Higher the value is, longer Pal::labeller will spend time

Parameters

line_p maximum # candidates for a line

Definition at line 891 of file pal.cpp.

void pal::Pal::setMapUnit ( Units map_unit )

set map unit

Definition at line 1044 of file pal.cpp.

void pal::Pal::setPointP ( int point_p )

set # candidates to generate for points features Higher the value is, longer Pal::labeller will spend time

Parameters

point_p # candidates for a point

Definition at line 885 of file pal.cpp.

void pal::Pal::setPolyP ( int poly_p )

set maximum # candidates to generate for polygon features Higher the value is, longer Pal::labeller will spend time

Parameters

poly_p maximum # candidate for a polygon

Definition at line 897 of file pal.cpp.

void pal::Pal::setSearch ( SearchMethod method )

Select the search method to use.

For interactive mapping using CHAIN is a good idea because it is the fastest. Other methods, ordered by speedness, are POPMUSIC_TABU, POPMUSIC_CHAIN and POPMUSIC_TABU_CHAIN, defined in pal::_searchMethod enumeration

Parameters

method the method to use

Definition at line 989 of file pal.cpp.

void pal::Pal::setShowPartial ( bool show )

Set flag show partial label.

Parameters

show	flag value

Definition at line 944 of file pal.cpp.

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

Definition at line 867 of file pal.cpp.

Friends And Related Function Documentation

friend class FeaturePart

friend

Definition at line 129 of file pal.h.

friend class Layer

friend

Definition at line 130 of file pal.h.

friend class Problem

friend

Definition at line 128 of file pal.h.

The documentation for this class was generated from the following files:

/tmp/buildd/qgis-2.10.1+git20150822+dd4475c+20trusty/src/core/pal/pal.h
/tmp/buildd/qgis-2.10.1+git20150822+dd4475c+20trusty/src/core/pal/pal.cpp

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation