AttributeEditor: Flag attributes with invalid values #2141
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cbentejac
force-pushed
the
dev/wrongBracketsMessage
branch
from
3ee749d
to
5ef284a
Compare
This commit adds two new description parameters: - `validValue`, which is true if the value of the attribute is not erroneous (i.e. valid for the type of the attribute but invalid in the context of that specific attribute) and false otherwise. This holds a different significance than the "validateValue" method, which only checks if the parameter's value is expected with respect to the attribute's type. For example, we could want an IntParam that flags any value that is not even: an odd integer value would successfully go through the "validateValue" method, but would then be flagged as an invalid value at the attribute's level. - `errorMessage`, an attribute-specific string that contains a message explaining why the attribute's `validValue` parameter might be set to false. By default, all the attributes' values are valid, and they have no error message.
If an attribute's `validValue` is false, and it has a non-empty `errorMessage`, the following will happen: - An icon indicating an error will be added next to the attribute's name; - The color of the label's background will change to red to clearly indicate that something is wrong with the current value; - The error message that has been set for this attribute will be displayed in its tooltip, before its regular description.
…ltiple of the number of inputs Add an error message for `userNbBrackets` and set `validValue` to false if the set number of brackets is not a multiple of the number of input images.
mugulmd
force-pushed
the
dev/wrongBracketsMessage
branch
from
5ef284a
to
363115b
Compare
mugulmd
approved these changes
Aug 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces two new parameters in the description of Int, Float and String attributes:
validValue, which is true if the value of the attribute is not erroneous (i.e. valid for the type of the attribute but invalid in thecontext of that specific attribute) and false otherwise. This holds a different significance than the "validateValue()" method, which only checks if the attribute's value is correct with respect to its type. For example, we could want an IntParam that flags any value that is not even: an odd integer value would successfully go through the "validateValue()" method, but would then be flagged as an invalid value at the attribute's level.
errorMessage, an attribute-specific string that contains a message explaining why the attribute'svalidValueparameter might be set to false.With these new parameters, attributes that have an invalid value will be flagged directly in the Attribute Editor as follows:
Finally, this PR sets
validValueanderrorMessagein the HDR fusion nodes (LdrToHdrSampling,LdrToHdrCalibrationandLdrToHdrMerge) for theuserNbBracketsattribute so that any user-set bracket value that is not a multiple of the number of input images is flagged down.For example, if the user manually sets
userNbBracketsto 3 when there are 28 input images, the attribute will immediately appear as invalid:Features list
validValueanderrorMessageparameters to the description of Int, Float and String attributes;userNbBracketsattribute in the HDR Fusion nodes when its value is not a multiple of the number of input images.