Implementation of labeling engine rules #58580

nyalldawson · 2024-09-05T05:33:06Z

Implements the API framework for setting advanced labeling engine rules for a project, and implements 4 initial rule types:

QgsLabelingEngineRuleMinimumDistanceLabelToFeature: prevents labels being placed too close to features from a different layer
QgsLabelingEngineRuleMaximumDistanceLabelToFeature: prevents labels being placed too far from features from a different layer
QgsLabelingEngineRuleMinimumDistanceLabelToLabel: prevents labels being placed too close to labels from a different layer
QgsLabelingEngineRuleAvoidLabelOverlapWithFeature: prevents labels being placed overlapping features from a different layer

(note that the first 3 rules require a build based on GEOS >= 3.10, they are not available for older GEOS builds)

Also implements a registry for storing available rule classes, and serialization of rules and configuration in QGIS projects

Now with GUI:

Peek.2024-09-06.13-06.mp4

Sponsored by Rubicon Concierge Real Estate

github-actions · 2024-09-05T07:03:05Z

🪟 Windows builds ready!

Windows builds of this PR are available for testing here. Debug symbols for this build are available here.

(Built from commit 9a909a0)

qgis-bot · 2024-09-06T03:07:31Z

@nyalldawson
This pull request has been tagged as requiring documentation.

A documentation ticket will be opened at https://github.com/qgis/QGIS-Documentation when this PR is merged.

Please update the description (not the comments) with helpful description and screenshot to help the work from documentors.
Also, any commit having [needs-doc] or [Needs Documentation] in will see its message pushed to the issue, so please be as verbose as you can.

Thank you!

qgis-bot · 2024-09-06T03:07:32Z

@nyalldawson

This pull request has been tagged for the changelog.

The description will be harvested so please provide a "nearly-ready" text for the final changelog
If possible, add a nice illustration of the feature. Only the first one in the description will be harvested (GIF accepted as well)
If you can, it's better to give credits to your sponsor, see below for different formats.

You can edit the description.

Format available for credits

Funded by NAME
Funded by URL
Funded by NAME URL
Sponsored by NAME
Sponsored by URL
Sponsored by NAME URL

Thank you!

nyalldawson · 2024-09-06T03:07:53Z

Now with GUI, this is ready for review...

DelazJ · 2024-09-06T09:31:20Z

Nice @nyalldawson! What about showing involved layers next to the rule in the "Labeling rules" list? It might help to quickly identify the rule you want to update...

nyalldawson · 2024-09-06T10:07:44Z

@DelazJ you can set your own name for rules, which is used in that list. I was thinking that could be better for rule identification.

Maybe we could show a summary including involved layers in a tooltip for the list item?

DelazJ · 2024-09-06T13:05:45Z

Ah, great! I only watched the screencast which didn't showcase that.

Maybe we could show a summary including involved layers in a tooltip for the list item?

+1 from me. When you are out of inspiration for rules naming, this could be handful 😄

nyalldawson · 2024-09-09T01:12:17Z

@DelazJ
here you go:

Peek.2024-09-09.11-11.mp4

src/core/labeling/rules/qgslabelingenginerule.h

nirvn · 2024-09-10T01:16:19Z

src/core/labeling/rules/qgslabelingenginerule.h

+     *
+     * The default implementation returns FALSE.
+     */
+    virtual bool candidateIsIllegal( const pal::LabelPosition *candidate, QgsLabelingEngineContext &context ) const SIP_SKIP;


I'm not sure why but I don't like the word 'illegal' here. What about candidateIsForbidden, candiateIsProhibited, candidateIsDisallowed, candidateIsBanned ? We're breaching rules not laws 😉

Hmm... we have QgsAbstractDatabaseProviderConnection::illegalFieldNames, but nothing in current api with forbidden/prohibited/disallowed/banned. Is one other method enough to set the precedent?

@nyalldawson , ideally we'd change illegalFieldNames to prohibited/forbiddenFileNames but that API is exposed to bindings so it's frozen right?

Seems like settling for what preexisting keyword is a good argument enough then.

src/core/labeling/rules/qgslabelingenginerule_impl.cpp

src/core/labeling/rules/qgslabelingengineruleregistry.cpp

src/core/pal/pal.cpp

src/core/pal/pal.h

See qgis/QGIS-Enhancement-Proposals#299 Implements the API framework for setting advanced labeling engine rules for a project, and implements 4 initial rule types: - QgsLabelingEngineRuleMinimumDistanceLabelToFeature: prevents labels being placed too *close* to features from a different layer - QgsLabelingEngineRuleMaximumDistanceLabelToFeature: prevents labels being placed too *far* from features from a different layer - QgsLabelingEngineRuleMinimumDistanceLabelToLabel: prevents labels being placed too close to labels from a different layer - QgsLabelingEngineRuleAvoidLabelOverlapWithFeature: prevents labels being placed overlapping features from a different layer (note that the first 3 rules require a build based on GEOS >= 3.10, they are not available for older GEOS builds) Also implements a registry for storing available rule classes, and serialization of rules and configuration in QGIS projects

Adds the necessary hooks into the pal classes to give engine rules a chance to implement their logic

- grey out the rule in the rules list - show an explanatory tooltip - don't allow users to create copies of that rule

qgis-bot · 2024-09-10T16:06:55Z

@nyalldawson
A documentation ticket has been opened at qgis/QGIS-Documentation#9244
It is your responsibility to visit this ticket and add as much detail as possible for the documentation team to correctly document this change.
Thank you!

nyalldawson added the API API improvement only, no visible user interface changes label Sep 5, 2024

github-actions bot added this to the 3.40.0 milestone Sep 5, 2024

nyalldawson changed the title ~~[api] Implementation of labeling engine rules~~ Implementation of labeling engine rules Sep 6, 2024

nyalldawson added Feature Labeling Related to QGIS map labeling Needs Documentation When merging a labeled PR, an issue will be created in the Doc repo. Changelog Items that are queued to appear in the visual changelog - remove after harvesting labels Sep 6, 2024

nirvn reviewed Sep 10, 2024

View reviewed changes

nyalldawson added 14 commits September 10, 2024 12:12

pal cleanups - better variable names, comments

aa8bcd7

Respect engine rules when solving pal problem

2e98dd6

Adds the necessary hooks into the pal classes to give engine rules a chance to implement their logic

Add tests for rules

4011049

Fix seealso

1de8564

Fix clang-tidy warnings

cec1cec

Rules can have user-configurable names

7d7887c

Add tests

8735708

Add __repr__

0d5b7d4

Add gui for configuring project advanced labeling rules

02c031e

Add icon for labeling rules

8998356

Don't lose other label settings when configuring engine settings

4929b21

Correctly update rules when rule removed

817a385

Fix docs

26ac318

nyalldawson added 6 commits September 10, 2024 12:13

Allow labeling rules to be de-activated

4343860

Rule name can be edited via list

e8da68f

Generate user-friendly tooltips

ee2a530

Sipify

7216121

Address review

162b3cb

If a rule is not available on the system (eg geos too old):

9a909a0

- grey out the rule in the rules list - show an explanatory tooltip - don't allow users to create copies of that rule

nyalldawson force-pushed the advanced_label_rules_squash branch from b93e9de to 9a909a0 Compare September 10, 2024 03:12

nyalldawson merged commit 569da98 into qgis:master Sep 10, 2024
30 checks passed

nyalldawson deleted the advanced_label_rules_squash branch September 10, 2024 16:06

qgis-bot mentioned this pull request Sep 10, 2024

Implementation of labeling engine rules (Request in QGIS) qgis/QGIS-Documentation#9244

Open

zacharlie added ChangelogHarvested This PR description has been harvested in the Changelog already. and removed Changelog Items that are queued to appear in the visual changelog - remove after harvesting labels Sep 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implementation of labeling engine rules #58580

Implementation of labeling engine rules #58580

nyalldawson commented Sep 5, 2024 •

edited

Loading

github-actions bot commented Sep 5, 2024 •

edited

Loading

qgis-bot commented Sep 6, 2024

qgis-bot commented Sep 6, 2024

nyalldawson commented Sep 6, 2024

DelazJ commented Sep 6, 2024

nyalldawson commented Sep 6, 2024

DelazJ commented Sep 6, 2024

nyalldawson commented Sep 9, 2024

nirvn Sep 10, 2024

nyalldawson Sep 10, 2024 •

edited

Loading

nirvn Sep 10, 2024

qgis-bot commented Sep 10, 2024

Implementation of labeling engine rules #58580

Implementation of labeling engine rules #58580

Conversation

nyalldawson commented Sep 5, 2024 • edited Loading

github-actions bot commented Sep 5, 2024 • edited Loading

🪟 Windows builds ready!

qgis-bot commented Sep 6, 2024

qgis-bot commented Sep 6, 2024

nyalldawson commented Sep 6, 2024

DelazJ commented Sep 6, 2024

nyalldawson commented Sep 6, 2024

DelazJ commented Sep 6, 2024

nyalldawson commented Sep 9, 2024

nirvn Sep 10, 2024

Choose a reason for hiding this comment

nyalldawson Sep 10, 2024 • edited Loading

Choose a reason for hiding this comment

nirvn Sep 10, 2024

Choose a reason for hiding this comment

qgis-bot commented Sep 10, 2024

nyalldawson commented Sep 5, 2024 •

edited

Loading

github-actions bot commented Sep 5, 2024 •

edited

Loading

nyalldawson Sep 10, 2024 •

edited

Loading