QGIS API Documentation
2.12.0-Lyon
|
Class that adds extra information to QgsLabelFeature for text labels. More...
#include <qgspalgeometry.h>
Public Member Functions | |
QgsTextLabelFeature (QgsFeatureId id, GEOSGeometry *geometry, const QSizeF &size) | |
Construct text label feature. More... | |
~QgsTextLabelFeature () | |
Clean up. More... | |
void | calculateInfo (bool curvedLabeling, QFontMetricsF *fm, const QgsMapToPixel *xform, double fontScale, double maxinangle, double maxoutangle) |
calculate data for info(). setDefinedFont() must have been called already. More... | |
const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > & | dataDefinedValues () const |
Get data-defined values. More... | |
QFont | definedFont () |
Font to be used for rendering. More... | |
QFontMetricsF * | labelFontMetrics () |
Metrics of the font for rendering. More... | |
void | setDataDefinedValues (const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &values) |
Set data-defined values. More... | |
void | setDefinedFont (const QFont &f) |
Set font to be used for rendering. More... | |
QString | text (int partId) const |
Returns the text component corresponding to a specified label part. More... | |
Public Member Functions inherited from QgsLabelFeature | |
QgsLabelFeature (QgsFeatureId id, GEOSGeometry *geometry, const QSizeF &size) | |
Create label feature, takes ownership of the geometry instance. More... | |
virtual | ~QgsLabelFeature () |
Clean up geometry and curved label info (if present) More... | |
bool | alwaysShow () const |
Whether label should be always shown (sets very high label priority) More... | |
pal::LabelInfo * | curvedLabelInfo () const |
Get additional infor required for curved label placement. Returns null if not set. More... | |
double | distLabel () const |
Applies to "around point" placement strategy or linestring features. More... | |
double | fixedAngle () const |
Angle in degrees of the fixed angle (relevant only if hasFixedAngle() returns true) More... | |
QgsPoint | fixedPosition () const |
Coordinates of the fixed position (relevant only if hasFixedPosition() returns true) More... | |
GEOSGeometry * | geometry () const |
Get access to the associated geometry. More... | |
bool | hasFixedAngle () const |
Whether the label should use a fixed angle instead of using angle from automatic placement. More... | |
bool | hasFixedPosition () const |
Whether the label should use a fixed position instead of being automatically placed. More... | |
bool | hasFixedQuadrant () const |
Returns whether the quadrant for the label is fixed. More... | |
QgsFeatureId | id () const |
Identifier of the label (unique within the parent label provider) More... | |
bool | isObstacle () const |
Returns whether the feature will act as an obstacle for labels. More... | |
QString | labelText () const |
Text of the label. More... | |
pal::Layer * | layer () const |
Get PAL layer of the label feature. Should be only used internally in PAL. More... | |
double | obstacleFactor () const |
Returns the obstacle factor for the feature. More... | |
QgsPoint | positionOffset () const |
Applies only to "offset from point" placement strategy. More... | |
double | priority () const |
Returns the feature's labeling priority. More... | |
QgsAbstractLabelProvider * | provider () const |
Return provider of this instance. More... | |
QPointF | quadOffset () const |
Applies to "offset from point" placement strategy and "around point" (in case hasFixedQuadrant() returns true). More... | |
double | repeatDistance () const |
Applies only to linestring features - after what distance (in map units) the labels should be repeated (0 = no repetitions) More... | |
void | setAlwaysShow (bool enabled) |
Set whether label should be always shown (sets very high label priority) More... | |
void | setCurvedLabelInfo (pal::LabelInfo *info) |
takes ownership of the instance More... | |
void | setDistLabel (double dist) |
Applies to "around point" placement strategy or linestring features. More... | |
void | setFixedAngle (double angle) |
Set angle in degrees of the fixed angle (relevant only if hasFixedAngle() returns true) More... | |
void | setFixedPosition (const QgsPoint &point) |
Set coordinates of the fixed position (relevant only if hasFixedPosition() returns true) More... | |
void | setHasFixedAngle (bool enabled) |
Set whether the label should use a fixed angle instead of using angle from automatic placement. More... | |
void | setHasFixedPosition (bool enabled) |
Set whether the label should use a fixed position instead of being automatically placed. More... | |
void | setHasFixedQuadrant (bool enabled) |
Sets whether the quadrant for the label must be respected. More... | |
void | setIsObstacle (bool enabled) |
Sets whether the feature will act as an obstacle for labels. More... | |
void | setLabelText (const QString &text) |
Set text of the label. More... | |
void | setLayer (pal::Layer *layer) |
Assign PAL layer to the label feature. Should be only used internally in PAL. More... | |
void | setObstacleFactor (double factor) |
Sets the obstacle factor for the feature. More... | |
void | setPositionOffset (const QgsPoint &offset) |
Applies only to "offset from point" placement strategy. More... | |
void | setPriority (double priority) |
Sets the priority for labeling the feature. More... | |
void | setQuadOffset (const QPointF &quadOffset) |
Set which side of the point to use. More... | |
void | setRepeatDistance (double dist) |
Applies only to linestring features - set after what distance (in map units) the labels should be repeated (0 = no repetitions) More... | |
QSizeF | size () const |
Size of the label (in map units) More... | |
Protected Attributes | |
QStringList | mClusters |
List of graphemes (used for curved labels) More... | |
QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > | mDataDefinedValues |
Stores attribute values for data defined properties. More... | |
QFont | mDefinedFont |
Font for rendering. More... | |
QFontMetricsF * | mFontMetrics |
Metrics of the font for rendering. More... | |
Protected Attributes inherited from QgsLabelFeature | |
bool | mAlwaysShow |
whether to always show label - even in case of collisions More... | |
double | mDistLabel |
distance of label from the feature (only for "around point" placement or linestrings) More... | |
double | mFixedAngle |
fixed rotation for the label (instead of automatic choice) More... | |
QgsPoint | mFixedPosition |
fixed position for the label (instead of automatic placement) More... | |
GEOSGeometry * | mGeometry |
Geometry of the feature to be labelled. More... | |
bool | mHasFixedAngle |
whether mFixedAngle should be respected More... | |
bool | mHasFixedPosition |
whether mFixedPosition should be respected More... | |
bool | mHasFixedQuadrant |
whether mQuadOffset should be respected (only for "around point" placement) More... | |
QgsFeatureId | mId |
Associated ID unique within the parent label provider. More... | |
pal::LabelInfo * | mInfo |
extra information for curved labels (may be null) More... | |
bool | mIsObstacle |
whether the feature geometry acts as an obstacle for labels More... | |
QString | mLabelText |
text of the label More... | |
pal::Layer * | mLayer |
Pointer to PAL layer (assigned when registered to PAL) More... | |
double | mObstacleFactor |
how strong is the geometry acting as obstacle More... | |
QgsPoint | mPositionOffset |
offset of label from the feature (only for "offset from point" placement) More... | |
double | mPriority |
Priority of the label. More... | |
QPointF | mQuadOffset |
whether the side of the label is fixed (only for "around point" placement) More... | |
double | mRepeatDistance |
distance after which label should be repeated (only for linestrings) More... | |
QSizeF | mSize |
Width and height of the label. More... | |
Class that adds extra information to QgsLabelFeature for text labels.
Definition at line 17 of file qgspalgeometry.h.
|
inline |
Construct text label feature.
Definition at line 21 of file qgspalgeometry.h.
|
inline |
Clean up.
Definition at line 29 of file qgspalgeometry.h.
|
inline |
calculate data for info(). setDefinedFont() must have been called already.
Definition at line 48 of file qgspalgeometry.h.
|
inline |
Get data-defined values.
Definition at line 113 of file qgspalgeometry.h.
|
inline |
Font to be used for rendering.
Definition at line 120 of file qgspalgeometry.h.
|
inline |
Metrics of the font for rendering.
Definition at line 123 of file qgspalgeometry.h.
|
inline |
Set data-defined values.
Definition at line 115 of file qgspalgeometry.h.
|
inline |
Set font to be used for rendering.
Definition at line 118 of file qgspalgeometry.h.
|
inline |
Returns the text component corresponding to a specified label part.
partId | Set to -1 for labels which are not broken into parts (eg, non-curved labels), or the required part index for labels which are broken into parts (curved labels) |
Definition at line 39 of file qgspalgeometry.h.
|
protected |
List of graphemes (used for curved labels)
Definition at line 127 of file qgspalgeometry.h.
|
protected |
Stores attribute values for data defined properties.
Definition at line 133 of file qgspalgeometry.h.
|
protected |
Font for rendering.
Definition at line 129 of file qgspalgeometry.h.
|
protected |
Metrics of the font for rendering.
Definition at line 131 of file qgspalgeometry.h.