QGIS API Documentation  2.17.0-Master (973e4b0)
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
pal::Layer Class Reference

A set of features which influence the labelling process. More...

#include <layer.h>

Public Types

enum  LabelMode { LabelPerFeature, LabelPerFeaturePart }
 
enum  UpsideDownLabels { Upright, ShowDefined, ShowAll }
 

Public Member Functions

virtual ~Layer ()
 
bool active () const
 Returns whether the layer is currently active. More...
 
QgsPalLayerSettings::Placement arrangement () const
 Returns the layer's arrangement policy. More...
 
LineArrangementFlags arrangementFlags () const
 Returns the layer's arrangement flags. More...
 
bool centroidInside () const
 Returns whether labels placed at the centroid of features within the layer are forced to be placed inside the feature's geometry. More...
 
void chopFeaturesAtRepeatDistance ()
 Chop layer features at the repeat distance. More...
 
int connectedFeatureId (QgsFeatureId featureId) const
 Returns the connected feature ID for a label feature ID, which is unique for all features which have been joined as a result of joinConnectedFeatures() More...
 
bool displayAll () const
 
int featureCount ()
 Returns the number of features in layer. More...
 
void joinConnectedFeatures ()
 Join connected features with the same label text. More...
 
bool labelLayer () const
 Returns whether the layer will be labeled or not. More...
 
LabelMode labelMode () const
 Returns the layer's labeling mode. More...
 
bool mergeConnectedLines () const
 Returns whether connected lines will be merged before labeling. More...
 
QString name () const
 Returns the layer's name. More...
 
QgsPalLayerSettings::ObstacleType obstacleType () const
 Returns the obstacle type, which controls how features within the layer act as obstacles for labels. More...
 
double priority () const
 Returns the layer's priority, between 0 and 1. More...
 
QgsAbstractLabelProviderprovider () const
 Returns pointer to the associated provider. More...
 
bool registerFeature (QgsLabelFeature *label)
 Register a feature in the layer. More...
 
void setActive (bool active)
 Sets whether the layer is currently active. More...
 
void setArrangement (QgsPalLayerSettings::Placement arrangement)
 Sets the layer's arrangement policy. More...
 
void setArrangementFlags (const LineArrangementFlags &flags)
 Sets the layer's arrangement flags. More...
 
void setCentroidInside (bool forceInside)
 Sets whether labels placed at the centroid of features within the layer are forced to be placed inside the feature's geometry. More...
 
void setLabelLayer (bool toLabel)
 Sets whether the layer will be labeled. More...
 
void setLabelMode (LabelMode mode)
 Sets the layer's labeling mode. More...
 
void setMergeConnectedLines (bool merge)
 Sets whether connected lines should be merged before labeling. More...
 
void setObstacleType (QgsPalLayerSettings::ObstacleType obstacleType)
 Sets the obstacle type, which controls how features within the layer act as obstacles for labels. More...
 
void setPriority (double priority)
 Sets the layer's priority. More...
 
void setUpsidedownLabels (UpsideDownLabels ud)
 Sets how upside down labels will be handled within the layer. More...
 
UpsideDownLabels upsidedownLabels () const
 Returns how upside down labels are handled within the layer. More...
 

Protected Member Functions

 Layer (QgsAbstractLabelProvider *provider, const QString &name, QgsPalLayerSettings::Placement arrangement, double defaultPriority, bool active, bool toLabel, Pal *pal, bool displayAll=false)
 Create a new layer. More...
 
void addFeaturePart (FeaturePart *fpart, const QString &labelText=QString())
 Add newly created feature part into r tree and to the list. More...
 
void addObstaclePart (FeaturePart *fpart)
 Add newly created obstacle part into r tree and to the list. More...
 

Protected Attributes

bool mActive
 
QgsPalLayerSettings::Placement mArrangement
 Optional flags used for some placement methods. More...
 
LineArrangementFlags mArrangementFlags
 
bool mCentroidInside
 
QHash< QgsFeatureId, int > mConnectedFeaturesIds
 
QHash< QString, QLinkedList< FeaturePart * > * > mConnectedHashtable
 
QStringList mConnectedTexts
 
double mDefaultPriority
 
bool mDisplayAll
 
RTree< FeaturePart *, double, 2, double, 8, 4 > * mFeatureIndex
 
QLinkedList< FeaturePart * > mFeatureParts
 List of feature parts. More...
 
QHash< QgsFeatureId, QgsLabelFeature * > mHashtable
 Lookup table of label features (owned by the label feature provider that created them) More...
 
bool mLabelLayer
 
bool mMergeLines
 
LabelMode mMode
 
QMutex mMutex
 
QString mName
 
RTree< FeaturePart *, double, 2, double, 8, 4 > * mObstacleIndex
 
QList< FeaturePart * > mObstacleParts
 List of obstacle parts. More...
 
QgsPalLayerSettings::ObstacleType mObstacleType
 
QgsAbstractLabelProvidermProvider
 
UpsideDownLabels mUpsidedownLabels
 
Palpal
 

Friends

class FeaturePart
 
class LabelPosition
 
class Pal
 
class Problem
 

Detailed Description

A set of features which influence the labelling process.

Note
not available in Python bindings

Definition at line 58 of file layer.h.

Member Enumeration Documentation

Enumerator
LabelPerFeature 
LabelPerFeaturePart 

Definition at line 68 of file layer.h.

Enumerator
Upright 
ShowDefined 
ShowAll 

Definition at line 69 of file layer.h.

Constructor & Destructor Documentation

Layer::~Layer ( )
virtual

Definition at line 69 of file layer.cpp.

Layer::Layer ( QgsAbstractLabelProvider provider,
const QString name,
QgsPalLayerSettings::Placement  arrangement,
double  defaultPriority,
bool  active,
bool  toLabel,
Pal pal,
bool  displayAll = false 
)
protected

Create a new layer.

Parameters
providerAssociated provider
nameName of the layer (for stats, debugging - does not need to be unique)
arrangementArrangement mode : how to place candidates
defaultPrioritylayer's prioriry (0 is the best, 1 the worst)
activeis the layer is active (currently displayed)
toLabelthe layer will be labeled whether toLablel is true
palpointer to the pal object
displayAllif true, all features will be labelled even though overlaps occur

Definition at line 43 of file layer.cpp.

Member Function Documentation

bool pal::Layer::active ( ) const
inline

Returns whether the layer is currently active.

See also
setActive

Definition at line 128 of file layer.h.

void Layer::addFeaturePart ( FeaturePart fpart,
const QString labelText = QString() 
)
protected

Add newly created feature part into r tree and to the list.

Definition at line 289 of file layer.cpp.

void Layer::addObstaclePart ( FeaturePart fpart)
protected

Add newly created obstacle part into r tree and to the list.

Definition at line 320 of file layer.cpp.

QgsPalLayerSettings::Placement pal::Layer::arrangement ( ) const
inline

Returns the layer's arrangement policy.

See also
setArrangement

Definition at line 94 of file layer.h.

LineArrangementFlags pal::Layer::arrangementFlags ( ) const
inline

Returns the layer's arrangement flags.

See also
setArrangementFlags

Definition at line 105 of file layer.h.

bool pal::Layer::centroidInside ( ) const
inline

Returns whether labels placed at the centroid of features within the layer are forced to be placed inside the feature's geometry.

See also
setCentroidInside

Definition at line 214 of file layer.h.

void Layer::chopFeaturesAtRepeatDistance ( )

Chop layer features at the repeat distance.

Definition at line 418 of file layer.cpp.

int Layer::connectedFeatureId ( QgsFeatureId  featureId) const

Returns the connected feature ID for a label feature ID, which is unique for all features which have been joined as a result of joinConnectedFeatures()

Returns
connected feature ID, or -1 if feature was not joined

Definition at line 413 of file layer.cpp.

bool pal::Layer::displayAll ( ) const
inline

Definition at line 78 of file layer.h.

int pal::Layer::featureCount ( )
inline

Returns the number of features in layer.

Definition at line 82 of file layer.h.

void Layer::joinConnectedFeatures ( )

Join connected features with the same label text.

Definition at line 350 of file layer.cpp.

bool pal::Layer::labelLayer ( ) const
inline

Returns whether the layer will be labeled or not.

See also
setLabelLayer

Definition at line 141 of file layer.h.

LabelMode pal::Layer::labelMode ( ) const
inline

Returns the layer's labeling mode.

See also
setLabelMode

Definition at line 178 of file layer.h.

bool pal::Layer::mergeConnectedLines ( ) const
inline

Returns whether connected lines will be merged before labeling.

See also
setMergeConnectedLines

Definition at line 189 of file layer.h.

QString pal::Layer::name ( ) const
inline

Returns the layer's name.

Definition at line 89 of file layer.h.

QgsPalLayerSettings::ObstacleType pal::Layer::obstacleType ( ) const
inline

Returns the obstacle type, which controls how features within the layer act as obstacles for labels.

See also
setObstacleType

Definition at line 147 of file layer.h.

double pal::Layer::priority ( ) const
inline

Returns the layer's priority, between 0 and 1.

0 corresponds to highest priority, 1 to lowest priority.

See also
setPriority

Definition at line 167 of file layer.h.

QgsAbstractLabelProvider* pal::Layer::provider ( ) const
inline

Returns pointer to the associated provider.

Definition at line 85 of file layer.h.

bool Layer::registerFeature ( QgsLabelFeature label)

Register a feature in the layer.

Does not take ownership of the label feature (it is owned by its provider).

Exceptions
PalException::FeatureExists
Returns
true on success (i.e. valid geometry)

Definition at line 95 of file layer.cpp.

void pal::Layer::setActive ( bool  active)
inline

Sets whether the layer is currently active.

Active means "is currently displayed or used as obstacles". When a layer is deactivated then feature of this layer will not be used for either labelling or as obstacles.

Parameters
activeset to true to make the layer active, or false to deactivate the layer
See also
active

Definition at line 123 of file layer.h.

void pal::Layer::setArrangement ( QgsPalLayerSettings::Placement  arrangement)
inline

Sets the layer's arrangement policy.

Parameters
arrangementarrangement policy
See also
arrangement

Definition at line 100 of file layer.h.

void pal::Layer::setArrangementFlags ( const LineArrangementFlags &  flags)
inline

Sets the layer's arrangement flags.

Parameters
flagsarrangement flags
See also
arrangementFlags

Definition at line 111 of file layer.h.

void pal::Layer::setCentroidInside ( bool  forceInside)
inline

Sets whether labels placed at the centroid of features within the layer are forced to be placed inside the feature's geometry.

Parameters
forceInsideset to true to force centroid labels to be within the feature. If set to false then the centroid may fall outside the feature.
See also
centroidInside

Definition at line 208 of file layer.h.

void pal::Layer::setLabelLayer ( bool  toLabel)
inline

Sets whether the layer will be labeled.

Note
Layers are labelled if and only if labelLayer and active are true
Parameters
toLabelset to false disable labeling this layer
See also
labelLayer
setActive

Definition at line 136 of file layer.h.

void pal::Layer::setLabelMode ( LabelMode  mode)
inline

Sets the layer's labeling mode.

Parameters
modelabel mode
See also
labelMode

Definition at line 173 of file layer.h.

void pal::Layer::setMergeConnectedLines ( bool  merge)
inline

Sets whether connected lines should be merged before labeling.

Parameters
mergeset to true to merge connected lines
See also
mergeConnectedLines

Definition at line 184 of file layer.h.

void pal::Layer::setObstacleType ( QgsPalLayerSettings::ObstacleType  obstacleType)
inline

Sets the obstacle type, which controls how features within the layer act as obstacles for labels.

Parameters
obstacleTypenew obstacle type
See also
obstacleType

Definition at line 154 of file layer.h.

void Layer::setPriority ( double  priority)

Sets the layer's priority.

Parameters
prioritylayer priority, between 0 and 1. 0 corresponds to highest priority, 1 to lowest priority.
See also
priority

Definition at line 85 of file layer.cpp.

void pal::Layer::setUpsidedownLabels ( UpsideDownLabels  ud)
inline

Sets how upside down labels will be handled within the layer.

Parameters
udupside down label handling mode
See also
upsideDownLabels

Definition at line 195 of file layer.h.

UpsideDownLabels pal::Layer::upsidedownLabels ( ) const
inline

Returns how upside down labels are handled within the layer.

See also
setUpsidedownLabels

Definition at line 200 of file layer.h.

Friends And Related Function Documentation

friend class FeaturePart
friend

Definition at line 61 of file layer.h.

friend class LabelPosition
friend

Definition at line 65 of file layer.h.

friend class Pal
friend

Definition at line 60 of file layer.h.

friend class Problem
friend

Definition at line 63 of file layer.h.

Member Data Documentation

bool pal::Layer::mActive
protected

Definition at line 253 of file layer.h.

QgsPalLayerSettings::Placement pal::Layer::mArrangement
protected

Optional flags used for some placement methods.

Definition at line 259 of file layer.h.

LineArrangementFlags pal::Layer::mArrangementFlags
protected

Definition at line 260 of file layer.h.

bool pal::Layer::mCentroidInside
protected

Definition at line 256 of file layer.h.

QHash< QgsFeatureId, int > pal::Layer::mConnectedFeaturesIds
protected

Definition at line 276 of file layer.h.

QHash< QString, QLinkedList<FeaturePart*>* > pal::Layer::mConnectedHashtable
protected

Definition at line 274 of file layer.h.

QStringList pal::Layer::mConnectedTexts
protected

Definition at line 275 of file layer.h.

double pal::Layer::mDefaultPriority
protected

Definition at line 250 of file layer.h.

bool pal::Layer::mDisplayAll
protected

Definition at line 255 of file layer.h.

RTree<FeaturePart*, double, 2, double, 8, 4>* pal::Layer::mFeatureIndex
protected

Definition at line 267 of file layer.h.

QLinkedList<FeaturePart*> pal::Layer::mFeatureParts
protected

List of feature parts.

Definition at line 243 of file layer.h.

QHash< QgsFeatureId, QgsLabelFeature*> pal::Layer::mHashtable
protected

Lookup table of label features (owned by the label feature provider that created them)

Definition at line 269 of file layer.h.

bool pal::Layer::mLabelLayer
protected

Definition at line 254 of file layer.h.

bool pal::Layer::mMergeLines
protected

Definition at line 262 of file layer.h.

LabelMode pal::Layer::mMode
protected

Definition at line 261 of file layer.h.

QMutex pal::Layer::mMutex
protected

Definition at line 278 of file layer.h.

QString pal::Layer::mName
protected

Definition at line 240 of file layer.h.

RTree<FeaturePart*, double, 2, double, 8, 4>* pal::Layer::mObstacleIndex
protected

Definition at line 272 of file layer.h.

QList<FeaturePart*> pal::Layer::mObstacleParts
protected

List of obstacle parts.

Definition at line 246 of file layer.h.

QgsPalLayerSettings::ObstacleType pal::Layer::mObstacleType
protected

Definition at line 252 of file layer.h.

QgsAbstractLabelProvider* pal::Layer::mProvider
protected

Definition at line 239 of file layer.h.

UpsideDownLabels pal::Layer::mUpsidedownLabels
protected

Definition at line 264 of file layer.h.

Pal* pal::Layer::pal
protected

Definition at line 248 of file layer.h.


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