Pal main class. More...

#include <pal.h>

Public Member Functions
	Pal ()
	Create an new pal instance.
	~Pal ()
	delete an instance
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
Layer *	getLayer (const char *lyrName)
	Look for a layer.
QList< Layer * > *	getLayers ()
	get all layers
void	removeLayer (Layer *layer)
	remove a layer
std::list< LabelPosition * > *	labeller (double scale, double bbox[4], PalStat **stats, bool displayAll)
	the labeling machine Will extract all active layers
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
void	registerCancellationCallback (FnIsCancelled fnCancelled, void *context)
	Register a function that returns whether this job has been cancelled - PAL calls it during the computation.
bool	isCancelled ()
	Check whether the job has been cancelled.
Problem *	extractProblem (double scale, double bbox[4])
std::list< LabelPosition * > *	solveProblem (Problem *prob, bool displayAll)
void	setDpi (int dpi)
	Set map resolution.
int	getDpi ()
	get map resolution
void	setShowPartial (bool show)
	Set flag show partial label.
bool	getShowPartial ()
	Get flag show partial label.
void	setPointP (int point_p)
	set # candidates to generate for points features Higher the value is, longer Pal::labeller will spend time
void	setLineP (int line_p)
	set maximum # candidates to generate for lines features Higher the value is, longer Pal::labeller will spend time
void	setPolyP (int poly_p)
	set maximum # candidates to generate for polygon features Higher the value is, longer Pal::labeller will spend time
int	getPointP ()
	get # candidates to generate for point features
int	getLineP ()
	get maximum # candidates to generate for line features
int	getPolyP ()
	get maximum # candidates to generate for polygon features
Units	getMapUnit ()
	get current map unit
void	setMapUnit (Units map_unit)
	set map unit
void	setSearch (SearchMethod method)
	Select the search method to use.
SearchMethod	getSearch ()
	get the search method in use

Friends
class	Problem
class	FeaturePart
class	Layer

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)

Constructor & Destructor Documentation

pal::Pal::Pal ( )

Create an new pal instance.

pal::Pal::~Pal ( )

delete an instance

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

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

int pal::Pal::getDpi ( )

get map resolution

Returns: map resolution (dot per inch)

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

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

get all layers

Returns: a list of all layers

int pal::Pal::getLineP ( )

get maximum # candidates to generate for line features

Units pal::Pal::getMapUnit ( )

get current map unit

int pal::Pal::getPointP ( )

get # candidates to generate for point features

int pal::Pal::getPolyP ( )

get maximum # candidates to generate for polygon features

SearchMethod pal::Pal::getSearch ( )

get the search method in use

Returns: the search method

bool pal::Pal::getShowPartial ( )

Get flag show partial label.

Returns: value of flag

bool pal::Pal::isCancelled ( )

inline

Check whether the job has been cancelled.

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

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

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.

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

remove a layer

Parameters

layer layer to remove

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

Set map resolution.

Parameters

dpi	map resolution (dot per inch)

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

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

set map unit

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

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

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

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

Set flag show partial label.

Parameters

show	flag value

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

Friends And Related Function Documentation

friend class FeaturePart

friend

friend class Layer

friend

friend class Problem

friend

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

/tmp/buildd/qgis-2.6.0+wheezy1/src/core/pal/pal.h
/tmp/buildd/qgis-2.6.0+wheezy1/src/core/pal/pal.cpp

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation