Quantum GIS API Documentation  1.7.4
Public Member Functions | Private Member Functions | Private Attributes
QgsPALObjectPositionManager Class Reference

A class that uses the PAL library for overlay object placement. More...

#include <qgspalobjectpositionmanager.h>

Inheritance diagram for QgsPALObjectPositionManager:
Inheritance graph
[legend]
Collaboration diagram for QgsPALObjectPositionManager:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 QgsPALObjectPositionManager ()
 ~QgsPALObjectPositionManager ()
void addLayer (QgsVectorLayer *vl, QList< QgsVectorOverlay * > &overlays)
 Adds a layer that may contain * overlays to the position manager.
void findObjectPositions (const QgsRenderContext &renderContext, QGis::UnitType unitType)
 Calculate positions for the overlay objects.
void removeLayers ()
 Removes all the layers.
void setPlacementAlgorithm (const QString &algorithmName)
 Sets algorithm used for object placements.

Private Member Functions

void deletePALGeometries ()

Private Attributes

pal::Pal mPositionEngine
int mNumberOfLayers
QList< QgsPALGeometry * > mPALGeometries
 Internal storage of the pal geometries between addLayer and findObjectPositions operations.

Detailed Description

A class that uses the PAL library for overlay object placement.

Note:
This class has been added in version 1.1

Definition at line 29 of file qgspalobjectpositionmanager.h.


Constructor & Destructor Documentation

Definition at line 30 of file qgspalobjectpositionmanager.cpp.

Definition at line 35 of file qgspalobjectpositionmanager.cpp.

References deletePALGeometries().


Member Function Documentation

void QgsPALObjectPositionManager::addLayer ( QgsVectorLayer vl,
QList< QgsVectorOverlay * > &  overlays 
) [virtual]

Adds a layer that may contain * overlays to the position manager.

The overlay objects contained in the overlays will then be considered in label placement

Implements QgsOverlayObjectPositionManager.

Definition at line 40 of file qgspalobjectpositionmanager.cpp.

References QgsVectorLayer::geometryType(), QGis::Line, mNumberOfLayers, mPALGeometries, mPositionEngine, QGis::Point, and QGis::Polygon.

Definition at line 227 of file qgspalobjectpositionmanager.cpp.

References mPALGeometries.

Referenced by findObjectPositions(), and ~QgsPALObjectPositionManager().

void QgsPALObjectPositionManager::findObjectPositions ( const QgsRenderContext context,
QGis::UnitType  unitType 
) [virtual]

Removes all the layers.

Implements QgsOverlayObjectPositionManager.

Definition at line 183 of file qgspalobjectpositionmanager.cpp.

References mPositionEngine.

void QgsPALObjectPositionManager::setPlacementAlgorithm ( const QString &  algorithmName)

Sets algorithm used for object placements.

Possibilities are: Chain, Popmusic tabu chain, Popmusic tabu, Popmusic chain

Definition at line 207 of file qgspalobjectpositionmanager.cpp.

References mPositionEngine.

Referenced by QgsMapRenderer::overlayManagerFromSettings().


Member Data Documentation

Definition at line 44 of file qgspalobjectpositionmanager.h.

Referenced by addLayer().

Internal storage of the pal geometries between addLayer and findObjectPositions operations.

Definition at line 46 of file qgspalobjectpositionmanager.h.

Referenced by addLayer(), and deletePALGeometries().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines