EMSUSD-215 support custom display name for USD attributes #3487
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
pierrebai-adsk
force-pushed
the
bailp/EMSUSD-215/attr-nice-names
branch
from
d1a17cf to
b94b8cd
Compare
pierrebai-adsk
force-pushed
the
bailp/EMSUSD-215/attr-nice-names
branch
from
b94b8cd to
f943191
Compare
pierrebai-adsk
force-pushed
the
bailp/EMSUSD-215/attr-nice-names
branch
from
f943191 to
ebf754a
Compare
pierrebai-adsk
force-pushed
the
bailp/EMSUSD-215/attr-nice-names
branch
from
ebf754a to
5cf9892
Compare
pierrebai-adsk
force-pushed
the
bailp/EMSUSD-215/attr-nice-names
branch
from
5cf9892 to
cfce354
Compare
Add support to have custom names for USD attributes to have nicer names for UI display purpose. We already had an algorithm to automatically make the names prettier, this adds support for user-defined attribute names. We now read the USD 'displayName' metadata on each attribute. If the metadata exists then we use its value as the display name. The built-in function to make the name prettier has also been enhanced to remove the "xformOp:" prefix. Also, the prettyfying avoids generating two spaces in a row (if, for example, : was followed by _). Modify the USD attribute-related classes: - Add a displayName funtion to the UsdAttrbute class. - Add a displayName funtion to the UsdAttributeHolder class. - Add a displayName funtion to the UsdShaderAttributeHolder class. - The displayName function in UsdAttributeHolder prettify the name. Add support for display name in the Attribute Editor template: - Refactor custom-control for various types into their own files. - Add a AttributeCustomControl base class to handle display names. - Make the default control creation use the display names. Added a simple unit test and fix some attribute unit tests.
pierrebai-adsk
force-pushed
the
bailp/EMSUSD-215/attr-nice-names
branch
from
cfce354 to
85c9969
Compare
pierrebai-adsk
commented
Dec 4, 2023
|
|
||
| import maya.cmds as cmds | ||
|
|
||
| class AEUITemplate: |
There was a problem hiding this comment.
Most of these is code extracted from ae_template.py, which had a lot of classes inside a single file that got split into their own file. The code did not change.
pierrebai-adsk
commented
Dec 4, 2023
| break | ||
| except Exception as ex: | ||
| # Do not let one custom control failure affect others. | ||
| print('Failed to create control %s: %s' % (c, ex)) |
There was a problem hiding this comment.
When a custom control creator failed for any reason, it prevented all other attributes to be handled and there was no error message printed, which made diagnostic harder.
pierrebai-adsk
commented
Dec 4, 2023
| import ufe | ||
| import mayaUsd.ufe as mayaUsdUfe | ||
| import mayaUsd.lib as mayaUsdLib | ||
| import maya.cmds as cmds | ||
| import maya.internal.ufeSupport.attributes as attributes | ||
|
|
||
| class CustomEnumControl(object): | ||
| class EnumCustomControl(AttributeCustomControl): |
There was a problem hiding this comment.
Changed the class name to follow the same pattern as the others.
pierrebai-adsk
commented
Dec 4, 2023
| InputsInControl = self.searchForMayaControl(frameLayout, cmds.text, 'Inputs In') | ||
| self.assertIsNotNone(InputsInControl, 'Could not find D_filename "Inputs In" control') | ||
| InputsInControl = self.searchForMayaControl(frameLayout, cmds.text, 'In') | ||
| self.assertIsNotNone(InputsInControl, 'Could not find D_filename "In" control') |
There was a problem hiding this comment.
These are shader attributes that now use the UI name. I asked lookdeX and these attributes never were meant to have the "Input" prefix to begin with.
|
Will remove all refactoring and cleanups and open another PR. |
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.
Add support to have custom names for USD attributes to have nicer names for UI display purpose. We already had an algorithm to automatically make the names prettier, this adds support for user-defined attribute names. We now read the USD 'displayName' metadata on each attribute. If the metadata exists then we use its value as the display name.
The built-in function to make the name prettier has also been enhanced to remove the "xformOp:" prefix.
Modify the USD attribute-related classes:
Add support for display name in the Attribute Editor template:
Added a simple unit test.