35 for (
const auto &subprovider : std::as_const(
mSubProviders ) )
37 subprovider.second->setEngine(
mEngine );
48 return std::get< 1 >(
mRules->rootRule()->registerFeature( feature, context,
mSubProviders, obstacleGeometry, symbol ) );
53 QList<QgsAbstractLabelProvider *> lst;
54 for (
const auto &subprovider : std::as_const(
mSubProviders ) )
56 lst << subprovider.second;
65 : mSettings( settings )
66 , mMaximumScale( scaleMinDenom )
67 , mMinimumScale( scaleMaxDenom )
68 , mFilterExp( filterExp )
69 , mDescription( description )
70 , mElseRule( elseRule )
73 mFilterExp = QStringLiteral(
"ELSE" );
80 qDeleteAll( mChildren );
95 for (
Rule *
c : mChildren )
98 l +=
c->descendants();
103void QgsRuleBasedLabeling::Rule::initFilter()
105 if ( mFilterExp.trimmed().compare( QLatin1String(
"ELSE" ), Qt::CaseInsensitive ) == 0 )
110 else if ( mFilterExp.trimmed().isEmpty() )
118 mFilter = std::make_unique< QgsExpression >( mFilterExp );
122void QgsRuleBasedLabeling::Rule::updateElseRules()
125 for ( Rule *rule : std::as_const( mChildren ) )
127 if ( rule->isElse() )
134 if ( mSettings && mSettings->format().containsAdvancedEffects() )
137 for (
Rule *rule : std::as_const( mChildren ) )
139 if ( rule->requiresAdvancedEffects() )
153 || mSettings->format().hasNonDefaultCompositionMode() ) )
156 for (
Rule *rule : std::as_const( mChildren ) )
158 if ( rule->hasNonDefaultCompositionMode() )
178 if ( !mChildren.empty() )
180 for (
const Rule *rule : mChildren )
182 if ( !rule->accept( visitor ) )
195 for (
const Rule *rule : std::as_const( mChildren ) )
197 if ( rule->settings() )
198 list << rule->ruleKey();
200 rule->subProviderIds( list );
207 mChildren.append( rule );
208 rule->mParent =
this;
214 mChildren.insert( i, rule );
215 rule->mParent =
this;
221 delete mChildren.at( i );
222 mChildren.removeAt( i );
230 if ( key == mRuleKey )
233 for (
Rule *rule : mChildren )
244 if ( key == mRuleKey )
247 for (
Rule *rule : std::as_const( mChildren ) )
259 Rule *newrule =
new Rule( s, mMaximumScale, mMinimumScale, mFilterExp, mDescription );
265 for (
Rule *rule : mChildren )
266 newrule->
appendChild( rule->clone( resetRuleKey ) );
274 QDomElement settingsElem = ruleElem.firstChildElement( QStringLiteral(
"settings" ) );
275 if ( !settingsElem.isNull() )
281 QString filterExp = ruleElem.attribute( QStringLiteral(
"filter" ) );
282 QString description = ruleElem.attribute( QStringLiteral(
"description" ) );
283 int scaleMinDenom = ruleElem.attribute( QStringLiteral(
"scalemindenom" ), QStringLiteral(
"0" ) ).toInt();
284 int scaleMaxDenom = ruleElem.attribute( QStringLiteral(
"scalemaxdenom" ), QStringLiteral(
"0" ) ).toInt();
287 ruleKey = ruleElem.attribute( QStringLiteral(
"key" ) );
289 ruleKey = QUuid::createUuid().toString();
290 Rule *rule =
new Rule(
settings, scaleMinDenom, scaleMaxDenom, filterExp, description );
292 if ( !ruleKey.isEmpty() )
293 rule->mRuleKey = ruleKey;
295 rule->
setActive( ruleElem.attribute( QStringLiteral(
"active" ), QStringLiteral(
"1" ) ).toInt() );
297 QDomElement childRuleElem = ruleElem.firstChildElement( QStringLiteral(
"rule" ) );
298 while ( !childRuleElem.isNull() )
300 Rule *childRule =
create( childRuleElem, context );
309 childRuleElem = childRuleElem.nextSiblingElement( QStringLiteral(
"rule" ) );
317 QDomElement ruleElem = doc.createElement( QStringLiteral(
"rule" ) );
321 ruleElem.
appendChild( mSettings->writeXml( doc, context ) );
323 if ( !mFilterExp.isEmpty() )
324 ruleElem.setAttribute( QStringLiteral(
"filter" ), mFilterExp );
326 ruleElem.setAttribute( QStringLiteral(
"scalemindenom" ), mMaximumScale );
328 ruleElem.setAttribute( QStringLiteral(
"scalemaxdenom" ), mMinimumScale );
329 if ( !mDescription.isEmpty() )
330 ruleElem.setAttribute( QStringLiteral(
"description" ), mDescription );
332 ruleElem.setAttribute( QStringLiteral(
"active" ), 0 );
333 ruleElem.setAttribute( QStringLiteral(
"key" ), mRuleKey );
335 for ( RuleList::const_iterator it = mChildren.constBegin(); it != mChildren.constEnd(); ++it )
350 [
this](
const std::pair<QgsRuleBasedLabeling::Rule *, QgsVectorLayerLabelProvider *> &item )
352 return item.first == this;
365 for (
Rule *rule : std::as_const( mChildren ) )
376 [
this](
const std::pair<QgsRuleBasedLabeling::Rule *, QgsVectorLayerLabelProvider *> &item )
378 return item.first == this;
384 if ( !p->
prepare( context, attributeNames ) )
394 attributeNames.unite( mFilter->referencedColumns() );
399 for (
Rule *rule : std::as_const( mChildren ) )
407 QList< QgsLabelFeature * > labels;
408 if ( !isFilterOK( feature, context )
411 return { Filtered, labels };
414 bool registered =
false;
418 [
this](
const std::pair<QgsRuleBasedLabeling::Rule *, QgsVectorLayerLabelProvider *> &item )
420 return item.first == this;
425 labels.append( it->second->registerFeature( feature, context, obstacleGeometry, symbol ) );
429 bool matchedAChild =
false;
432 for (
Rule *rule : std::as_const( mChildren ) )
435 if ( !rule->isElse() )
438 QList< QgsLabelFeature * > added;
439 std::tie( res, added ) = rule->registerFeature( feature, context,
subProviders, obstacleGeometry );
440 labels.append( added );
442 matchedAChild |= ( res == Registered || res == Inactive );
443 registered |= matchedAChild;
448 if ( !matchedAChild )
450 for (
Rule *rule : std::as_const( mElseRules ) )
453 QList< QgsLabelFeature * > added;
454 std::tie( res, added ) = rule->registerFeature( feature, context,
subProviders, obstacleGeometry, symbol ) ;
455 matchedAChild |= ( res == Registered || res == Inactive );
456 registered |= res != Filtered;
457 labels.append( added );
461 if ( !mIsActive || ( matchedAChild && !registered ) )
462 return { Inactive, labels };
463 else if ( registered )
464 return { Registered, labels };
466 return { Filtered, labels };
471 if ( ! mFilter || mElseRule )
479bool QgsRuleBasedLabeling::Rule::isScaleOK(
double scale )
const
512 Q_ASSERT( origDescendants.count() == clonedDescendants.count() );
513 for (
int i = 0; i < origDescendants.count(); ++i )
514 clonedDescendants[i]->setRuleKey( origDescendants[i]->ruleKey() );
536 QDomElement rulesElem = element.firstChildElement( QStringLiteral(
"rules" ) );
548 return QStringLiteral(
"rule-based" );
553 QDomElement elem = doc.createElement( QStringLiteral(
"labeling" ) );
554 elem.setAttribute( QStringLiteral(
"type" ), QStringLiteral(
"rule-based" ) );
556 QDomElement rulesElem =
mRootRule->save( doc, context );
557 rulesElem.setTagName( QStringLiteral(
"rules" ) );
558 elem.appendChild( rulesElem );
591 return mRootRule->requiresAdvancedEffects();
596 return mRootRule->hasNonDefaultCompositionMode();
613 toSld( parent, context );
624 for (
Rule *rule : rules )
630 QDomDocument doc = parent.ownerDocument();
632 QDomElement ruleElement = doc.createElement( QStringLiteral(
"se:Rule" ) );
633 parent.appendChild( ruleElement );
635 if ( !rule->filterExpression().isEmpty() )
643 QVariantMap localProps = oldProps;
666 for (
Rule *rule : rules )
const QgsLabelingEngine * mEngine
Associated labeling engine.
QgsMapLayer * layer() const
Returns the associated layer, or nullptr if no layer is associated with the provider.
QString providerId() const
Returns provider ID - useful in case there is more than one label provider within a layer (e....
virtual Q_DECL_DEPRECATED void writeTextSymbolizer(QDomNode &parent, QgsPalLayerSettings &settings, const QVariantMap &props) const
Writes a TextSymbolizer element contents based on the provided labeling settings.
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the context.
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.
Contains settings for how a map layer will be labeled.
void setFormat(const QgsTextFormat &format)
Sets the label text formatting settings, e.g., font settings, buffer settings, etc.
bool drawLabels
Whether to draw labels for this layer.
double minimumScale
The minimum map scale (i.e.
void readXml(const QDomElement &elem, const QgsReadWriteContext &context)
Read settings from a DOM element.
bool scaleVisibility
Set to true to limit label visibility to a range of scales.
@ FontBlendMode
Text blend mode.
const QgsTextFormat & format() const
Returns the label text formatting settings, e.g., font settings, buffer settings, etc.
double maximumScale
The maximum map scale (i.e.
A container for the context for various read/write operations on objects.
Contains information about the context of a rendering operation.
double rendererScale() const
Returns the renderer map scale.
QgsExpressionContext & expressionContext()
Gets the expression context.
Label provider for rule based labeling.
bool prepare(QgsRenderContext &context, QSet< QString > &attributeNames) override
Prepare for registration of features.
std::unique_ptr< QgsRuleBasedLabeling > mRules
owned copy
QList< QgsLabelFeature * > registerFeature(const QgsFeature &feature, QgsRenderContext &context, const QgsGeometry &obstacleGeometry=QgsGeometry(), const QgsSymbol *symbol=nullptr) override
Register a feature for labeling as one or more QgsLabelFeature objects stored into mLabels.
QgsRuleBasedLabelProvider(const QgsRuleBasedLabeling &rules, QgsVectorLayer *layer, bool withFeatureLoop=true)
std::vector< std::pair< QgsRuleBasedLabeling::Rule *, QgsVectorLayerLabelProvider * > > mSubProviders
label providers are owned by labeling engine
virtual QgsVectorLayerLabelProvider * createProvider(QgsVectorLayer *layer, const QString &providerId, bool withFeatureLoop, const QgsPalLayerSettings *settings)
create a label provider
QList< QgsAbstractLabelProvider * > subProviders() override
Returns subproviders.
A child rule for QgsRuleBasedLabeling.
void setRuleKey(const QString &key)
Override the assigned rule key (should be used just internally by rule-based labeling)
void createSubProviders(QgsVectorLayer *layer, RuleToProviderVec &subProviders, QgsRuleBasedLabelProvider *provider)
add providers
std::tuple< RegisterResult, QList< QgsLabelFeature * > > registerFeature(const QgsFeature &feature, QgsRenderContext &context, RuleToProviderVec &subProviders, const QgsGeometry &obstacleGeometry=QgsGeometry(), const QgsSymbol *symbol=nullptr)
Register individual features.
void prepare(QgsRenderContext &context, QSet< QString > &attributeNames, RuleToProviderVec &subProviders)
call prepare() on sub-providers and populate attributeNames
QgsPalLayerSettings * settings() const
Returns the labeling settings.
RegisterResult
The result of registering a rule.
bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified symbology visitor, causing it to visit all child rules associated with the rule...
bool hasNonDefaultCompositionMode() const
Returns true if this rule or any of its children requires a non-default composition mode.
void subProviderIds(QStringList &list) const
append rule keys of descendants that contain valid settings (i.e.
bool requiresAdvancedEffects() const
Returns true if this rule or any of its children requires advanced composition effects to render.
void removeChildAt(int i)
delete child rule
void setActive(bool state)
Sets if this rule is active.
static QgsRuleBasedLabeling::Rule * create(const QDomElement &ruleElem, const QgsReadWriteContext &context, bool reuseId=true)
Create a rule from an XML definition.
QDomElement save(QDomDocument &doc, const QgsReadWriteContext &context) const
store labeling info to XML element
void setSettings(QgsPalLayerSettings *settings)
Sets new settings (or nullptr). Deletes old settings if any.
QgsRuleBasedLabeling::RuleList descendants() const
Returns all children, grand-children, grand-grand-children, grand-gra... you get it.
Rule(QgsPalLayerSettings *settings, double maximumScale=0, double minimumScale=0, const QString &filterExp=QString(), const QString &description=QString(), bool elseRule=false)
takes ownership of settings, settings may be nullptr
void insertChild(int i, QgsRuleBasedLabeling::Rule *rule)
add child rule, take ownership, sets this as parent
QgsRuleBasedLabeling::Rule * clone(bool resetRuleKey=true) const
clone this rule
const QgsRuleBasedLabeling::Rule * findRuleByKey(const QString &key) const
Try to find a rule given its unique key.
void appendChild(QgsRuleBasedLabeling::Rule *rule)
add child rule, take ownership, sets this as parent
Rule based labeling for a vector layer.
QList< QgsRuleBasedLabeling::Rule * > RuleList
std::unique_ptr< Rule > mRootRule
Q_DECL_DEPRECATED void toSld(QDomNode &parent, const QVariantMap &properties) const override
Writes the SE 1.1 TextSymbolizer element based on the current layer labeling settings.
QStringList subProviders() const override
Gets list of sub-providers within the layer's labeling.
QgsRuleBasedLabeling(QgsRuleBasedLabeling::Rule *root)
Constructs the labeling from given tree of rules (takes ownership)
QgsVectorLayerLabelProvider * provider(QgsVectorLayer *layer) const override
static QgsRuleBasedLabeling * create(const QDomElement &element, const QgsReadWriteContext &context)
Create the instance from a DOM element with saved configuration.
void setSettings(QgsPalLayerSettings *settings, const QString &providerId=QString()) override
Set pal settings for a specific provider (takes ownership).
~QgsRuleBasedLabeling() override
QgsPalLayerSettings settings(const QString &providerId=QString()) const override
Gets associated label settings.
QString type() const override
Unique type string of the labeling configuration implementation.
QgsRuleBasedLabeling * clone() const override
Returns a new copy of the object.
void multiplyOpacity(double opacityFactor) override
Multiply opacity by opacityFactor.
QgsRuleBasedLabeling::Rule * rootRule()
bool accept(QgsStyleEntityVisitorInterface *visitor) const override
Accepts the specified symbology visitor, causing it to visit all symbols associated with the labeling...
QDomElement save(QDomDocument &doc, const QgsReadWriteContext &context) const override
Returns labeling configuration as XML element.
bool hasNonDefaultCompositionMode() const override
Returns true the labeling requires a non-default composition mode.
bool requiresAdvancedEffects() const override
Returns true if drawing labels requires advanced effects like composition modes, which could prevent ...
static bool equalToOrGreaterThanMinimumScale(const double scale, const double minScale)
Returns whether the scale is equal to or greater than the minScale, taking non-round numbers into acc...
static bool lessThanMaximumScale(const double scale, const double maxScale)
Returns whether the scale is less than the maxScale, taking non-round numbers into account.
Holds SLD export options and other information related to SLD export of a QGIS layer style.
void setExtraProperties(const QVariantMap &properties)
Sets the open ended set of properties that can drive/inform the SLD encoding.
QVariantMap extraProperties() const
Returns the open ended set of properties that can drive/inform the SLD encoding.
An interface for classes which can visit style entity (e.g.
@ SymbolRule
Rule based symbology or label child rule.
virtual bool visitExit(const QgsStyleEntityVisitorInterface::Node &node)
Called when the visitor stops visiting a node.
virtual bool visitEnter(const QgsStyleEntityVisitorInterface::Node &node)
Called when the visitor starts visiting a node.
virtual bool visit(const QgsStyleEntityVisitorInterface::StyleLeaf &entity)
Called when the visitor will visit a style entity.
A label settings entity for QgsStyle databases.
static void applyScaleDependency(QDomDocument &doc, QDomElement &ruleElem, QVariantMap &props)
Checks if the properties contain scaleMinDenom and scaleMaxDenom, if available, they are added into t...
static Q_DECL_DEPRECATED bool createFunctionElement(QDomDocument &doc, QDomElement &element, const QString &function)
Creates an OGC function element.
static void mergeScaleDependencies(double mScaleMinDenom, double mScaleMaxDenom, QVariantMap &props)
Merges the local scale limits, if any, with the ones already in the map, if any.
Abstract base class for all rendered symbols.
Container for all settings relating to text rendering.
void multiplyOpacity(double opacityFactor)
Multiply opacity by opacityFactor.
Implements a label provider for vector layers.
virtual bool prepare(QgsRenderContext &context, QSet< QString > &attributeNames)
Prepare for registration of features.
const QgsPalLayerSettings & settings() const
Returns the layer's settings.
Represents a vector layer which manages a vector based dataset.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
Contains information relating to a node (i.e.
Contains information relating to the style entity currently being visited.