16 #ifndef QGSLABELINGENGINEV2_H 17 #define QGSLABELINGENGINEV2_H 21 #include "qgis_core.h" 58 DrawAllLabels = 1 << 2,
59 MergeConnectedLines = 1 << 3,
60 CentroidMustBeInside = 1 << 4,
61 LabelPerFeaturePart = 1 << 6,
63 Q_DECLARE_FLAGS( Flags,
Flag )
66 virtual QList<QgsLabelFeature *> labelFeatures(
QgsRenderContext &context ) = 0;
72 virtual QList<QgsAbstractLabelProvider *>
subProviders() {
return QList<QgsAbstractLabelProvider *>(); }
75 QString
name()
const {
return mName; }
78 QString
layerId()
const {
return mLayerId; }
91 Flags
flags()
const {
return mFlags; }
134 Q_DECLARE_OPERATORS_FOR_FLAGS( QgsAbstractLabelProvider::Flags )
176 ~QgsLabelingEngine();
179 QgsLabelingEngine(
const QgsLabelingEngine &rh ) =
delete;
181 QgsLabelingEngine &operator=(
const QgsLabelingEngine &rh ) =
delete;
195 QList< QgsMapLayer * > participatingLayers()
const;
248 static QString encodePredefinedPositionOrder(
const QVector< QgsPalLayerSettings::PredefinedPointPosition > &positions );
256 static QVector< QgsPalLayerSettings::PredefinedPointPosition > decodePredefinedPositionOrder(
const QString &positionString );
260 #endif // QGSLABELINGENGINEV2_H Base class for all map layer types.
QgsWeakMapLayerPointer mLayer
Weak pointer to source layer.
QgsPalLayerSettings::Placement mPlacement
Placement strategy.
QList< QgsAbstractLabelProvider * > mProviders
List of providers (the are owned by the labeling engine)
double mPriority
Default priority of labels.
Contains helper utilities for working with QGIS' labeling engine.
QgsPalLayerSettings::ObstacleType obstacleType() const
How the feature geometries will work as obstacles.
QList< QgsAbstractLabelProvider * > mSubProviders
void setMapSettings(const QgsMapSettings &mapSettings)
Associate map settings instance.
QPointer< QgsMapLayer > QgsWeakMapLayerPointer
Weak pointer for QgsMapLayer.
The QgsMapSettings class contains configuration for rendering of the map.
QgsMapLayer * layer() const
Returns the associated layer, or nullptr if no layer is associated with the provider.
unsigned int linePlacementFlags() const
For layers with linestring geometries - extra placement flags (or-ed combination of QgsPalLayerSettin...
const QgsLabelingEngineSettings & engineSettings() const
Get associated labeling engine settings.
unsigned int mLinePlacementFlags
Extra placement flags for linestring geometries.
Flags mFlags
Flags altering drawing and registration of features.
QgsPalLayerSettings::Placement placement() const
What placement strategy to use for the labels.
The QgsAbstractLabelProvider class is an interface class.
QString layerId() const
Returns ID of associated layer, or empty string if no layer is associated with the provider...
QgsPalLayerSettings::UpsideDownLabels upsidedownLabels() const
How to handle labels that would be upside down.
Flags flags() const
Flags associated with the provider.
Placement
Placement modes which determine how label candidates are generated for a feature. ...
The QgsLabelingEngine class provides map labeling functionality.
virtual QList< QgsAbstractLabelProvider * > subProviders()
Return list of child providers - useful if the provider needs to put labels into more layers with dif...
Contains information about the context of a rendering operation.
QString name() const
Name of the layer (for statistics, debugging etc.) - does not need to be unique.
std::unique_ptr< QgsLabelingResults > mResults
Resulting labeling layout.
QString mName
Name of the layer.
QgsMapSettings mMapSettings
Associated map settings instance.
Stores global configuration for labeling engine.
const QgsMapSettings & mapSettings() const
Get associated map settings.
double priority() const
Default priority of labels (may be overridden by individual labels)
QgsLabelingResults * results() const
For internal use by the providers.
QString mProviderId
Associated provider ID (one layer may have multiple providers, e.g. in rule-based labeling) ...
LabelPosition is a candidate feature label position.
QgsPalLayerSettings::ObstacleType mObstacleType
Type of the obstacle of feature geometries.
QgsPalLayerSettings::UpsideDownLabels mUpsidedownLabels
How to handle labels that would be upside down.
QString providerId() const
Returns provider ID - useful in case there is more than one label provider within a layer (e...
Class that stores computed placement from labeling engine.
QString mLayerId
Associated layer's ID, if applicable.
void setEngine(const QgsLabelingEngine *engine)
Associate provider with a labeling engine (should be only called internally from QgsLabelingEngine) ...
ObstacleType
Valid obstacle types, which affect how features within the layer will act as obstacles for labels...