#include <qgspallabeling.h>

Inheritance diagram for QgsPalLabeling:

Collaboration diagram for QgsPalLabeling:

Public Types
enum	Search { Chain, Popmusic_Tabu, Popmusic_Chain, Popmusic_Tabu_Chain, Falp }
Public Member Functions
	QgsPalLabeling ()
	~QgsPalLabeling ()
QgsPalLayerSettings &	layer (const QString &layerName)
void	numCandidatePositions (int &candPoint, int &candLine, int &candPolygon)
void	setNumCandidatePositions (int candPoint, int candLine, int candPolygon)
void	setSearchMethod (Search s)
Search	searchMethod () const
bool	isShowingCandidates () const
void	setShowingCandidates (bool showing)
const QList< QgsLabelCandidate > &	candidates ()
bool	isShowingAllLabels () const
void	setShowingAllLabels (bool showing)
virtual void	init (QgsMapRenderer *mr)
	called when we're going to start with rendering
virtual bool	willUseLayer (QgsVectorLayer *layer)
	called to find out whether the layer is used for labeling
virtual int	prepareLayer (QgsVectorLayer *layer, QSet< int > &attrIndices, QgsRenderContext &ctx)
	hook called when drawing layer before issuing select()
virtual int	addDiagramLayer (QgsVectorLayer layer, QgsDiagramLayerSettings s)
	adds a diagram layer to the labeling engine
virtual void	registerFeature (QgsVectorLayer *layer, QgsFeature &feat, const QgsRenderContext &context=QgsRenderContext())
	hook called when drawing for every feature in a layer
virtual void	registerDiagramFeature (QgsVectorLayer *layer, QgsFeature &feat, const QgsRenderContext &context=QgsRenderContext())
	called for every diagram feature
virtual void	drawLabeling (QgsRenderContext &context)
	called when the map is drawn and labels should be placed
virtual void	exit ()
	called when we're done with rendering
virtual QList< QgsLabelPosition >	labelsAtPosition (const QgsPoint &p)
	return infos about labels at a given (map) position
virtual QgsLabelingEngineInterface *	clone ()
	called when passing engine among map renderers
void	drawLabelCandidateRect (pal::LabelPosition lp, QPainter painter, const QgsMapToPixel *xform)
void	drawLabel (pal::LabelPosition label, QPainter painter, const QFont &f, const QColor &c, const QgsMapToPixel *xform, double bufferSize=-1, const QColor &bufferColor=QColor(255, 255, 255), bool drawBuffer=false)
	drawLabel
Static Public Member Functions
static void	drawLabelBuffer (QPainter *p, QString text, const QFont &font, double size, QColor color)
Protected Member Functions
void	initPal ()
Protected Attributes
QHash< QgsVectorLayer *, QgsPalLayerSettings >	mActiveLayers
QHash< QgsVectorLayer *, QgsDiagramLayerSettings >	mActiveDiagramLayers
QgsPalLayerSettings	mInvalidLayerSettings
QgsMapRenderer *	mMapRenderer
int	mCandPoint
int	mCandLine
int	mCandPolygon
Search	mSearch
pal::Pal *	mPal
QList< QgsLabelCandidate >	mCandidates
bool	mShowingCandidates
bool	mShowingAllLabels
QgsLabelSearchTree *	mLabelSearchTree

Detailed Description

Definition at line 171 of file qgspallabeling.h.

Member Enumeration Documentation

enum QgsPalLabeling::Search

Enumerator:

Chain
Popmusic_Tabu
Popmusic_Chain
Popmusic_Tabu_Chain
Falp

Definition at line 182 of file qgspallabeling.h.

Constructor & Destructor Documentation

QgsPalLabeling::QgsPalLabeling ( )

Definition at line 636 of file qgspallabeling.cpp.

References Chain, Falp, mCandLine, mCandPoint, mCandPolygon, mLabelSearchTree, mSearch, mShowingAllLabels, mShowingCandidates, Popmusic_Chain, Popmusic_Tabu, and Popmusic_Tabu_Chain.

Referenced by clone().

QgsPalLabeling::~QgsPalLabeling ( )

Definition at line 662 of file qgspallabeling.cpp.

References exit(), and mLabelSearchTree.

Member Function Documentation

int QgsPalLabeling::addDiagramLayer	(	QgsVectorLayer *	layer,
		QgsDiagramLayerSettings *	s
	)		`[virtual]`

adds a diagram layer to the labeling engine

Reimplemented from QgsLabelingEngineInterface.

Definition at line 764 of file qgspallabeling.cpp.

References QgsMapRenderer::coordinateTransform(), QgsMapLayer::crs(), QgsDiagramLayerSettings::ct, QgsMapRenderer::destinationCrs(), QgsMapRenderer::hasCrsTransformEnabled(), QgsMapLayer::id(), mActiveDiagramLayers, mMapRenderer, mPal, QgsDiagramLayerSettings::obstacle, QgsDiagramLayerSettings::palLayer, QgsDiagramLayerSettings::placement, QgsDiagramLayerSettings::placementFlags, QgsDiagramLayerSettings::priority, and QgsDiagramLayerSettings::xform.

const QList<QgsLabelCandidate>& QgsPalLabeling::candidates ( ) [inline]

Definition at line 189 of file qgspallabeling.h.

QgsLabelingEngineInterface * QgsPalLabeling::clone ( ) [virtual]

called when passing engine among map renderers

Implements QgsLabelingEngineInterface.

Definition at line 1288 of file qgspallabeling.cpp.

References mShowingAllLabels, mShowingCandidates, and QgsPalLabeling().

void QgsPalLabeling::drawLabel	(	pal::LabelPosition *	label,
		QPainter *	painter,
		const QFont &	f,
		const QColor &	c,
		const QgsMapToPixel *	xform,
		double	bufferSize = `-1`,
		const QColor &	bufferColor = `QColor( 255, 255, 255 )`,
		bool	drawBuffer = `false`
	)

drawLabel

Definition at line 1205 of file qgspallabeling.cpp.

References QgsPalLayerSettings::addDirectionSymbol, drawLabelBuffer(), QgsPalLayerSettings::fontMetrics, layer(), QgsPalLayerSettings::Line, M_PI, QgsPalLayerSettings::multiLineLabels, QgsPalLayerSettings::placement, QgsPalLayerSettings::rasterCompressFactor, QgsMapToPixel::transform(), QgsPalLayerSettings::vectorScaleFactor, QgsPoint::x(), and QgsPoint::y().

Referenced by drawLabeling().

void QgsPalLabeling::drawLabelBuffer	(	QPainter *	p,
		QString	text,
		const QFont &	font,
		double	size,
		QColor	color
	)		`[static]`

Definition at line 1277 of file qgspallabeling.cpp.

Referenced by drawLabel().

void QgsPalLabeling::drawLabelCandidateRect	(	pal::LabelPosition *	lp,
		QPainter *	painter,
		const QgsMapToPixel *	xform
	)

Definition at line 1184 of file qgspallabeling.cpp.

References M_PI, mCandidates, QgsMapToPixel::transform(), QgsPoint::x(), and QgsPoint::y().

Referenced by drawLabeling().

void QgsPalLabeling::drawLabeling ( QgsRenderContext & context ) [virtual]

called when the map is drawn and labels should be placed

Implements QgsLabelingEngineInterface.

Definition at line 935 of file qgspallabeling.cpp.

void QgsPalLabeling::exit ( ) [virtual]

called when we're done with rendering

Implements QgsLabelingEngineInterface.

Definition at line 914 of file qgspallabeling.cpp.

References mMapRenderer, and mPal.

Referenced by ~QgsPalLabeling().

void QgsPalLabeling::init ( QgsMapRenderer * mr ) [virtual]

called when we're going to start with rendering

Implements QgsLabelingEngineInterface.

Definition at line 883 of file qgspallabeling.cpp.

References Chain, Falp, mActiveDiagramLayers, mActiveLayers, mCandLine, mCandPoint, mCandPolygon, mMapRenderer, mPal, mSearch, Popmusic_Chain, Popmusic_Tabu, and Popmusic_Tabu_Chain.

void QgsPalLabeling::initPal ( ) [protected]

bool QgsPalLabeling::isShowingAllLabels ( ) const [inline]

Definition at line 191 of file qgspallabeling.h.

bool QgsPalLabeling::isShowingCandidates ( ) const [inline]

Definition at line 187 of file qgspallabeling.h.

QList< QgsLabelPosition > QgsPalLabeling::labelsAtPosition ( const QgsPoint & p ) [virtual]

return infos about labels at a given (map) position

Implements QgsLabelingEngineInterface.

Definition at line 1142 of file qgspallabeling.cpp.

References QgsLabelSearchTree::label(), and mLabelSearchTree.

QgsPalLayerSettings & QgsPalLabeling::layer ( const QString & layerName )

Definition at line 921 of file qgspallabeling.cpp.

References mActiveLayers, and mInvalidLayerSettings.

Referenced by drawLabel(), drawLabeling(), prepareLayer(), and registerFeature().

void QgsPalLabeling::numCandidatePositions	(	int &	candPoint,
		int &	candLine,
		int &	candPolygon
	)

Definition at line 1160 of file qgspallabeling.cpp.

References mCandLine, mCandPoint, and mCandPolygon.

int QgsPalLabeling::prepareLayer	(	QgsVectorLayer *	layer,
		QSet< int > &	attrIndices,
		QgsRenderContext &	ctx
	)		`[virtual]`

hook called when drawing layer before issuing select()

Implements QgsLabelingEngineInterface.

Definition at line 678 of file qgspallabeling.cpp.

void QgsPalLabeling::registerDiagramFeature	(	QgsVectorLayer *	layer,
		QgsFeature &	feat,
		const QgsRenderContext &	context = `QgsRenderContext()`
	)		`[virtual]`