QGIS API Documentation  2.14.0-Essen
qgslabelfeature.h
Go to the documentation of this file.
1 #ifndef QGSLABELFEATURE_H
2 #define QGSLABELFEATURE_H
3 
4 #include "qgsgeometry.h"
5 
6 #include "qgspallabeling.h"
7 
8 namespace pal
9 {
10  class LabelInfo;
11 }
12 
14 class QgsRenderContext;
15 class QgsGeometry;
16 
17 
34 class CORE_EXPORT QgsLabelFeature
35 {
36  public:
37 
40  struct VisualMargin
41  {
45  : left( 0.0 )
46  , right( 0.0 )
47  , top( 0.0 )
48  , bottom( 0.0 )
49  {}
50 
57  VisualMargin( double top, double right, double bottom, double left )
58  : left( left )
59  , right( right )
60  , top( top )
61  , bottom( bottom )
62  {}
63 
65  double left;
67  double right;
69  double top;
71  double bottom;
72 
73  VisualMargin& operator *=( double value )
74  {
75  left *= value;
76  right *= value;
77  top *= value;
78  bottom *= value;
79  return *this;
80  }
81  };
82 
84  QgsLabelFeature( QgsFeatureId id, GEOSGeometry* geometry, QSizeF size );
86  virtual ~QgsLabelFeature();
87 
89  QgsFeatureId id() const { return mId; }
90 
92  GEOSGeometry* geometry() const { return mGeometry; }
93 
102  void setObstacleGeometry( GEOSGeometry* obstacleGeom );
103 
108  GEOSGeometry* obstacleGeometry() const { return mObstacleGeometry; }
109 
111  QSizeF size() const { return mSize; }
112 
122  void setVisualMargin( const VisualMargin& margin ) { mVisualMargin = margin; }
123 
127  const VisualMargin& visualMargin() const { return mVisualMargin; }
128 
134  void setSymbolSize( QSizeF size ) { mSymbolSize = size; }
135 
142  const QSizeF& symbolSize() const { return mSymbolSize; }
143 
149  double priority() const { return mPriority; }
156  void setPriority( double priority ) { mPriority = priority; }
157 
163  double zIndex() const { return mZIndex; }
164 
171  void setZIndex( double zIndex ) { mZIndex = zIndex; }
172 
174  bool hasFixedPosition() const { return mHasFixedPosition; }
176  void setHasFixedPosition( bool enabled ) { mHasFixedPosition = enabled; }
178  QgsPoint fixedPosition() const { return mFixedPosition; }
180  void setFixedPosition( const QgsPoint& point ) { mFixedPosition = point; }
181 
183  bool hasFixedAngle() const { return mHasFixedAngle; }
185  void setHasFixedAngle( bool enabled ) { mHasFixedAngle = enabled; }
187  double fixedAngle() const { return mFixedAngle; }
189  void setFixedAngle( double angle ) { mFixedAngle = angle; }
190 
196  bool hasFixedQuadrant() const { return mHasFixedQuadrant; }
202  void setHasFixedQuadrant( bool enabled ) { mHasFixedQuadrant = enabled; }
207  QPointF quadOffset() const { return mQuadOffset; }
210  void setQuadOffset( QPointF quadOffset ) { mQuadOffset = quadOffset; }
213  QgsPoint positionOffset() const { return mPositionOffset; }
216  void setPositionOffset( const QgsPoint& offset ) { mPositionOffset = offset; }
217 
223  QgsPalLayerSettings::OffsetType offsetType() const { return mOffsetType; }
224 
230  void setOffsetType( QgsPalLayerSettings::OffsetType type ) { mOffsetType = type; }
231 
234  double distLabel() const { return mDistLabel; }
237  void setDistLabel( double dist ) { mDistLabel = dist; }
238 
244 
249  void setPredefinedPositionOrder( const QVector< QgsPalLayerSettings::PredefinedPointPosition >& order ) { mPredefinedPositionOrder = order; }
250 
253  double repeatDistance() const { return mRepeatDistance; }
256  void setRepeatDistance( double dist ) { mRepeatDistance = dist; }
257 
259  bool alwaysShow() const { return mAlwaysShow; }
261  void setAlwaysShow( bool enabled ) { mAlwaysShow = enabled; }
262 
267  bool isObstacle() const { return mIsObstacle; }
272  void setIsObstacle( bool enabled ) { mIsObstacle = enabled; }
277  double obstacleFactor() const { return mObstacleFactor; }
285  void setObstacleFactor( double factor ) { mObstacleFactor = factor; }
286 
292  QString labelText() const { return mLabelText; }
294  void setLabelText( const QString& text ) { mLabelText = text; }
295 
297  pal::LabelInfo* curvedLabelInfo() const { return mInfo; }
299  void setCurvedLabelInfo( pal::LabelInfo* info ) { mInfo = info; }
300 
302  pal::Layer* layer() const { return mLayer; }
304  void setLayer( pal::Layer* layer ) { mLayer = layer; }
305 
307  QgsAbstractLabelProvider* provider() const;
308 
309  protected:
312 
316  GEOSGeometry* mGeometry;
318  GEOSGeometry* mObstacleGeometry;
326  double mPriority;
328  double mZIndex;
336  double mFixedAngle;
344  double mDistLabel;
361 };
362 
363 #endif // QGSLABELFEATURE_H
pal::Layer * layer() const
Get PAL layer of the label feature. Should be only used internally in PAL.
void setSymbolSize(QSizeF size)
Sets the size of the rendered symbol associated with this feature.
double repeatDistance() const
Applies only to linestring features - after what distance (in map units) the labels should be repeate...
bool alwaysShow() const
Whether label should be always shown (sets very high label priority)
A set of features which influence the labelling process.
Definition: layer.h:55
QString mLabelText
text of the label
pal::LabelInfo * mInfo
extra information for curved labels (may be null)
bool mIsObstacle
whether the feature geometry acts as an obstacle for labels
void setObstacleFactor(double factor)
Sets the obstacle factor for the feature.
QPointF quadOffset() const
Applies to "offset from point" placement strategy and "around point" (in case hasFixedQuadrant() retu...
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:76
void setCurvedLabelInfo(pal::LabelInfo *info)
takes ownership of the instance
bool mHasFixedQuadrant
whether mQuadOffset should be respected (only for "around point" placement)
double priority() const
Returns the feature&#39;s labeling priority.
double mRepeatDistance
distance after which label should be repeated (only for linestrings)
double mObstacleFactor
how strong is the geometry acting as obstacle
QgsFeatureId mId
Associated ID unique within the parent label provider.
void setFixedPosition(const QgsPoint &point)
Set coordinates of the fixed position (relevant only if hasFixedPosition() returns true) ...
QgsPoint mFixedPosition
fixed position for the label (instead of automatic placement)
void setAlwaysShow(bool enabled)
Set whether label should be always shown (sets very high label priority)
void setLabelText(const QString &text)
Set text of the label.
bool mHasFixedPosition
whether mFixedPosition should be respected
GEOSGeometry * mObstacleGeometry
Optional geometry to use for label obstacles, if different to mGeometry.
bool isObstacle() const
Returns whether the feature will act as an obstacle for labels.
QgsPalLayerSettings::OffsetType offsetType() const
Returns the offset type, which determines how offsets and distance to label behaves.
void setHasFixedPosition(bool enabled)
Set whether the label should use a fixed position instead of being automatically placed.
GEOSGeometry * geometry() const
Get access to the associated geometry.
pal::LabelInfo * curvedLabelInfo() const
Get additional infor required for curved label placement. Returns null if not set.
QSizeF size() const
Size of the label (in map units)
QSizeF mSize
Width and height of the label.
bool hasFixedPosition() const
Whether the label should use a fixed position instead of being automatically placed.
double mFixedAngle
fixed rotation for the label (instead of automatic choice)
VisualMargin()
Default constructor, all margins are set to 0.0.
void setIsObstacle(bool enabled)
Sets whether the feature will act as an obstacle for labels.
void setZIndex(double zIndex)
Sets the label&#39;s z-index.
const QSizeF & symbolSize() const
Returns the size of the rendered symbol associated with this feature, if applicable.
QSizeF mSymbolSize
Size of associated rendered symbol, if applicable.
GEOSGeometry * obstacleGeometry() const
Returns the label&#39;s obstacle geometry, if different to the feature geometry.
QVector< QgsPalLayerSettings::PredefinedPointPosition > mPredefinedPositionOrder
Ordered list of predefined positions for label (only for OrderedPositionsAroundPoint placement) ...
void setLayer(pal::Layer *layer)
Assign PAL layer to the label feature. Should be only used internally in PAL.
QgsPoint fixedPosition() const
Coordinates of the fixed position (relevant only if hasFixedPosition() returns true) ...
bool hasFixedQuadrant() const
Returns whether the quadrant for the label is fixed.
double bottom
Bottom margin.
Optional additional info about label (for curved labels)
Definition: feature.h:52
void setFixedAngle(double angle)
Set angle in degrees of the fixed angle (relevant only if hasFixedAngle() returns true) ...
GEOSGeometry * mGeometry
Geometry of the feature to be labelled.
void setVisualMargin(const VisualMargin &margin)
Sets the visual margin for the label feature.
OffsetType
Behaviour modifier for label offset and distance, only applies in some label placement modes...
void setPredefinedPositionOrder(const QVector< QgsPalLayerSettings::PredefinedPointPosition > &order)
Sets the priority ordered list of predefined positions for label candidates.
void setOffsetType(QgsPalLayerSettings::OffsetType type)
Sets the offset type, which determines how offsets and distance to label behaves. ...
void setDistLabel(double dist)
Applies to "around point" placement strategy or linestring features.
bool mAlwaysShow
whether to always show label - even in case of collisions
Stores visual margins for labels (left, right, top and bottom)
A class to represent a point.
Definition: qgspoint.h:65
The QgsAbstractLabelProvider class is an interface class.
double ANALYSIS_EXPORT angle(Point3D *p1, Point3D *p2, Point3D *p3, Point3D *p4)
Calculates the angle between two segments (in 2 dimension, z-values are ignored)
bool mHasFixedAngle
whether mFixedAngle should be respected
double zIndex() const
Returns the label&#39;s z-index.
const VisualMargin & visualMargin() const
Returns the visual margin for the label feature.
QgsPoint positionOffset() const
Applies only to "offset from point" placement strategy.
Contains information about the context of a rendering operation.
double obstacleFactor() const
Returns the obstacle factor for the feature.
The QgsLabelFeature class describes a feature that should be used within the labeling engine...
double mPriority
Priority of the label.
QVector< QgsPalLayerSettings::PredefinedPointPosition > predefinedPositionOrder() const
Returns the priority ordered list of predefined positions for label candidates.
void setHasFixedAngle(bool enabled)
Set whether the label should use a fixed angle instead of using angle from automatic placement...
void setRepeatDistance(double dist)
Applies only to linestring features - set after what distance (in map units) the labels should be rep...
VisualMargin(double top, double right, double bottom, double left)
Constructor allowing margins to be specified.
double right
Right margin.
QgsPoint mPositionOffset
offset of label from the feature (only for "offset from point" placement)
double distLabel() const
Applies to "around point" placement strategy or linestring features.
VisualMargin mVisualMargin
Visual margin of label contents.
void setHasFixedQuadrant(bool enabled)
Sets whether the quadrant for the label must be respected.
qint64 QgsFeatureId
Definition: qgsfeature.h:31
pal::Layer * mLayer
Pointer to PAL layer (assigned when registered to PAL)
void setPositionOffset(const QgsPoint &offset)
Applies only to "offset from point" placement strategy.
bool hasFixedAngle() const
Whether the label should use a fixed angle instead of using angle from automatic placement.
double mDistLabel
distance of label from the feature (only for "around point" placement or linestrings) ...
double mZIndex
Z-index of label (higher z-index labels are rendered on top of lower z-index labels) ...
QString labelText() const
Text of the label.
double fixedAngle() const
Angle in degrees of the fixed angle (relevant only if hasFixedAngle() returns true) ...
QgsPalLayerSettings::OffsetType mOffsetType
Offset type for certain placement modes.
void setQuadOffset(QPointF quadOffset)
Set which side of the point to use.
void setPriority(double priority)
Sets the priority for labeling the feature.
QgsFeatureId id() const
Identifier of the label (unique within the parent label provider)
QPointF mQuadOffset
whether the side of the label is fixed (only for "around point" placement)