Add displayName Metadata to Prim Spec #2055

erslavin · 2022-10-05T10:10:47Z

Added displayName metadata field to prims
Adjusted tests to test for and modify authored displayName metadata

It is important that we keep ABI compatibility on this change, so Get/Set DisplayName methods were not added to UsdPrim. This addition will be added to the PR later - all access to displayName on a prim at the moment should be via Get/Set Metadata.

I have submitted a signed Contributor License Agreement

- Added displayName metadata field to prims - Adjusted tests to test for and modify authored displayName metadata - Did not add Get/Set DisplayName methods to prims - all access should be via Get/Set Metadata to keep ABI compatibility

asluk · 2022-10-05T16:25:35Z

This is part of the Omniverse work for UTF-8 support-- alongside @erslavin's implementation of Unicode identifiers which is not ABI-compatible, we are also offering displayName support so that stakeholders can use it for breadcrumbs back to their UTF-8 encoded source data, and view the displayNames in DCCs that support them. Thanks!

tallytalwar · 2022-10-06T19:27:43Z

Filed as internal issue #USD-7681

asluk · 2022-10-13T11:14:03Z

I know folks are probably busy putting the final touches on v22.11, and we don't expect to make this into there, but please let us know for now if there is any major objection to this PR in principle, as we'll need to deploy it ahead of an official USD release to unblock some key customer workflows-- thanks!

spiffmon · 2022-10-15T05:33:52Z

Hi @asluk and @erslavin , without having done a proper review yet, we don't have any major objections but we feel it is important to include a minimum of support in usdview, something like:

An option in the PrimView browser (in the "Show" menu) to enable use of displayNames, which defaults to on.
Ensure that when this option is on:
- Using the search bar will search display names since that's what the user sees
- the prim tooltips will indicate the prim's True Name.
The path selection bar at the top of usdview would continue to show true names, even when the "Show display names" option is on, since it must be copy/pastable into relationship target paths, etc.

I know we have yet to provide a similar treatment for property displayNames in the property browser, but we feel the potential for confusion is greater at the level of scene hierarchy... but also that especially anyone who is using the displayName feature would really expect to be able to navigate their scene in usdview using them.

Thanks!

asluk · 2022-10-15T08:20:38Z

Hi @asluk and @erslavin , without having done a proper review yet, we don't have any major objections but we feel it is important to include a minimum of support in usdview, something like:

An option in the PrimView browser (in the "Show" menu) to enable use of displayNames, which defaults to on.

Ensure that when this option is on:

Using the search bar will search display names since that's what the user sees

the prim tooltips will indicate the prim's True Name.

The path selection bar at the top of usdview would continue to show true names, even when the "Show display names" option is on, since it must be copy/pastable into relationship target paths, etc.

I know we have yet to provide a similar treatment for property displayNames in the property browser, but we feel the potential for confusion is greater at the level of scene hierarchy... but also that especially anyone who is using the displayName feature would really expect to be able to navigate their scene in usdview using them.

Thanks!

Agreed - we'll work on the usdview side over the next week or so-- thanks!

pxr/usd/sdf/schema.cpp

erslavin · 2022-10-15T18:20:11Z

What if the displayName metadata is empty and the option is on - I would expect in this case the prim name would be used, what do you think?

spiffmon · 2022-10-15T23:39:28Z

Absolutely, @erslavin - that is what we do in Presto, where displayName is a computed quantity, but if the computational inputs are empty, we fall back to prim name. I also wanted to clarify what I said about tooltip... we want it to provide useful information regardless of whether the new mode is on or off, so it should probably always tell you both the prim name and displayName (if it has one).

Thanks!

- Added context menu item to show prim display names (default = True) - Added support for showing prim display name in the prim tree - Added support for searching on prim display name in search box - Modified prim tree item tooltip to show both name and display name

erslavin · 2022-10-17T17:34:55Z

Work in progress - no automated tests yet but modifications were made in usdview to conform to the request

pxr/usdImaging/usdviewq/appController.py

- Augmented automated tests in usdview to account for displayName - Added displayName to field keys in wrapPrimSpec - Removed unnecessary comment blocks

erslavin · 2022-10-19T20:06:46Z

Augmented the existing automated tests for usdview to account for displayName and made some modifications to account for displayName not being authored. Let me know if the functionality is what you expect - in particular the way I implemented search was to search both the displayName (if authored) and prim identifier when the setting is on, and only the identifier when it's off.

spiffmon · 2022-11-16T18:13:55Z

@erslavin , can you please migrate all of the "DisplayName"-related methods on UsdProperty up to UsdObject, now that it is applicable to all object types?

spiffmon · 2022-11-16T18:15:51Z

... and we'll also want to test that in testUsdMetadata

pxr/usd/usd/testenv/testUsdSchemaRegistry/resources/schema.usda

pxr/usd/usd/testenv/testUsdMetadata.py

pxr/usdImaging/usdviewq/utils.h

pxr/usdImaging/usdviewq/utils.cpp

pxr/usdImaging/usdviewq/wrapUtils.cpp

pxr/usdImaging/usdviewq/mainWindowUI.ui

pxr/usdImaging/usdviewq/appController.py

...Imaging/bin/testusdview/testenv/testUsdviewPrimTreeExpansion/testUsdviewPrimTreeExpansion.py

- Moved displayName related methods from UsdProperty to UsdObject - Adjusted tests to better conform to user search expectations

erslavin · 2022-11-28T15:59:51Z

@erslavin , can you please migrate all of the "DisplayName"-related methods on UsdProperty up to UsdObject, now that it is applicable to all object types?

Methods are now moved to UsdObject to apply to both prims and properties. Also adjusted tests to use both generic metadata methods and specific display name methods

- Rolled back changes to search - Updated condition to match on display name if authored or on name if not

- Ensured .ui file was saved from Qt designer

spiffmon

Thanks, so much, @erslavin - just a couple last things for you.

pxr/usdImaging/bin/testusdview/testenv/testUsdviewPrimSearch/testUsdviewPrimSearch.py

...Imaging/bin/testusdview/testenv/testUsdviewPrimTreeExpansion/testUsdviewPrimTreeExpansion.py

pxr/usdImaging/usdviewq/appController.py

- Refactored out pattern match code into separate method to avoid code duplication across prim and prototype search paths - Fixed documentation issue

spiffmon

Just one quick performance note, @erslavin , otherwise this looks fantastic!

pxr/usdImaging/usdviewq/appController.py

- Adjusted usdview search matching logic to directly invoke GetDisplayName and compare to empty string to avoid overhead of calling HasAuthoredDisplayName followed by GetDisplayName

spiffmon

Corey on the USD team noted a few things that I missed - passing them on to you, @erslavin

spiffmon

OK, that's all - thanks, Ed!

pxr/usd/usd/object.h

pxr/usdImaging/usdviewq/primViewItem.py

pxr/usdImaging/usdviewq/utils.cpp

pxr/usdImaging/usdviewq/appController.py

- Modified comments appropriately for methods moved to UsdObject - Made checks for valid displayName more pythonic

spiffmon · 2022-12-18T00:51:13Z

We won't be doing any more dev-pushes to github this year, but just wanted to let you know this one did get merged internally in time for 23.02, @erslavin - thanks for your patience!

asluk · 2022-12-18T02:47:45Z

We won't be doing any more dev-pushes to github this year, but just wanted to let you know this one did get merged internally in time for 23.02, @erslavin - thanks for your patience!

Thanks @spiffmon and @erslavin !

Add displayName Metadata to Prim Spec

6053208

- Added displayName metadata field to prims - Adjusted tests to test for and modify authored displayName metadata - Did not add Get/Set DisplayName methods to prims - all access should be via Get/Set Metadata to keep ABI compatibility

asluk reviewed Oct 15, 2022

View reviewed changes

pxr/usd/sdf/schema.cpp Show resolved Hide resolved

asluk reviewed Oct 17, 2022

View reviewed changes

pxr/usdImaging/usdviewq/appController.py Outdated Show resolved Hide resolved

Add displayName Metadata to PrimSpec

b03192f

- Augmented automated tests in usdview to account for displayName - Added displayName to field keys in wrapPrimSpec - Removed unnecessary comment blocks

syoyo mentioned this pull request Nov 14, 2022

[TODO] support displayName lighttransport/tinyusdz#42

Closed

2 tasks

spiffmon reviewed Nov 25, 2022

View reviewed changes

pxr/usd/usd/testenv/testUsdSchemaRegistry/resources/schema.usda Outdated Show resolved Hide resolved

spiffmon reviewed Nov 25, 2022

View reviewed changes

Add displayName Metadata to Prim Spec

8c1fafb

- Moved displayName related methods from UsdProperty to UsdObject - Adjusted tests to better conform to user search expectations

erslavin added 2 commits November 28, 2022 14:13

Add displayName Metadata to Prim Spec

69c2bb0

- Rolled back changes to search - Updated condition to match on display name if authored or on name if not

Add displayName Metadata to Prim Spec

b83ead3

- Ensured .ui file was saved from Qt designer

spiffmon reviewed Nov 28, 2022

View reviewed changes

Add displayName Metadata to Prim Spec

eb47cb7

- Refactored out pattern match code into separate method to avoid code duplication across prim and prototype search paths - Fixed documentation issue

spiffmon reviewed Nov 30, 2022

View reviewed changes

pxr/usdImaging/usdviewq/appController.py Outdated Show resolved Hide resolved

pxr/usdImaging/usdviewq/appController.py Outdated Show resolved Hide resolved

Add displayName Metadata to Prim Spec

6219275

- Adjusted usdview search matching logic to directly invoke GetDisplayName and compare to empty string to avoid overhead of calling HasAuthoredDisplayName followed by GetDisplayName

spiffmon reviewed Dec 8, 2022

View reviewed changes

Add displayName Metadta to Prim Spec

835870d

- Modified comments appropriately for methods moved to UsdObject - Made checks for valid displayName more pythonic

pixar-oss merged commit 0b95049 into PixarAnimationStudios:dev Jan 4, 2023

This was referenced Apr 20, 2023

Replace references to ASCII with Text in USD binaries to account for UTF-8 support #2394

Merged

Replace documentation references to "ASCII" with "text" #2395

Merged

syoyo mentioned this pull request Jan 10, 2024

ConvertToRenderScene does not fill nodes and RenderMesh lighttransport/tinyusdz#116

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add displayName Metadata to Prim Spec #2055

Add displayName Metadata to Prim Spec #2055

erslavin commented Oct 5, 2022

asluk commented Oct 5, 2022

tallytalwar commented Oct 6, 2022

asluk commented Oct 13, 2022

spiffmon commented Oct 15, 2022

asluk commented Oct 15, 2022

erslavin commented Oct 15, 2022

spiffmon commented Oct 15, 2022

erslavin commented Oct 17, 2022 •

edited

Loading

erslavin commented Oct 19, 2022

spiffmon commented Nov 16, 2022

spiffmon commented Nov 16, 2022

erslavin commented Nov 28, 2022 •

edited

Loading

spiffmon left a comment

spiffmon left a comment

spiffmon left a comment

spiffmon left a comment

spiffmon commented Dec 18, 2022

asluk commented Dec 18, 2022

Add displayName Metadata to Prim Spec #2055

Add displayName Metadata to Prim Spec #2055

Conversation

erslavin commented Oct 5, 2022

asluk commented Oct 5, 2022

tallytalwar commented Oct 6, 2022

asluk commented Oct 13, 2022

spiffmon commented Oct 15, 2022

asluk commented Oct 15, 2022

erslavin commented Oct 15, 2022

spiffmon commented Oct 15, 2022

erslavin commented Oct 17, 2022 • edited Loading

erslavin commented Oct 19, 2022

spiffmon commented Nov 16, 2022

spiffmon commented Nov 16, 2022

erslavin commented Nov 28, 2022 • edited Loading

spiffmon left a comment

Choose a reason for hiding this comment

spiffmon left a comment

Choose a reason for hiding this comment

spiffmon left a comment

Choose a reason for hiding this comment

spiffmon left a comment

Choose a reason for hiding this comment

spiffmon commented Dec 18, 2022

asluk commented Dec 18, 2022

erslavin commented Oct 17, 2022 •

edited

Loading

erslavin commented Nov 28, 2022 •

edited

Loading