15#ifndef QGSRULEBASEDLABELING_H
16#define QGSRULEBASEDLABELING_H
45 typedef QList<QgsRuleBasedLabeling::Rule *>
RuleList;
46 typedef QMap<QgsRuleBasedLabeling::Rule *, QgsVectorLayerLabelProvider *>
RuleToProviderMap;
57 Rule(
QgsPalLayerSettings *settings
SIP_TRANSFER,
double maximumScale = 0,
double minimumScale = 0,
const QString &filterExp = QString(),
const QString &description = QString(),
bool elseRule =
false );
121 bool active()
const {
return mIsActive; }
128 bool isElse()
const {
return mElseRule; }
166 void setDescription(
const QString &description ) { mDescription = description; }
228 void removeChildAt(
int i );
272 void subProviderIds( QStringList &list ) const
SIP_SKIP;
295 bool requiresAdvancedEffects() const;
329 bool isScaleOK(
double scale )
const;
339 void updateElseRules();
342 Rule *mParent =
nullptr;
343 std::unique_ptr<QgsPalLayerSettings> mSettings;
344 double mMaximumScale = 0;
345 double mMinimumScale = 0;
347 QString mDescription;
348 bool mElseRule =
false;
351 bool mIsActive =
true;
353 QString mRuleKey = QUuid::createUuid().toString();
355 std::unique_ptr<QgsExpression> mFilter;
365 const Rule *rootRule() const
SIP_SKIP;
372 QString type() const override;
377 QStringList subProviders() const override;
389 bool requiresAdvancedEffects() const override;
390 void toSld( QDomNode &parent, const QVariantMap &props ) const override;
391 void multiplyOpacity(
double opacityFactor ) override;
395 std::unique_ptr<
Rule> mRootRule;
416 bool prepare(
QgsRenderContext &context, QSet<QString> &attributeNames )
override;
424 QList<QgsAbstractLabelProvider *>
subProviders()
override;
428 std::unique_ptr<QgsRuleBasedLabeling>
mRules;
Abstract base class - its implementations define different approaches to the labeling of a vector lay...
virtual QStringList subProviders() const
Gets list of sub-providers within the layer's labeling.
virtual void setSettings(QgsPalLayerSettings *settings, const QString &providerId=QString())=0
Set pal settings for a specific provider (takes ownership).
virtual QgsAbstractVectorLayerLabeling * clone() const =0
Returns a new copy of the object.
Class for parsing and evaluation of expressions (formerly called "search strings").
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
A geometry is the spatial representation of a feature.
The QgsLabelFeature class describes a feature that should be used within the labeling engine.
Contains settings for how a map layer will be labeled.
The class is used as a container of context for various read/write operations on other objects.
Contains information about the context of a rendering operation.
Label provider for rule based labeling.
std::unique_ptr< QgsRuleBasedLabeling > mRules
owned copy
QgsRuleBasedLabeling::RuleToProviderMap mSubProviders
label providers are owned by labeling engine
A child rule for QgsRuleBasedLabeling.
QgsRuleBasedLabeling::RuleList & children()
Returns all children rules of this rule.
void setRuleKey(const QString &key)
Override the assigned rule key (should be used just internally by rule-based labeling)
void setMaximumScale(double scale)
Sets the maximum map scale (i.e.
Rule(const Rule &rh)=delete
Rules cannot be copied.
double maximumScale() const
Returns the maximum map scale (i.e.
void setDescription(const QString &description)
Set a human readable description for this rule.
bool dependsOnScale() const
Determines if scale based labeling is active.
const QgsRuleBasedLabeling::RuleList & children() const
Returns all children rules of this rule.
QString filterExpression() const
A filter that will check if this rule applies.
QgsRuleBasedLabeling::Rule * parent()
The parent rule.
const QgsRuleBasedLabeling::Rule * parent() const
The parent rule.
bool active() const
Returns if this rule is active.
QgsPalLayerSettings * settings() const
Returns the labeling settings.
RegisterResult
The result of registering a rule.
@ Inactive
The rule is inactive.
void setActive(bool state)
Sets if this rule is active.
bool isElse() const
Check if this rule is an ELSE rule.
void setMinimumScale(double scale)
Sets the minimum map scale (i.e.
Rule & operator=(const Rule &rh)=delete
Rules cannot be copied.
void setFilterExpression(const QString &filterExp)
Set the expression used to check if a given feature shall be rendered with this rule.
double minimumScale() const
Returns the minimum map scale (i.e.
void setIsElse(bool iselse)
Sets if this rule is an ELSE rule.
QString ruleKey() const
Unique rule identifier (for identification of rule within labeling, used as provider ID)
QString description() const
A human readable description for this rule.
Rule based labeling for a vector layer.
QList< QgsRuleBasedLabeling::Rule * > RuleList
QMap< QgsRuleBasedLabeling::Rule *, QgsVectorLayerLabelProvider * > RuleToProviderMap
An interface for classes which can visit style entity (e.g.
Abstract base class for all rendered symbols.
The QgsVectorLayerLabelProvider class implements a label provider for vector layers.
Represents a vector layer which manages a vector based data sets.
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)