34 for (
const auto &subprovider : std::as_const(
mSubProviders ) )
36 subprovider.second->setEngine(
mEngine );
47 return std::get< 1 >(
mRules->rootRule()->registerFeature( feature, context,
mSubProviders, obstacleGeometry, symbol ) );
52 QList<QgsAbstractLabelProvider *> lst;
53 for (
const auto &subprovider : std::as_const(
mSubProviders ) )
55 lst << subprovider.second;
64 : mSettings( settings )
65 , mMaximumScale( scaleMinDenom )
66 , mMinimumScale( scaleMaxDenom )
67 , mFilterExp( filterExp )
68 , mDescription( description )
69 , mElseRule( elseRule )
72 mFilterExp = QStringLiteral(
"ELSE" );
79 qDeleteAll( mChildren );
94 for (
Rule *
c : mChildren )
97 l +=
c->descendants();
102void QgsRuleBasedLabeling::Rule::initFilter()
104 if ( mFilterExp.trimmed().compare( QLatin1String(
"ELSE" ), Qt::CaseInsensitive ) == 0 )
109 else if ( mFilterExp.trimmed().isEmpty() )
117 mFilter = std::make_unique< QgsExpression >( mFilterExp );
121void QgsRuleBasedLabeling::Rule::updateElseRules()
124 for ( Rule *rule : std::as_const( mChildren ) )
126 if ( rule->isElse() )
133 if ( mSettings && mSettings->format().containsAdvancedEffects() )
136 for (
Rule *rule : std::as_const( mChildren ) )
138 if ( rule->requiresAdvancedEffects() )
158 if ( !mChildren.empty() )
160 for (
const Rule *rule : mChildren )
162 if ( !rule->accept( visitor ) )
175 for (
const Rule *rule : std::as_const( mChildren ) )
177 if ( rule->settings() )
178 list << rule->ruleKey();
180 rule->subProviderIds( list );
187 mChildren.append( rule );
188 rule->mParent =
this;
194 mChildren.insert( i, rule );
195 rule->mParent =
this;
201 delete mChildren.at( i );
202 mChildren.removeAt( i );
210 if ( key == mRuleKey )
213 for (
Rule *rule : mChildren )
224 if ( key == mRuleKey )
227 for (
Rule *rule : std::as_const( mChildren ) )
239 Rule *newrule =
new Rule( s, mMaximumScale, mMinimumScale, mFilterExp, mDescription );
245 for (
Rule *rule : mChildren )
246 newrule->
appendChild( rule->clone( resetRuleKey ) );
254 QDomElement settingsElem = ruleElem.firstChildElement( QStringLiteral(
"settings" ) );
255 if ( !settingsElem.isNull() )
261 QString filterExp = ruleElem.attribute( QStringLiteral(
"filter" ) );
262 QString description = ruleElem.attribute( QStringLiteral(
"description" ) );
263 int scaleMinDenom = ruleElem.attribute( QStringLiteral(
"scalemindenom" ), QStringLiteral(
"0" ) ).toInt();
264 int scaleMaxDenom = ruleElem.attribute( QStringLiteral(
"scalemaxdenom" ), QStringLiteral(
"0" ) ).toInt();
267 ruleKey = ruleElem.attribute( QStringLiteral(
"key" ) );
269 ruleKey = QUuid::createUuid().toString();
270 Rule *rule =
new Rule(
settings, scaleMinDenom, scaleMaxDenom, filterExp, description );
272 if ( !ruleKey.isEmpty() )
273 rule->mRuleKey = ruleKey;
275 rule->
setActive( ruleElem.attribute( QStringLiteral(
"active" ), QStringLiteral(
"1" ) ).toInt() );
277 QDomElement childRuleElem = ruleElem.firstChildElement( QStringLiteral(
"rule" ) );
278 while ( !childRuleElem.isNull() )
280 Rule *childRule =
create( childRuleElem, context );
289 childRuleElem = childRuleElem.nextSiblingElement( QStringLiteral(
"rule" ) );
297 QDomElement ruleElem = doc.createElement( QStringLiteral(
"rule" ) );
301 ruleElem.
appendChild( mSettings->writeXml( doc, context ) );
303 if ( !mFilterExp.isEmpty() )
304 ruleElem.setAttribute( QStringLiteral(
"filter" ), mFilterExp );
306 ruleElem.setAttribute( QStringLiteral(
"scalemindenom" ), mMaximumScale );
308 ruleElem.setAttribute( QStringLiteral(
"scalemaxdenom" ), mMinimumScale );
309 if ( !mDescription.isEmpty() )
310 ruleElem.setAttribute( QStringLiteral(
"description" ), mDescription );
312 ruleElem.setAttribute( QStringLiteral(
"active" ), 0 );
313 ruleElem.setAttribute( QStringLiteral(
"key" ), mRuleKey );
315 for ( RuleList::const_iterator it = mChildren.constBegin(); it != mChildren.constEnd(); ++it )
330 [
this](
const std::pair<QgsRuleBasedLabeling::Rule *, QgsVectorLayerLabelProvider *> &item )
332 return item.first == this;
345 for (
Rule *rule : std::as_const( mChildren ) )
356 [
this](
const std::pair<QgsRuleBasedLabeling::Rule *, QgsVectorLayerLabelProvider *> &item )
358 return item.first == this;
364 if ( !p->
prepare( context, attributeNames ) )
374 attributeNames.unite( mFilter->referencedColumns() );
379 for (
Rule *rule : std::as_const( mChildren ) )
387 QList< QgsLabelFeature * > labels;
388 if ( !isFilterOK( feature, context )
391 return { Filtered, labels };
394 bool registered =
false;
398 [
this](
const std::pair<QgsRuleBasedLabeling::Rule *, QgsVectorLayerLabelProvider *> &item )
400 return item.first == this;
405 labels.append( it->second->registerFeature( feature, context, obstacleGeometry, symbol ) );
409 bool matchedAChild =
false;
412 for (
Rule *rule : std::as_const( mChildren ) )
415 if ( !rule->isElse() )
418 QList< QgsLabelFeature * > added;
419 std::tie( res, added ) = rule->registerFeature( feature, context,
subProviders, obstacleGeometry );
420 labels.append( added );
422 matchedAChild |= ( res == Registered || res == Inactive );
423 registered |= matchedAChild;
428 if ( !matchedAChild )
430 for (
Rule *rule : std::as_const( mElseRules ) )
433 QList< QgsLabelFeature * > added;
434 std::tie( res, added ) = rule->registerFeature( feature, context,
subProviders, obstacleGeometry, symbol ) ;
435 matchedAChild |= ( res == Registered || res == Inactive );
436 registered |= res != Filtered;
437 labels.append( added );
441 if ( !mIsActive || ( matchedAChild && !registered ) )
442 return { Inactive, labels };
443 else if ( registered )
444 return { Registered, labels };
446 return { Filtered, labels };
451 if ( ! mFilter || mElseRule )
459bool QgsRuleBasedLabeling::Rule::isScaleOK(
double scale )
const
492 Q_ASSERT( origDescendants.count() == clonedDescendants.count() );
493 for (
int i = 0; i < origDescendants.count(); ++i )
494 clonedDescendants[i]->setRuleKey( origDescendants[i]->ruleKey() );
516 QDomElement rulesElem = element.firstChildElement( QStringLiteral(
"rules" ) );
528 return QStringLiteral(
"rule-based" );
533 QDomElement elem = doc.createElement( QStringLiteral(
"labeling" ) );
534 elem.setAttribute( QStringLiteral(
"type" ), QStringLiteral(
"rule-based" ) );
536 QDomElement rulesElem =
mRootRule->save( doc, context );
537 rulesElem.setTagName( QStringLiteral(
"rules" ) );
538 elem.appendChild( rulesElem );
571 return mRootRule->requiresAdvancedEffects();
592 for (
Rule *rule : rules )
598 QDomDocument doc = parent.ownerDocument();
600 QDomElement ruleElement = doc.createElement( QStringLiteral(
"se:Rule" ) );
601 parent.appendChild( ruleElement );
603 if ( !rule->filterExpression().isEmpty() )
610 QVariantMap localProps = QVariantMap( props );
633 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 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.
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.
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.
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...
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
void toSld(QDomNode &parent, const QVariantMap &props) 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 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.
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 bool createFunctionElement(QDomDocument &doc, QDomElement &element, const QString &function)
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.
The QgsVectorLayerLabelProvider class 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 data sets.
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.