37#include <QDomDocument>
43using namespace Qt::StringLiterals;
47 , mMaximumScale( scaleMinDenom )
48 , mMinimumScale( scaleMaxDenom )
49 , mFilterExp( filterExp )
52 , mElseRule( elseRule )
55 mFilterExp = u
"ELSE"_s;
57 mRuleKey = QUuid::createUuid().toString();
63 qDeleteAll( mChildren );
69 if ( mFilterExp.trimmed().compare(
"ELSE"_L1, Qt::CaseInsensitive ) == 0 )
74 else if ( mFilterExp.trimmed().isEmpty() )
82 mFilter = std::make_unique< QgsExpression >( mFilterExp );
88 mChildren.append( rule );
95 mChildren.insert( i, rule );
102 mChildren.removeAll( rule );
109 delete mChildren.takeAt( i );
115 mChildren.removeAll( rule );
116 rule->mParent =
nullptr;
123 Rule *rule = mChildren.takeAt( i );
124 rule->mParent =
nullptr;
133 if ( key == mRuleKey )
136 const auto constMChildren = mChildren;
137 for (
Rule *rule : constMChildren )
139 Rule *r = rule->findRuleByKey( key );
146void QgsRuleBasedRenderer::Rule::updateElseRules()
149 const auto constMChildren = mChildren;
150 for (
Rule *rule : constMChildren )
152 if ( rule->isElse() )
159 mFilterExp = u
"ELSE"_s;
177 if ( !mChildren.empty() )
179 for (
const Rule *rule : mChildren )
181 if ( !rule->accept( visitor ) )
195 off.fill( QChar(
' ' ), indent );
196 QString symbolDump = ( mSymbol ? mSymbol->dump() : u
"[]"_s );
197 QString msg = off + u
"RULE %1 - scale [%2,%3] - filter %4 - symbol %5\n"_s.arg( mLabel ).arg( mMaximumScale ).arg( mMinimumScale ).arg( mFilterExp, symbolDump );
200 const auto constMChildren = mChildren;
201 for (
Rule *rule : constMChildren )
203 lst.append( rule->dump( indent + 2 ) );
205 msg += lst.join( QLatin1Char(
'\n' ) );
214 attrs.unite( mFilter->referencedColumns() );
216 attrs.unite( mSymbol->usedAttributes( context ) );
219 const auto constMChildren = mChildren;
220 for (
Rule *rule : constMChildren )
222 attrs.unite( rule->usedAttributes( context ) );
229 if ( mFilter && mFilter->needsGeometry() )
232 const auto constMChildren = mChildren;
233 for (
Rule *rule : constMChildren )
235 if ( rule->needsGeometry() )
246 lst.append( mSymbol.get() );
248 const auto constMChildren = mChildren;
249 for (
Rule *rule : constMChildren )
251 lst += rule->symbols( context );
258 mSymbol.reset( sym );
263 mFilterExp = filterExp;
270 if ( currentLevel != -1 )
272 lst <<
QgsLegendSymbolItem( mSymbol.get(), mLabel, mRuleKey,
true, mMaximumScale, mMinimumScale, currentLevel, mParent ? mParent->mRuleKey : QString() );
275 for ( RuleList::const_iterator it = mChildren.constBegin(); it != mChildren.constEnd(); ++it )
286 if ( !mFilter || mElseRule || !context )
315 auto newrule = std::make_unique<Rule>( sym, mMaximumScale, mMinimumScale, mFilterExp, mLabel, mDescription );
316 newrule->setActive( mIsActive );
318 const auto constMChildren = mChildren;
319 for (
Rule *rule : constMChildren )
320 newrule->appendChild( rule->clone().release() );
326 QDomElement ruleElem = doc.createElement( u
"rule"_s );
330 int symbolIndex = symbolMap.size();
331 symbolMap[QString::number( symbolIndex )] = mSymbol.get();
332 ruleElem.setAttribute( u
"symbol"_s, symbolIndex );
334 if ( !mFilterExp.isEmpty() )
335 ruleElem.setAttribute( u
"filter"_s, mFilterExp );
336 if ( mMaximumScale != 0 )
337 ruleElem.setAttribute( u
"scalemindenom"_s, mMaximumScale );
338 if ( mMinimumScale != 0 )
339 ruleElem.setAttribute( u
"scalemaxdenom"_s, mMinimumScale );
340 if ( !mLabel.isEmpty() )
341 ruleElem.setAttribute( u
"label"_s, mLabel );
342 if ( !mDescription.isEmpty() )
343 ruleElem.setAttribute( u
"description"_s, mDescription );
345 ruleElem.setAttribute( u
"checkstate"_s, 0 );
346 ruleElem.setAttribute( u
"key"_s, mRuleKey );
348 const auto constMChildren = mChildren;
349 for (
Rule *rule : constMChildren )
351 ruleElem.appendChild( rule->save( doc, symbolMap ) );
360 toSld( doc, element, context );
367 if (
symbols( context ).isEmpty() )
371 QVariantMap props = oldProps;
372 if ( !mFilterExp.isEmpty() )
374 QString
filter = props.value( u
"filter"_s, QString() ).toString();
378 props[u
"filter"_s] =
filter;
386 QDomElement ruleElem = doc.createElement( u
"se:Rule"_s );
390 QDomElement nameElem = doc.createElement( u
"se:Name"_s );
391 nameElem.appendChild( doc.createTextNode( mLabel ) );
392 ruleElem.appendChild( nameElem );
394 if ( !mLabel.isEmpty() || !mDescription.isEmpty() )
396 QDomElement descrElem = doc.createElement( u
"se:Description"_s );
397 if ( !mLabel.isEmpty() )
399 QDomElement titleElem = doc.createElement( u
"se:Title"_s );
400 titleElem.appendChild( doc.createTextNode( mLabel ) );
401 descrElem.appendChild( titleElem );
403 if ( !mDescription.isEmpty() )
405 QDomElement abstractElem = doc.createElement( u
"se:Abstract"_s );
406 abstractElem.appendChild( doc.createTextNode( mDescription ) );
407 descrElem.appendChild( abstractElem );
409 ruleElem.appendChild( descrElem );
412 if ( !props.value( u
"filter"_s, QString() ).toString().isEmpty() )
420 mSymbol->toSld( doc, ruleElem, exportContext );
426 element.appendChild( ruleElem );
432 for (
Rule *rule : std::as_const( mChildren ) )
434 if ( !rule->toSld( doc, element, exportContext ) )
443 mActiveChildren.clear();
456 mSymbol->startRender( context, fields );
460 QStringList subfilters;
461 const auto constMChildren = mChildren;
462 for (
Rule *rule : constMChildren )
465 if ( rule->startRender( context, fields, subfilter ) )
468 mActiveChildren.append( rule );
469 subfilters.append( subfilter );
477 if ( subfilters.length() > 1 || !subfilters.value( 0 ).isEmpty() )
479 if ( subfilters.contains( u
"TRUE"_s ) )
492 else if ( subfilters.count() > 50 )
494 std::function<QString(
const QStringList & )> bt = [&bt](
const QStringList &subf ) {
495 if ( subf.count() == 1 )
499 else if ( subf.count() == 2 )
501 return subf.join(
") OR ("_L1 ).prepend(
'(' ).append(
')' );
505 int midpos =
static_cast<int>( subf.length() / 2 );
506 return u
"(%1) OR (%2)"_s.arg( bt( subf.mid( 0, midpos ) ), bt( subf.mid( midpos ) ) );
509 sf = bt( subfilters );
513 sf = subfilters.join(
") OR ("_L1 ).prepend(
'(' ).append(
')' );
525 if ( mSymbol || sf.isEmpty() )
532 else if ( !mFilterExp.trimmed().isEmpty() && !sf.isEmpty() )
533 filter = u
"(%1) AND (%2)"_s.arg( mFilterExp, sf );
534 else if ( !mFilterExp.trimmed().isEmpty() )
536 else if ( sf.isEmpty() )
548 return !mActiveChildren.empty();
553 QSet<int> symbolZLevelsSet;
559 for (
int i = 0; i < mSymbol->symbolLayerCount(); i++ )
561 symbolZLevelsSet.insert( mSymbol->symbolLayer( i )->renderingPass() );
566 QList<Rule *>::iterator it;
567 for ( it = mActiveChildren.begin(); it != mActiveChildren.end(); ++it )
572 return symbolZLevelsSet;
579 for (
int i = 0; i < mSymbol->symbolLayerCount(); i++ )
581 int normLevel = zLevelsToNormLevels.value( mSymbol->symbolLayer( i )->renderingPass() );
582 mSymbolNormZLevels.insert( normLevel );
587 const auto constMActiveChildren = mActiveChildren;
588 for (
Rule *rule : constMActiveChildren )
590 rule->setNormZLevels( zLevelsToNormLevels );
602 bool rendered =
false;
605 if ( mSymbol && mIsActive )
608 const auto constMSymbolNormZLevels = mSymbolNormZLevels;
609 for (
int normZLevel : constMSymbolNormZLevels )
612 renderQueue[normZLevel].jobs.append(
new RenderJob( featToRender, mSymbol.get() ) );
617 bool matchedAChild =
false;
620 const auto constMChildren = mChildren;
621 for (
Rule *rule : constMChildren )
624 if ( !rule->isElse() )
626 const RenderResult res = rule->renderFeature( featToRender, context, renderQueue );
634 if ( !matchedAChild )
636 const auto constMElseRules = mElseRules;
637 for (
Rule *rule : constMElseRules )
639 const RenderResult res = rule->renderFeature( featToRender, context, renderQueue );
644 if ( !mIsActive || ( mSymbol && !rendered ) || ( matchedAChild && !rendered ) )
660 const auto constMActiveChildren = mActiveChildren;
661 for (
Rule *rule : constMActiveChildren )
663 if ( rule->isElse() )
665 if ( rule->children().isEmpty() )
668 lst.removeOne( rule );
677 return rule->willRenderFeature( feature, context );
680 else if ( rule->willRenderFeature( feature, context ) )
694 lst.append( mSymbol.get() );
696 const auto constMActiveChildren = mActiveChildren;
697 for (
Rule *rule : constMActiveChildren )
699 lst += rule->symbolsForFeature( feature, context );
710 res.insert( mRuleKey );
713 bool matchedNonElseRule =
false;
714 for (
Rule *rule : std::as_const( mActiveChildren ) )
716 if ( rule->isElse() )
720 if ( rule->willRenderFeature( feature, context ) )
722 res.unite( rule->legendKeysForFeature( feature, context ) );
723 matchedNonElseRule =
true;
728 if ( !matchedNonElseRule )
730 for (
Rule *rule : std::as_const( mActiveChildren ) )
732 if ( rule->isElse() )
734 if ( rule->children().isEmpty() )
737 lst.removeOne( rule );
741 res.unite( rule->legendKeysForFeature( feature, context ) );
746 res.unite( rule->legendKeysForFeature( feature, context ) );
765 listChildren = mActiveChildren;
767 bool matchedNonElseRule =
false;
768 for (
Rule *rule : std::as_const( listChildren ) )
770 if ( rule->isElse() )
773 const RuleList childRules = rule->rulesForFeature( feature, context, onlyActive );
774 matchedNonElseRule |= !childRules.isEmpty();
778 if ( !matchedNonElseRule )
780 for (
Rule *rule : std::as_const( mElseRules ) )
782 if ( onlyActive && !mActiveChildren.contains( rule ) )
785 lst += rule->rulesForFeature( feature, context, onlyActive );
794 mSymbol->stopRender( context );
796 const auto constMActiveChildren = mActiveChildren;
797 for (
Rule *rule : constMActiveChildren )
799 rule->stopRender( context );
802 mActiveChildren.clear();
803 mSymbolNormZLevels.clear();
808 QString symbolIdx = ruleElem.attribute( u
"symbol"_s );
810 if ( !symbolIdx.isEmpty() )
812 if ( symbolMap.contains( symbolIdx ) )
814 symbol = symbolMap.take( symbolIdx );
818 QgsDebugError(
"symbol for rule " + symbolIdx +
" not found!" );
822 QString filterExp = ruleElem.attribute( u
"filter"_s );
824 QgsDebugMsgLevel(
"context" + u
"project:layers:%1:legendsymbollabels"_s.arg( context.
currentLayerId() ) +
" source " + ruleElem.attribute( u
"label"_s ), 3 );
825 QString
description = ruleElem.attribute( u
"description"_s );
826 int scaleMinDenom = ruleElem.attribute( u
"scalemindenom"_s, u
"0"_s ).toInt();
827 int scaleMaxDenom = ruleElem.attribute( u
"scalemaxdenom"_s, u
"0"_s ).toInt();
831 ruleKey = ruleElem.attribute( u
"key"_s );
833 ruleKey = QUuid::createUuid().toString();
834 auto rule = std::make_unique<Rule>(
symbol, scaleMinDenom, scaleMaxDenom, filterExp,
label,
description );
839 rule->setActive( ruleElem.attribute( u
"checkstate"_s, u
"1"_s ).toInt() );
841 QDomElement childRuleElem = ruleElem.firstChildElement( u
"rule"_s );
842 while ( !childRuleElem.isNull() )
844 std::unique_ptr<Rule> childRule =
create( childRuleElem, symbolMap,
true, context );
847 rule->appendChild( childRule.release() );
853 childRuleElem = childRuleElem.nextSiblingElement( u
"rule"_s );
865 l +=
c->descendants();
872 if ( ruleElem.localName() !=
"Rule"_L1 )
874 QgsDebugError( u
"invalid element: Rule element expected, %1 found!"_s.arg( ruleElem.tagName() ) );
879 int scaleMinDenom = 0, scaleMaxDenom = 0;
883 QDomElement childElem = ruleElem.firstChildElement();
884 while ( !childElem.isNull() )
886 if ( childElem.localName() ==
"Name"_L1 )
890 if (
label.isEmpty() )
891 label = childElem.firstChild().nodeValue();
893 else if ( childElem.localName() ==
"Description"_L1 )
896 QDomElement titleElem = childElem.firstChildElement( u
"Title"_s );
897 if ( !titleElem.isNull() )
899 label = titleElem.firstChild().nodeValue();
902 QDomElement abstractElem = childElem.firstChildElement( u
"Abstract"_s );
903 if ( !abstractElem.isNull() )
905 description = abstractElem.firstChild().nodeValue();
908 else if ( childElem.localName() ==
"Abstract"_L1 )
913 else if ( childElem.localName() ==
"Title"_L1 )
916 label = childElem.firstChild().nodeValue();
918 else if ( childElem.localName() ==
"Filter"_L1 )
923 if (
filter->hasParserError() )
929 filterExp =
filter->expression();
934 else if ( childElem.localName() ==
"ElseFilter"_L1 )
936 filterExp =
"ELSE"_L1;
938 else if ( childElem.localName() ==
"MinScaleDenominator"_L1 )
941 int v = childElem.firstChild().nodeValue().toInt( &ok );
945 else if ( childElem.localName() ==
"MaxScaleDenominator"_L1 )
948 int v = childElem.firstChild().nodeValue().toInt( &ok );
952 else if ( childElem.localName().endsWith(
"Symbolizer"_L1 ) )
958 childElem = childElem.nextSiblingElement();
963 if ( !layers.isEmpty() )
1000 mRootRule = std::make_unique<Rule>(
nullptr );
1018 std::function< void(
Rule * rule ) > exploreRule;
1019 exploreRule = [&res, &exploreRule](
Rule *rule ) {
1031 exploreRule( child );
1058 QSet<int> symbolZLevelsSet =
mRootRule->collectZLevels();
1059 QList<int> symbolZLevels( symbolZLevelsSet.begin(), symbolZLevelsSet.end() );
1060 std::sort( symbolZLevels.begin(), symbolZLevels.end() );
1064 QMap<int, int> zLevelsToNormLevels;
1065 int maxNormLevel = -1;
1066 const auto constSymbolZLevels = symbolZLevels;
1067 for (
int zLevel : constSymbolZLevels )
1069 zLevelsToNormLevels[zLevel] = ++maxNormLevel;
1071 QgsDebugMsgLevel( u
"zLevel %1 -> %2"_s.arg( zLevel ).arg( maxNormLevel ), 4 );
1074 mRootRule->setNormZLevels( zLevelsToNormLevels );
1094 for (
const RenderLevel &level : constMRenderQueue )
1098 for (
const RenderJob *job : std::as_const( level.jobs ) )
1105 for (
int i = 0; i < count; i++ )
1112 int flags = job->ftr.flags;
1137 return mRootRule->usedAttributes( context );
1147 std::unique_ptr<QgsRuleBasedRenderer::Rule> clonedRoot =
mRootRule->clone();
1151 clonedRoot->setRuleKey(
mRootRule->ruleKey() );
1153 RuleList clonedDescendants = clonedRoot->descendants();
1154 Q_ASSERT( origDescendants.count() == clonedDescendants.count() );
1155 for (
int i = 0; i < origDescendants.count(); ++i )
1156 clonedDescendants[i]->setRuleKey( origDescendants[i]->ruleKey() );
1168 toSld( doc, element, context );
1173 return mRootRule->toSld( doc, element, context );
1185 rendererElem.setAttribute( u
"type"_s, u
"RuleRenderer"_s );
1190 rulesElem.setTagName( u
"rules"_s );
1191 rendererElem.appendChild( rulesElem );
1194 rendererElem.appendChild( symbolsElem );
1198 return rendererElem;
1209 return rule ? rule->
active() :
true;
1226 std::function<QString(
Rule * rule )> ruleToExpression;
1227 ruleToExpression = [&ruleToExpression](
Rule *rule ) -> QString {
1232 QStringList otherRules;
1233 const QList<QgsRuleBasedRenderer::Rule *> siblings = rule->
parent()->
children();
1234 for (
Rule *sibling : siblings )
1236 if ( sibling == rule || sibling->
isElse() )
1239 const QString siblingExpression = ruleToExpression( sibling );
1240 if ( siblingExpression.isEmpty() )
1243 otherRules.append( siblingExpression );
1246 if ( otherRules.empty() )
1249 return ( otherRules.size() > 1 ? u
"NOT ((%1))"_s.arg( otherRules.join(
") OR ("_L1 ) ) : u
"NOT (%1)"_s.arg( otherRules.at( 0 ) ) );
1253 QStringList ruleParts;
1258 ruleParts.append( u
"@map_scale <= %1"_s.arg( rule->
minimumScale() ) );
1261 ruleParts.append( u
"@map_scale >= %1"_s.arg( rule->
maximumScale() ) );
1263 if ( !ruleParts.empty() )
1265 return ( ruleParts.size() > 1 ? u
"(%1)"_s.arg( ruleParts.join(
") AND ("_L1 ) ) : ruleParts.at( 0 ) );
1277 const QString ruleFilter = ruleToExpression( rule );
1278 if ( !ruleFilter.isEmpty() )
1279 parts.append( ruleFilter );
1285 return parts.empty() ? u
"TRUE"_s : ( parts.size() > 1 ? u
"(%1)"_s.arg( parts.join(
") AND ("_L1 ) ) : parts.at( 0 ) );
1313 QDomElement symbolsElem = element.firstChildElement( u
"symbols"_s );
1314 if ( symbolsElem.isNull() )
1319 QDomElement rulesElem = element.firstChildElement( u
"rules"_s );
1321 std::unique_ptr<Rule> root =
Rule::create( rulesElem, symbolMap,
true, context );
1325 auto r = std::make_unique<QgsRuleBasedRenderer>( root.release() );
1336 Rule *root =
nullptr;
1338 QDomElement ruleElem = element.firstChildElement( u
"Rule"_s );
1339 while ( !ruleElem.isNull() )
1346 root =
new Rule(
nullptr );
1351 ruleElem = ruleElem.nextSiblingElement( u
"Rule"_s );
1361 return std::make_unique<QgsRuleBasedRenderer>( root );
1379 const auto constCategories = r->
categories();
1386 else if ( cat.value().userType() == QMetaType::Type::Int )
1387 value = cat.value().toString();
1388 else if ( cat.value().userType() == QMetaType::Type::Double )
1391 value = QString::number( cat.value().toDouble(),
'f', 4 );
1395 const QString label = !cat.label().isEmpty() ? cat.label() : cat.value().isValid() ? value : QString();
1411 else if ( !testExpr.
isField() )
1414 attr = u
"(%1)"_s.arg( attr );
1417 bool firstRange =
true;
1418 const auto constRanges = r->
ranges();
1423 QString
filter = u
"%1 %2 %3 AND %1 <= %4"_s.arg( attr, firstRange ? u
">="_s : u
">"_s, QString::number( rng.lowerValue(),
'f', 4 ), QString::number( rng.upperValue(),
'f', 4 ) );
1425 QString label = rng.label().isEmpty() ?
filter : rng.label();
1432 std::sort( scales.begin(), scales.end() );
1436 const auto constScales = scales;
1437 for (
int scale : constScales )
1441 if ( maxDenom != 0 && maxDenom <= scale )
1443 initialRule->
appendChild(
new Rule( symbol->
clone(), oldScale, scale, QString(), u
"%1 - %2"_s.arg( oldScale ).arg( scale ) ) );
1447 initialRule->
appendChild(
new Rule( symbol->
clone(), oldScale, maxDenom, QString(), u
"%1 - %2"_s.arg( oldScale ).arg( maxDenom ) ) );
1452 QString msg( u
"Rule-based renderer:\n"_s );
1459 return mRootRule->willRenderFeature( feature, &context );
1464 return mRootRule->symbolsForFeature( feature, &context );
1469 return mRootRule->symbolsForFeature( feature, &context );
1474 return mRootRule->legendKeysForFeature( feature, &context );
1484 std::unique_ptr< QgsRuleBasedRenderer > r;
1485 if ( renderer->
type() ==
"RuleRenderer"_L1 )
1489 else if ( renderer->
type() ==
"singleSymbol"_L1 )
1492 if ( !singleSymbolRenderer )
1495 std::unique_ptr< QgsSymbol > origSymbol( singleSymbolRenderer->
symbol()->
clone() );
1496 r = std::make_unique< QgsRuleBasedRenderer >( origSymbol.release() );
1498 else if ( renderer->
type() ==
"categorizedSymbol"_L1 )
1501 if ( !categorizedRenderer )
1506 bool isField =
false;
1516 if ( isField && !attr.contains(
'\"' ) )
1522 auto rootrule = std::make_unique< QgsRuleBasedRenderer::Rule >(
nullptr );
1529 auto rule = std::make_unique< QgsRuleBasedRenderer::Rule >(
nullptr );
1531 rule->setLabel( category.
label() );
1534 if ( category.
value().userType() == QMetaType::Type::QVariantList )
1537 const QVariantList list = category.
value().toList();
1538 for (
const QVariant &v : list )
1541 if ( QVariant( v ).convert( QMetaType::Type::Double ) )
1543 values << v.toString();
1551 if ( values.empty() )
1553 expression = u
"ELSE"_s;
1557 expression = u
"%1 IN (%2)"_s.arg( attr, values.join(
',' ) );
1563 if ( category.
value().convert( QMetaType::Type::Double ) )
1565 value = category.
value().toString();
1573 if ( value ==
"''"_L1 )
1575 expression = u
"ELSE"_s;
1579 expression = u
"%1 = %2"_s.arg( attr, value );
1582 rule->setFilterExpression( expression );
1588 std::unique_ptr< QgsSymbol > origSymbol( category.
symbol()->
clone() );
1589 rule->setSymbol( origSymbol.release() );
1591 rootrule->appendChild( rule.release() );
1594 r = std::make_unique< QgsRuleBasedRenderer >( rootrule.release() );
1596 else if ( renderer->
type() ==
"graduatedSymbol"_L1 )
1599 if ( !graduatedRenderer )
1605 bool isField =
false;
1615 if ( isField && !attr.contains(
'\"' ) )
1620 else if ( !isField )
1623 attr = u
"(%1)"_s.arg( attr );
1626 auto rootrule = std::make_unique< QgsRuleBasedRenderer::Rule >(
nullptr );
1630 const bool isInverted = ranges.size() > 1 ? ranges.at( 0 ).upperValue() > ranges.at( 1 ).upperValue() :
false;
1632 for (
int i = 0; i < ranges.size(); ++i )
1634 range = ranges.value( i );
1635 auto rule = std::make_unique< QgsRuleBasedRenderer::Rule >(
nullptr );
1637 rule->setLabel( range.
label() );
1638 const QString upperValue = QString::number( range.
upperValue(),
'f', 16 );
1639 const QString lowerValue = QString::number( range.
lowerValue(),
'f', 16 );
1643 expression = !isInverted ? u
"%1 <= %2"_s.arg( attr, upperValue ) : u
"%1 > %2"_s.arg( attr, lowerValue );
1645 else if ( i == ranges.size() - 1 )
1647 expression = !isInverted ? u
"%1 > %2"_s.arg( attr, lowerValue ) : u
"%1 <= %2"_s.arg( attr, upperValue );
1651 expression = attr +
" > " + lowerValue +
" AND " + attr +
" <= " + upperValue;
1653 rule->setFilterExpression( expression );
1659 std::unique_ptr< QgsSymbol > symbol( range.
symbol()->
clone() );
1660 rule->setSymbol( symbol.release() );
1662 rootrule->appendChild( rule.release() );
1665 r = std::make_unique< QgsRuleBasedRenderer >( rootrule.release() );
1667 else if ( renderer->
type() ==
"pointDisplacement"_L1 || renderer->
type() ==
"pointCluster"_L1 )
1672 else if ( renderer->
type() ==
"invertedPolygonRenderer"_L1 )
1677 else if ( renderer->
type() ==
"mergedFeatureRenderer"_L1 )
1682 else if ( renderer->
type() ==
"embeddedSymbol"_L1 && layer )
1686 auto rootrule = std::make_unique< QgsRuleBasedRenderer::Rule >(
nullptr );
1693 while ( it.
nextFeature( feature ) && rootrule->children().size() < 500 )
1697 auto rule = std::make_unique< QgsRuleBasedRenderer::Rule >(
nullptr );
1698 rule->setFilterExpression( u
"$id=%1"_s.arg( feature.
id() ) );
1699 rule->setLabel( QString::number( feature.
id() ) );
1701 rootrule->appendChild( rule.release() );
1705 auto rule = std::make_unique< QgsRuleBasedRenderer::Rule >(
nullptr );
1706 rule->setFilterExpression( u
"ELSE"_s );
1707 rule->setLabel( QObject::tr(
"All other features" ) );
1709 rootrule->appendChild( rule.release() );
1711 r = std::make_unique< QgsRuleBasedRenderer >( rootrule.release() );
1724 QString sizeExpression;
1725 switch ( symbol->
type() )
1731 if ( !sizeScaleField.isEmpty() )
1733 sizeExpression = u
"%1*(%2)"_s.arg( msl->
size() ).arg( sizeScaleField );
1736 if ( !rotationField.isEmpty() )
1743 if ( !sizeScaleField.isEmpty() )
1750 sizeExpression = u
"%1*(%2)"_s.arg( lsl->
width() ).arg( sizeScaleField );
1759 sizeExpression = u
"%1*(%2)"_s.arg( msl->
size() ).arg( sizeScaleField );
@ NoGeometry
Geometry is not required. It may still be returned if e.g. required for a filter condition.
@ EmbeddedSymbols
Retrieve any embedded feature symbology.
QFlags< FeatureRendererFlag > FeatureRendererFlags
Flags controlling behavior of vector feature renderers.
@ AffectsLabeling
If present, indicates that the renderer will participate in the map labeling problem.
GeometryType
The geometry types are used to group Qgis::WkbType in a coarse way.
@ AffectsLabeling
If present, indicates that the symbol will participate in the map labeling problem.
A feature renderer which represents features using a list of renderer categories.
const QgsCategoryList & categories() const
Returns a list of all categories recognized by the renderer.
QString classAttribute() const
Returns the class attribute for the renderer, which is the field name or expression string from the l...
A vector feature renderer which uses embedded feature symbology to render per-feature symbols.
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the context.
Handles parsing and evaluation of expressions (formerly called "search strings").
static QString quotedString(QString text)
Returns a quoted version of a string (in single quotes).
bool hasParserError() const
Returns true if an error occurred when parsing the input expression.
bool isField() const
Checks whether an expression consists only of a single field reference.
static QString quotedColumnRef(QString name)
Returns a quoted column reference (in double quotes).
static int expressionToLayerFieldIndex(const QString &expression, const QgsVectorLayer *layer)
Attempts to resolve an expression to a field index from the given layer.
static bool attemptReduceToInClause(const QStringList &expressions, QString &result)
Attempts to reduce a list of expressions to a single "field IN (val1, val2, ... )" type expression.
Wrapper for iterator of features from vector data provider or vector layer.
bool nextFeature(QgsFeature &f)
Fetch next feature and stores in f, returns true on success.
QgsFeatureRenderer(const QString &type)
virtual void stopRender(QgsRenderContext &context)
Must be called when a render cycle has finished, to allow the renderer to clean up.
void copyRendererData(QgsFeatureRenderer *destRenderer) const
Clones generic renderer data to another renderer.
void saveRendererData(QDomDocument &doc, QDomElement &element, const QgsReadWriteContext &context)
Saves generic renderer data into the specified element.
void renderFeatureWithSymbol(const QgsFeature &feature, QgsSymbol *symbol, QgsRenderContext &context, int layer, bool selected, bool drawVertexMarker)
Render the feature with the symbol using context.
virtual const QgsFeatureRenderer * embeddedRenderer() const
Returns the current embedded renderer (subrenderer) for this feature renderer.
virtual void startRender(QgsRenderContext &context, const QgsFields &fields)
Must be called when a new render cycle is started.
virtual QgsFeatureRenderer * clone() const =0
Create a deep copy of this renderer.
Wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setFlags(Qgis::FeatureRequestFlags flags)
Sets flags that affect how features will be fetched.
QgsFeatureRequest & setNoAttributes()
Set that no attributes will be fetched.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
const QgsSymbol * embeddedSymbol() const
Returns the feature's embedded symbology, or nullptr if the feature has no embedded symbol.
Container of fields for a vector layer.
A fill symbol type, for rendering Polygon and MultiPolygon geometries.
A vector feature renderer which uses numeric attributes to classify features into different ranges.
QString classAttribute() const
Returns the attribute name (or expression) used for the classification.
const QgsRangeList & ranges() const
Returns a list of all ranges used in the classification.
A polygon-only feature renderer used to display features inverted.
Stores information about one class/rule of a vector layer renderer in a unified way that can be used ...
Abstract base class for line symbol layers.
virtual double width() const
Returns the estimated width for the line symbol layer.
A line symbol type, for rendering LineString and MultiLineString geometries.
Abstract base class for marker symbol layers.
double size() const
Returns the symbol size.
A marker symbol type, for rendering Point and MultiPoint geometries.
A polygon or line-only feature renderer used to render a set of features merged (or dissolved) into a...
static QgsExpression * expressionFromOgcFilter(const QDomElement &element, QgsVectorLayer *layer=nullptr)
Parse XML with OGC filter into QGIS expression.
An abstract base class for distance based point renderers (e.g., clusterer and displacement renderers...
virtual QString translate(const QString &context, const QString &sourceText, const char *disambiguation=nullptr, int n=-1) const =0
Translates a string using the Qt QTranslator mechanism.
static QgsProperty fromExpression(const QString &expression, bool isActive=true)
Returns a new ExpressionBasedProperty created from the specified expression.
static QgsProperty fromField(const QString &fieldName, bool isActive=true)
Returns a new FieldBasedProperty created from the specified field name.
A container for the context for various read/write operations on objects.
const QgsProjectTranslator * projectTranslator() const
Returns the project translator.
const QString currentLayerId() const
Returns the currently used layer id as string.
Contains information about the context of a rendering operation.
double rendererScale() const
Returns the renderer map scale.
QgsExpressionContext & expressionContext()
Gets the expression context.
bool renderingStopped() const
Returns true if the rendering operation has been stopped and any ongoing rendering should be canceled...
Represents an individual category (class) from a QgsCategorizedSymbolRenderer.
QgsSymbol * symbol() const
Returns the symbol which will be used to render this category.
QVariant value() const
Returns the value corresponding to this category.
QString label() const
Returns the label for this category, which is used to represent the category within legends and the l...
Represents a value range for a QgsGraduatedSymbolRenderer.
QString label() const
Returns the label used for the range.
QgsSymbol * symbol() const
Returns the symbol used for the range.
double upperValue() const
Returns the upper bound of the range.
double lowerValue() const
Returns the lower bound of the range.
Represents an individual rule for a rule-based renderer.
bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified symbology visitor, causing it to visit all child rules associated with the rule...
QgsRuleBasedRenderer::RuleList descendants() const
Returns all children, grand-children, grand-grand-children, grand-gra... you get it.
void setSymbol(QgsSymbol *sym)
Sets a new symbol (or nullptr). Deletes old symbol.
void removeChild(QgsRuleBasedRenderer::Rule *rule)
delete child rule
QgsRuleBasedRenderer::Rule * findRuleByKey(const QString &key)
Try to find a rule given its unique key.
void insertChild(int i, QgsRuleBasedRenderer::Rule *rule)
add child rule, take ownership, sets this as parent
QString ruleKey() const
Unique rule identifier (for identification of rule within renderer).
static std::unique_ptr< QgsRuleBasedRenderer::Rule > create(QDomElement &ruleElem, QgsSymbolMap &symbolMap, bool reuseId=true, const QgsReadWriteContext &context=QgsReadWriteContext())
Create a rule from an XML definition.
std::unique_ptr< QgsRuleBasedRenderer::Rule > clone() const
clone this rule, return new instance
bool needsGeometry() const
Returns true if this rule or one of its children needs the geometry to be applied.
QgsRuleBasedRenderer::Rule * takeChild(QgsRuleBasedRenderer::Rule *rule)
take child rule out, set parent as nullptr
const QgsRuleBasedRenderer::RuleList & children() const
Returns all children rules of this rule.
RenderResult
The result of rendering a rule.
@ Inactive
The rule is inactive.
@ Filtered
The rule does not apply.
@ Rendered
Something was rendered.
QgsRuleBasedRenderer::RuleList rulesForFeature(const QgsFeature &feature, QgsRenderContext *context=nullptr, bool onlyActive=true)
Returns the list of rules used to render the feature in a specific context.
double maximumScale() const
Returns the maximum map scale (i.e.
QgsRuleBasedRenderer::Rule * parent()
The parent rule.
void setIsElse(bool iselse)
Sets if this rule is an ELSE rule.
QgsSymbolList symbolsForFeature(const QgsFeature &feature, QgsRenderContext *context=nullptr)
tell which symbols will be used to render the feature
bool isElse() const
Check if this rule is an ELSE rule.
QSet< QString > legendKeysForFeature(const QgsFeature &feature, QgsRenderContext *context=nullptr)
Returns which legend keys match the feature.
bool willRenderFeature(const QgsFeature &feature, QgsRenderContext *context=nullptr)
only tell whether a feature will be rendered without actually rendering it
void removeChildAt(int i)
delete child rule
void setActive(bool state)
Sets if this rule is active.
Rule(QgsSymbol *symbol, int maximumScale=0, int minimumScale=0, const QString &filterExp=QString(), const QString &label=QString(), const QString &description=QString(), bool elseRule=false)
Constructor takes ownership of the symbol.
bool isFilterOK(const QgsFeature &f, QgsRenderContext *context=nullptr) const
Check if a given feature shall be rendered by this rule.
QgsSymbolList symbols(const QgsRenderContext &context=QgsRenderContext()) const
Returns a list of the symbols used by this rule and all children of this rule.
bool isScaleOK(double scale) const
Check if this rule applies for a given scale.
QgsExpression * filter() const
A filter that will check if this rule applies.
void setNormZLevels(const QMap< int, int > &zLevelsToNormLevels)
assign normalized z-levels [0..N-1] for this rule's symbol for quick access during rendering
QDomElement save(QDomDocument &doc, QgsSymbolMap &symbolMap) const
void appendChild(QgsRuleBasedRenderer::Rule *rule)
add child rule, take ownership, sets this as parent
QgsRuleBasedRenderer::Rule * takeChildAt(int i)
take child rule out, set parent as nullptr
QSet< int > collectZLevels()
Gets all used z-levels from this rule and children.
double minimumScale() const
Returns the minimum map scale (i.e.
QString description() const
A human readable description for this rule.
void stopRender(QgsRenderContext &context)
Stop a rendering process.
static std::unique_ptr< QgsRuleBasedRenderer::Rule > createFromSld(QDomElement &element, Qgis::GeometryType geomType)
Create a rule from the SLD provided in element and for the specified geometry type.
bool hasActiveChildren() const
Returns true if the rule has any active children.
QgsRuleBasedRenderer::Rule::RenderResult renderFeature(QgsRuleBasedRenderer::FeatureToRender &featToRender, QgsRenderContext &context, QgsRuleBasedRenderer::RenderQueue &renderQueue)
Render a given feature, will recursively call subclasses and only render if the constraints apply.
QgsLegendSymbolList legendSymbolItems(int currentLevel=-1) const
QSet< QString > usedAttributes(const QgsRenderContext &context) const
Returns the attributes used to evaluate the expression of this rule.
void setFilterExpression(const QString &filterExp)
Set the expression used to check if a given feature shall be rendered with this rule.
void setLabel(const QString &label)
QString dump(int indent=0) const
Dump for debug purpose.
bool startRender(QgsRenderContext &context, const QgsFields &fields, QString &filter)
prepare the rule for rendering and its children (build active children array)
QString filterExpression() const
A filter that will check if this rule applies.
bool active() const
Returns if this rule is active.
Q_DECL_DEPRECATED void toSld(QDomDocument &doc, QDomElement &element, QVariantMap props) const
Saves the symbol layer as SLD.
static void refineRuleCategories(QgsRuleBasedRenderer::Rule *initialRule, QgsCategorizedSymbolRenderer *r)
take a rule and create a list of new rules based on the categories from categorized symbol renderer
static void convertToDataDefinedSymbology(QgsSymbol *symbol, const QString &sizeScaleField, const QString &rotationField=QString())
helper function to convert the size scale and rotation fields present in some other renderers to data...
bool legendSymbolItemChecked(const QString &key) override
Returns true if the legend symbology item with the specified key is checked.
void startRender(QgsRenderContext &context, const QgsFields &fields) override
Must be called when a new render cycle is started.
static std::unique_ptr< QgsRuleBasedRenderer > convertFromRenderer(const QgsFeatureRenderer *renderer, QgsVectorLayer *layer=nullptr)
Creates a new QgsRuleBasedRenderer from an existing renderer.
QDomElement save(QDomDocument &doc, const QgsReadWriteContext &context) override
Stores renderer properties to an XML element.
void setLegendSymbolItem(const QString &key, QgsSymbol *symbol) override
Sets the symbol to be used for a legend symbol item.
bool canSkipRender() override
Returns true if the renderer can be entirely skipped, i.e.
void checkLegendSymbolItem(const QString &key, bool state=true) override
Sets whether the legend symbology item with the specified ley should be checked.
QgsSymbol * symbolForFeature(const QgsFeature &feature, QgsRenderContext &context) const override
Returns symbol for current feature. Should not be used individually: there could be more symbols for ...
QList< QgsRuleBasedRenderer::RenderLevel > RenderQueue
Rendering queue: a list of rendering levels.
QSet< QString > legendKeysForFeature(const QgsFeature &feature, QgsRenderContext &context) const override
Returns legend keys matching a specified feature.
static void refineRuleRanges(QgsRuleBasedRenderer::Rule *initialRule, QgsGraduatedSymbolRenderer *r)
take a rule and create a list of new rules based on the ranges from graduated symbol renderer
QgsSymbolList symbolsForFeature(const QgsFeature &feature, QgsRenderContext &context) const override
Returns list of symbols used for rendering the feature.
QString dump() const override
Returns debug information about this renderer.
QgsSymbolList originalSymbolsForFeature(const QgsFeature &feature, QgsRenderContext &context) const override
Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbol...
static std::unique_ptr< QgsFeatureRenderer > create(QDomElement &element, const QgsReadWriteContext &context)
Creates a new rule-based renderer instance from XML.
bool legendSymbolItemsCheckable() const override
Returns true if symbology items in legend are checkable.
QSet< QString > usedAttributes(const QgsRenderContext &context) const override
Returns a list of attributes required by this renderer.
QString filter(const QgsFields &fields=QgsFields()) override
If a renderer does not require all the features this method may be overridden and return an expressio...
std::unique_ptr< Rule > mRootRule
the root node with hierarchical list of rules
bool willRenderFeature(const QgsFeature &feature, QgsRenderContext &context) const override
Returns whether the renderer will render a feature or not.
static void refineRuleScales(QgsRuleBasedRenderer::Rule *initialRule, QList< int > scales)
take a rule and create a list of new rules with intervals of scales given by the passed scale denomin...
static std::unique_ptr< QgsFeatureRenderer > createFromSld(QDomElement &element, Qgis::GeometryType geomType)
Creates a new rule based renderer from an SLD XML element.
QList< QgsRuleBasedRenderer::Rule * > RuleList
void stopRender(QgsRenderContext &context) override
Must be called when a render cycle has finished, to allow the renderer to clean up.
~QgsRuleBasedRenderer() override
void setLegendSymbolItemLabel(const QString &key, const QString &label) override
Sets the label for a legend symbol item.
bool accept(QgsStyleEntityVisitorInterface *visitor) const override
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer...
bool filterNeedsGeometry() const override
Returns true if this renderer requires the geometry to apply the filter.
Qgis::FeatureRendererFlags flags() const override
Returns flags associated with the renderer.
QgsRuleBasedRenderer * clone() const override
Create a deep copy of this renderer.
QgsLegendSymbolList legendSymbolItems() const override
Returns a list of symbology items for the legend.
QList< FeatureToRender > mCurrentFeatures
QString legendKeyToExpression(const QString &key, QgsVectorLayer *layer, bool &ok) const override
Attempts to convert the specified legend rule key to a QGIS expression matching the features displaye...
bool renderFeature(const QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false) override
Render a feature using this renderer in the given context.
QgsRuleBasedRenderer(QgsRuleBasedRenderer::Rule *root)
Constructs the renderer from given tree of rules (takes ownership).
QgsSymbolList symbols(QgsRenderContext &context) const override
Returns list of symbols used by the renderer.
Q_DECL_DEPRECATED void toSld(QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const override
Used from subclasses to create SLD Rule elements following SLD v1.1 specs.
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.
A feature renderer which renders all features with the same symbol.
QgsSymbol * symbol() const
Returns the symbol which will be rendered for every feature.
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 symbol 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 bool hasSldSymbolizer(const QDomElement &element)
Returns true if a DOM element contains an SLD Symbolizer element.
static bool createSymbolLayerListFromSld(QDomElement &element, Qgis::GeometryType geomType, QList< QgsSymbolLayer * > &layers)
Creates a symbol layer list from a DOM 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.
static void clearSymbolMap(QgsSymbolMap &symbols)
static QgsSymbolMap loadSymbols(QDomElement &element, const QgsReadWriteContext &context)
Reads a collection of symbols from XML and returns them in a map. Caller is responsible for deleting ...
static QDomElement saveSymbols(QgsSymbolMap &symbols, const QString &tagName, QDomDocument &doc, const QgsReadWriteContext &context)
Writes a collection of symbols to XML with specified tagName for the top-level element.
@ StrokeWidth
Stroke width.
virtual QString layerType() const =0
Returns a string that represents this layer type.
int renderingPass() const
Specifies the rendering pass in which this symbol layer should be rendered.
virtual void setDataDefinedProperty(Property key, const QgsProperty &property)
Sets a data defined property for the layer.
virtual QgsSymbol * subSymbol()
Returns the symbol's sub symbol, if present.
Abstract base class for all rendered symbols.
QgsSymbolLayer * symbolLayer(int layer)
Returns the symbol layer at the specified index.
virtual QgsSymbol * clone() const =0
Returns a deep copy of this symbol.
int symbolLayerCount() const
Returns the total number of symbol layers contained in the symbol.
Qgis::SymbolType type() const
Returns the symbol's type.
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
Represents a vector layer which manages a vector based dataset.
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const final
Queries the layer for features specified in request.
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
QString qgsEnumValueToKey(const T &value, bool *returnOk=nullptr)
Returns the value for the given key of an enum.
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference).
QList< QgsLegendSymbolItem > QgsLegendSymbolList
#define QgsDebugMsgLevel(str, level)
#define QgsDebugError(str)
#define RENDERER_TAG_NAME
QMap< QString, QgsSymbol * > QgsSymbolMap
QList< QgsSymbol * > QgsSymbolList
QList< QgsRendererRange > QgsRangeList
QList< QgsSymbolLayer * > QgsSymbolLayerList
Feature for rendering by a QgsRuleBasedRenderer.
A QgsRuleBasedRenderer rendering job, consisting of a feature to be rendered with a particular symbol...
Render level: a list of jobs to be drawn at particular level for a QgsRuleBasedRenderer.
Contains information relating to a node (i.e.
Contains information relating to the style entity currently being visited.