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

#include <qgspallabeling.h>

Collaboration diagram for QgsPalLayerSettings:
Collaboration graph
[legend]

List of all members.

Public Types

enum  Placement {
  AroundPoint, OverPoint, Line, Curved,
  Horizontal, Free
}
enum  LinePlacementFlags { OnLine = 1, AboveLine = 2, BelowLine = 4, MapOrientation = 8 }
enum  DataDefinedProperties {
  Size = 0, Bold, Italic, Underline,
  Color, Strikeout, Family, BufferSize,
  BufferColor, PositionX, PositionY, Hali,
  Vali, LabelDistance, Rotation
}

Public Member Functions

 QgsPalLayerSettings ()
 QgsPalLayerSettings (const QgsPalLayerSettings &s)
 ~QgsPalLayerSettings ()
void calculateLabelSize (const QFontMetricsF *fm, QString text, double &labelX, double &labelY)
void registerFeature (QgsFeature &f, const QgsRenderContext &context)
void readFromLayer (QgsVectorLayer *layer)
void writeToLayer (QgsVectorLayer *layer)
void setDataDefinedProperty (DataDefinedProperties p, int attributeIndex)
 Set a property as data defined.
void removeDataDefinedProperty (DataDefinedProperties p)
 Set a property to static instead data defined.
int sizeToPixel (double size, const QgsRenderContext &c) const
 Calculates pixel size (considering output size should be in pixel or map units, scale factors and oversampling)

Public Attributes

QString fieldName
Placement placement
unsigned int placementFlags
QFont textFont
QColor textColor
bool enabled
int priority
bool obstacle
double dist
double vectorScaleFactor
double rasterCompressFactor
int scaleMin
int scaleMax
double bufferSize
QColor bufferColor
bool labelPerPart
bool mergeLines
bool multiLineLabels
double minFeatureSize
bool addDirectionSymbol
bool fontSizeInMapUnits
bool distInMapUnits
pal::Layer * palLayer
int fieldIndex
QFontMetricsF * fontMetrics
const QgsMapToPixel * xform
const QgsCoordinateTransform * ct
QgsPoint ptZero
QgsPoint ptOne
QList< QgsPalGeometry * > geometries
QMap< DataDefinedProperties, int > dataDefinedProperties
 Stores field indices for data defined layer properties.

Private Member Functions

bool checkMinimumSizeMM (const QgsRenderContext &ct, QgsGeometry *geom, double minSize) const
 Checks if a feature is larger than a minimum size (in mm)

Detailed Description

Definition at line 56 of file qgspallabeling.h.

Member Enumeration Documentation

enum QgsPalLayerSettings::DataDefinedProperties
Enumerator:
Size 
Bold 
Italic 
Underline 
Color 
Strikeout 
Family 
BufferSize 
BufferColor 
PositionX 
PositionY 
Hali 
Vali 
LabelDistance 
Rotation 

Definition at line 81 of file qgspallabeling.h.

enum QgsPalLayerSettings::LinePlacementFlags
Enumerator:
OnLine 
AboveLine 
BelowLine 
MapOrientation 

Definition at line 73 of file qgspallabeling.h.

enum QgsPalLayerSettings::Placement
Enumerator:
AroundPoint 
OverPoint 
Line 
Curved 
Horizontal 
Free 

Definition at line 63 of file qgspallabeling.h.

Constructor & Destructor Documentation

QgsPalLayerSettings::QgsPalLayerSettings ( )

Definition at line 126 of file qgspallabeling.cpp.

References addDirectionSymbol, AroundPoint, bufferColor, bufferSize, dist, distInMapUnits, enabled, fontSizeInMapUnits, labelPerPart, mergeLines, minFeatureSize, multiLineLabels, obstacle, placement, placementFlags, priority, rasterCompressFactor, scaleMax, scaleMin, textColor, and vectorScaleFactor.

QgsPalLayerSettings::QgsPalLayerSettings ( const QgsPalLayerSettings &  s)

Definition at line 152 of file qgspallabeling.cpp.

References addDirectionSymbol, bufferColor, bufferSize, ct, dataDefinedProperties, dist, distInMapUnits, enabled, fieldName, fontMetrics, fontSizeInMapUnits, labelPerPart, mergeLines, minFeatureSize, multiLineLabels, obstacle, placement, placementFlags, priority, rasterCompressFactor, scaleMax, scaleMin, textColor, textFont, and vectorScaleFactor.

QgsPalLayerSettings::~QgsPalLayerSettings ( )

Definition at line 184 of file qgspallabeling.cpp.

References ct, and fontMetrics.

Member Function Documentation

void QgsPalLayerSettings::calculateLabelSize ( const QFontMetricsF *  fm,
QString  text,
double &  labelX,
double &  labelY 
)

Definition at line 389 of file qgspallabeling.cpp.

References addDirectionSymbol, Line, multiLineLabels, placement, ptZero, rasterCompressFactor, QgsMapToPixel::toMapCoordinatesF(), QgsPoint::x(), xform, and QgsPoint::y().

Referenced by registerFeature().

bool QgsPalLayerSettings::checkMinimumSizeMM ( const QgsRenderContext &  ct,
QgsGeometry *  geom,
double  minSize 
) const [private]

Checks if a feature is larger than a minimum size (in mm)

Returns:
true if above size, false if below

Definition at line 351 of file qgspallabeling.cpp.

References QgsGeometry::area(), QgsGeometry::length(), QGis::Line, QgsRenderContext::mapToPixel(), QgsMapToPixel::mapUnitsPerPixel(), QGis::Point, QGis::Polygon, QgsRenderContext::scaleFactor(), and QgsGeometry::type().

Referenced by registerFeature().

void QgsPalLayerSettings::readFromLayer ( QgsVectorLayer *  layer)

Definition at line 271 of file qgspallabeling.cpp.

References _readColor(), _readDataDefinedPropertyMap(), addDirectionSymbol, bufferColor, bufferSize, QgsMapLayer::customProperty(), dataDefinedProperties, dist, distInMapUnits, enabled, fieldName, fontSizeInMapUnits, labelPerPart, mergeLines, minFeatureSize, multiLineLabels, obstacle, placement, placementFlags, priority, scaleMax, scaleMin, textColor, and textFont.

Referenced by QgsPalLabeling::prepareLayer(), and QgsPalLabeling::willUseLayer().

void QgsPalLayerSettings::registerFeature ( QgsFeature &  f,
const QgsRenderContext &  context 
)

Definition at line 428 of file qgspallabeling.cpp.

References QgsPalGeometry::addDataDefinedValue(), MathUtils::angle(), QgsGeometry::asGeos(), QgsFeature::attributeMap(), calculateLabelSize(), checkMinimumSizeMM(), ct, dataDefinedProperties, dist, distInMapUnits, fieldIndex, fontMetrics, geometries, QgsFeature::geometry(), Hali, QgsFeature::id(), QgsPalGeometry::info(), LabelDistance, M_PI, QgsRenderContext::mapToPixel(), QgsMapToPixel::mapUnitsPerPixel(), minFeatureSize, palLayer, PositionX, PositionY, ptOne, ptZero, QgsDebugMsg, rasterCompressFactor, Rotation, Size, sizeToPixel(), QgsPalGeometry::strId(), textFont, QgsGeometry::transform(), QgsCoordinateTransform::transformInPlace(), Vali, vectorScaleFactor, QgsPoint::x(), and xform.

Referenced by QgsPalLabeling::registerFeature().

void QgsPalLayerSettings::removeDataDefinedProperty ( DataDefinedProperties  p)

Set a property to static instead data defined.

Definition at line 346 of file qgspallabeling.cpp.

References dataDefinedProperties.

void QgsPalLayerSettings::setDataDefinedProperty ( DataDefinedProperties  p,
int  attributeIndex 
)

Set a property as data defined.

Definition at line 341 of file qgspallabeling.cpp.

References dataDefinedProperties.

int QgsPalLayerSettings::sizeToPixel ( double  size,
const QgsRenderContext &  c 
) const

Calculates pixel size (considering output size should be in pixel or map units, scale factors and oversampling)

Parameters:
sizesize to convert
crendercontext
Returns:
font pixel size

Definition at line 618 of file qgspallabeling.cpp.

References fontSizeInMapUnits, QgsRenderContext::mapToPixel(), QgsMapToPixel::mapUnitsPerPixel(), QgsRenderContext::rasterScaleFactor(), and QgsRenderContext::scaleFactor().

Referenced by QgsPalLabeling::drawLabeling(), QgsPalLabeling::prepareLayer(), and registerFeature().

void QgsPalLayerSettings::writeToLayer ( QgsVectorLayer *  layer)

Definition at line 306 of file qgspallabeling.cpp.

References _writeColor(), _writeDataDefinedPropertyMap(), addDirectionSymbol, bufferColor, bufferSize, dataDefinedProperties, dist, distInMapUnits, enabled, fieldName, fontSizeInMapUnits, labelPerPart, mergeLines, minFeatureSize, multiLineLabels, obstacle, placement, placementFlags, priority, scaleMax, scaleMin, QgsMapLayer::setCustomProperty(), textColor, and textFont.

Member Data Documentation

bool QgsPalLayerSettings::addDirectionSymbol

Definition at line 120 of file qgspallabeling.h.

Referenced by calculateLabelSize(), QgsPalLabeling::drawLabel(), QgsPalLayerSettings(), readFromLayer(), and writeToLayer().

QColor QgsPalLayerSettings::bufferColor

Definition at line 113 of file qgspallabeling.h.

Referenced by QgsPalLabeling::drawLabeling(), QgsPalLayerSettings(), readFromLayer(), and writeToLayer().

double QgsPalLayerSettings::bufferSize

Definition at line 112 of file qgspallabeling.h.

Referenced by QgsPalLabeling::drawLabeling(), QgsPalLayerSettings(), readFromLayer(), and writeToLayer().

const QgsCoordinateTransform* QgsPalLayerSettings::ct

Definition at line 143 of file qgspallabeling.h.

Referenced by QgsPalLabeling::prepareLayer(), QgsPalLayerSettings(), registerFeature(), and ~QgsPalLayerSettings().

QMap< DataDefinedProperties, int > QgsPalLayerSettings::dataDefinedProperties

Stores field indices for data defined layer properties.

Definition at line 148 of file qgspallabeling.h.

Referenced by QgsPalLabeling::prepareLayer(), QgsPalLayerSettings(), readFromLayer(), registerFeature(), removeDataDefinedProperty(), setDataDefinedProperty(), and writeToLayer().

double QgsPalLayerSettings::dist

Definition at line 108 of file qgspallabeling.h.

Referenced by QgsPalLayerSettings(), readFromLayer(), registerFeature(), and writeToLayer().

bool QgsPalLayerSettings::distInMapUnits

Definition at line 122 of file qgspallabeling.h.

Referenced by QgsPalLayerSettings(), readFromLayer(), registerFeature(), and writeToLayer().

bool QgsPalLayerSettings::enabled

Definition at line 105 of file qgspallabeling.h.

Referenced by QgsPalLabeling::prepareLayer(), QgsPalLayerSettings(), readFromLayer(), QgsPalLabeling::willUseLayer(), and writeToLayer().

int QgsPalLayerSettings::fieldIndex

Definition at line 140 of file qgspallabeling.h.

Referenced by QgsPalLabeling::prepareLayer(), and registerFeature().

QString QgsPalLayerSettings::fieldName

Definition at line 100 of file qgspallabeling.h.

Referenced by QgsPalLabeling::prepareLayer(), QgsPalLayerSettings(), readFromLayer(), and writeToLayer().

QFontMetricsF* QgsPalLayerSettings::fontMetrics

Definition at line 141 of file qgspallabeling.h.

Referenced by QgsPalLabeling::drawLabel(), QgsPalLabeling::prepareLayer(), QgsPalLayerSettings(), registerFeature(), and ~QgsPalLayerSettings().

bool QgsPalLayerSettings::fontSizeInMapUnits

Definition at line 121 of file qgspallabeling.h.

Referenced by QgsPalLayerSettings(), readFromLayer(), sizeToPixel(), and writeToLayer().

QList<QgsPalGeometry*> QgsPalLayerSettings::geometries

Definition at line 145 of file qgspallabeling.h.

Referenced by QgsPalLabeling::drawLabeling(), and registerFeature().

bool QgsPalLayerSettings::labelPerPart

Definition at line 114 of file qgspallabeling.h.

Referenced by QgsPalLabeling::prepareLayer(), QgsPalLayerSettings(), readFromLayer(), and writeToLayer().

bool QgsPalLayerSettings::mergeLines

Definition at line 115 of file qgspallabeling.h.

Referenced by QgsPalLabeling::prepareLayer(), QgsPalLayerSettings(), readFromLayer(), and writeToLayer().

double QgsPalLayerSettings::minFeatureSize

Definition at line 117 of file qgspallabeling.h.

Referenced by QgsPalLayerSettings(), readFromLayer(), registerFeature(), and writeToLayer().

bool QgsPalLayerSettings::multiLineLabels

Definition at line 116 of file qgspallabeling.h.

Referenced by calculateLabelSize(), QgsPalLabeling::drawLabel(), QgsPalLayerSettings(), readFromLayer(), and writeToLayer().

bool QgsPalLayerSettings::obstacle

Definition at line 107 of file qgspallabeling.h.

Referenced by QgsPalLabeling::prepareLayer(), QgsPalLayerSettings(), readFromLayer(), and writeToLayer().

pal::Layer* QgsPalLayerSettings::palLayer

Definition at line 139 of file qgspallabeling.h.

Referenced by QgsPalLabeling::prepareLayer(), and registerFeature().

Placement QgsPalLayerSettings::placement

Definition at line 101 of file qgspallabeling.h.

Referenced by calculateLabelSize(), QgsPalLabeling::drawLabel(), QgsPalLabeling::prepareLayer(), QgsPalLayerSettings(), readFromLayer(), and writeToLayer().

unsigned int QgsPalLayerSettings::placementFlags

Definition at line 102 of file qgspallabeling.h.

Referenced by QgsPalLabeling::prepareLayer(), QgsPalLayerSettings(), readFromLayer(), and writeToLayer().

int QgsPalLayerSettings::priority

Definition at line 106 of file qgspallabeling.h.

Referenced by QgsPalLabeling::prepareLayer(), QgsPalLayerSettings(), readFromLayer(), and writeToLayer().

QgsPoint QgsPalLayerSettings::ptOne

Definition at line 144 of file qgspallabeling.h.

Referenced by QgsPalLabeling::prepareLayer(), and registerFeature().

QgsPoint QgsPalLayerSettings::ptZero

Definition at line 144 of file qgspallabeling.h.

Referenced by calculateLabelSize(), QgsPalLabeling::prepareLayer(), and registerFeature().

double QgsPalLayerSettings::rasterCompressFactor

Definition at line 110 of file qgspallabeling.h.

Referenced by calculateLabelSize(), QgsPalLabeling::drawLabel(), QgsPalLabeling::prepareLayer(), QgsPalLayerSettings(), and registerFeature().

int QgsPalLayerSettings::scaleMax

Definition at line 111 of file qgspallabeling.h.

Referenced by QgsPalLabeling::prepareLayer(), QgsPalLayerSettings(), readFromLayer(), and writeToLayer().

int QgsPalLayerSettings::scaleMin

Definition at line 111 of file qgspallabeling.h.

Referenced by QgsPalLabeling::prepareLayer(), QgsPalLayerSettings(), readFromLayer(), and writeToLayer().

QColor QgsPalLayerSettings::textColor

Definition at line 104 of file qgspallabeling.h.

Referenced by QgsPalLabeling::drawLabeling(), QgsPalLayerSettings(), readFromLayer(), and writeToLayer().

QFont QgsPalLayerSettings::textFont

Definition at line 103 of file qgspallabeling.h.

Referenced by QgsPalLabeling::drawLabeling(), QgsPalLabeling::prepareLayer(), QgsPalLayerSettings(), readFromLayer(), registerFeature(), and writeToLayer().

double QgsPalLayerSettings::vectorScaleFactor

Definition at line 109 of file qgspallabeling.h.

Referenced by QgsPalLabeling::drawLabel(), QgsPalLabeling::prepareLayer(), QgsPalLayerSettings(), and registerFeature().

const QgsMapToPixel* QgsPalLayerSettings::xform

Definition at line 142 of file qgspallabeling.h.

Referenced by calculateLabelSize(), QgsPalLabeling::prepareLayer(), and registerFeature().

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Tue Jun 19 2012 23:25:48 for Quantum GIS API Documentation by   doxygen 1.7.6.1