Draft for handling ignored validation warnings #591
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.
There has been some feedback saying that the scary, yellow "Validation warnings" indicator, and the message
"Number of warnings: 123"
could be confusing, and raise questions for end users:
Dramatization via emoji by me
A specific aspect that raised concerns here was that many of the official sample models do generate warnings. And without further context, this could give users the impression that ~"The sample models are not really valid, somehow...". But this is not the case. The sample models are valid. And there are some models that even are intended for testing cases that generate warnings.
However, most of the warnings that had been generated for the "Showcase" models had been
MESH_PRIMITIVE_GENERATED_TANGENT_SPACE
which is described as
Leaving out the tangent space information can be a conscious decision by the creator of the model (to reduce the size). But it can limit portability in cases where the renderer/viewer does not generate proper tangent space information.
Different options for addressing this have been discussed in the 3D Formats Tooling Working Group. A previous pull request simply disabled this warning on the level of the validator. An undesirable side-effect of this was that
Another option is drafted (!) here:
When there are "infos", then the number of infos is displayed in a white circle:
When there are "errors", then the number of errors is displayed in a red circle:
When there are warnings, the special handling kicks in:
When there is any warning that is not one of the "ignored"
MESH_PRIMITIVE_GENERATED_TANGENT_SPACE
warnings, then the total number of warnings is displayed in a yellow circle:When all the warnings are the "ignored"
MESH_PRIMITIVE_GENERATED_TANGENT_SPACE
ones, then it shows an innocent, calming, "i" (for "info") in a Pale Blue Dot.If there have been "ignored" warnings, then the validator tab will show an elaborate message, saying how many warnings have been "ignored", and explaining the reason why this is OK for the sample viewer. (Wording TBD)
The current state of this PR is a DRAFT, to illustrate what this may look like for the end user.
The implementation will have to be cleaned up. And whenever I have to do anything that even remotely involves CSS, I'm reminded why I am not (and will never be) a web frontend developer. But I can do some cleanups, at least (e.g. the change from the previous PR is just commented out here).
@DRx3D @emackey @lexaknyazev