Add displayName Metadata to Prim Spec

pxr/usd/sdf/schema.cpp

@@ -872,6 +872,8 @@ SdfSchemaBase::_RegisterStandardFields()
                        SdfMetadataDisplayGroupTokens->core)
         .MetadataField(SdfFieldKeys->DisplayGroupOrder,
                        SdfMetadataDisplayGroupTokens->core)
+        .MetadataField(SdfFieldKeys->DisplayName,
+                       SdfMetadataDisplayGroupTokens->core)
         .MetadataField(SdfFieldKeys->Documentation,
                        SdfMetadataDisplayGroupTokens->core)
         .MetadataField(SdfFieldKeys->Hidden,

pxr/usd/sdf/testenv/testSdfParsing.testenv/187_displayName_metadata.sdf

@@ -7,7 +7,9 @@
 
 class MfScope "Rig"
 {
-    def MfScope "Leg"
+    def MfScope "Leg" (
+        displayName = "Foo"
+    )
     {
         custom double kneeFB (
             displayName = "LkneeFB"

pxr/usd/sdf/testenv/testSdfParsing.testenv/baseline/187_displayName_metadata.sdf

@@ -7,7 +7,9 @@
 
 class MfScope "Rig"
 {
-    def MfScope "Leg"
+    def MfScope "Leg" (
+        displayName = "Foo"
+    )
     {
         custom rel foo = </Rig/Leg.kneeFB> (
             displayName = "Lfoo"

pxr/usd/usd/testenv/testUsdMetadata.cpp

@@ -106,6 +106,7 @@ int main() {
         _VerifyMetadata(prim, true, SdfFieldKeys->Active);
         _VerifyMetadata(prim, true, SdfFieldKeys->Hidden);
         _VerifyMetadata(prim, TfToken("DummyType"), SdfFieldKeys->TypeName);
+        _VerifyMetadata(prim, string("Display Name"), SdfFieldKeys->DisplayName);
 
         // attribute metadata
         _VerifyMetadata(attr, string("hello"), SdfFieldKeys->Comment);

pxr/usd/usd/testenv/testUsdMetadata.py

@@ -284,6 +284,13 @@ def test_DisplayName(self):
             attr = foo.CreateAttribute("attr", Sdf.ValueTypeNames.String)
             rel = foo.CreateRelationship("rel")
 
+            # verify display name metadata on prim
+            self.assertEqual(foo.GetMetadata("displayName"), None)
+            self.assertEqual(foo.HasAuthoredMetadata("displayName"), False)
+            self.assertEqual(foo.SetMetadata("displayName", "foo"), True)
+            self.assertEqual(foo.GetMetadata("displayName"), "foo")
+            self.assertEqual(foo.HasAuthoredMetadata("displayName"), True)
+
             for prop in [attr, rel]:
                 self.assertEqual(prop.GetDisplayName(), "")
                 self.assertFalse(prop.HasAuthoredDisplayName())

pxr/usd/usd/testenv/testUsdSchemaRegistry.py

@@ -41,8 +41,9 @@ def test_PrimMetadata(self):
         self.assertTrue(primDef)
 
         self.assertEqual(set(primDef.ListMetadataFields()), 
-            set(["typeName", "testCustomMetadata", "hidden", "documentation"]))
+            set(["typeName", "testCustomMetadata", "hidden", "documentation", "displayName"]))
         self.assertEqual(primDef.GetMetadata("typeName"), "MetadataTest")
+        self.assertEqual(primDef.GetMetadata("displayName"), "Display Name")
         self.assertEqual(primDef.GetMetadata("documentation"),
                          "Testing documentation metadata")
         self.assertEqual(primDef.GetMetadata("hidden"), True)
@@ -419,6 +420,7 @@ def _VerifyExpectedPrimData(layer, path, expectedPrimFields,
         # Expected fields and properties from the concrete schema.
         concretePrimDefPrimFields = {
             "apiSchemas" : Sdf.TokenListOp.CreateExplicit([]),
+            "displayName": "Display Name",
             "documentation" : concretePrimDef.GetDocumentation(),
             "hidden" : True,
             "testCustomMetadata" : "garply",

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

@@ -19,6 +19,7 @@ class "AbstractTest" (
 }
 
 class MetadataTest "MetadataTest" (
+    displayName = "Display Name"
     doc = "Testing documentation metadata"
     hidden = true
     testCustomMetadata = "garply"

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

@@ -35,6 +35,7 @@ class "AbstractTest" (
 
 class MetadataTest "MetadataTest" (
     inherits = </AbstractTest>
+    displayName = "Display Name"
     doc = "Testing documentation metadata"
     hidden = true
     testCustomMetadata = "garply"

pxr/usdImaging/usdviewq/appController.py

@@ -982,6 +982,13 @@ def __init__(self, parserData, resolverContextFn):
             self._ui.actionShow_Abstract_Prims.triggered.connect(
                 self._toggleShowAbstractPrims)
 
+            # nv begin #prim-display-name
+
+            self._ui.actionShow_Prim_DisplayName.triggered.connect(
+                self._toggleShowPrimDisplayName)
+
+            # nv end
+
             # Since setting column visibility is probably not a common
             # operation, it's actually good to have Columns at the end.
             self._ui.menuShow.addSeparator()
@@ -2185,16 +2192,31 @@ def _findPrims(self, pattern, useRegex=True):
             pattern = pattern.lower()
             isMatch = lambda x: pattern in x.lower()
 
-        matches = [prim.GetPath() for prim
-                   in Usd.PrimRange.Stage(self._dataModel.stage,
-                                             self._displayPredicate)
-                   if isMatch(prim.GetName())]
+        # nv begin #prim-display-name
+        if self._dataModel.viewSettings.showPrimDisplayNames:
+            matches = [prim.GetPath() for prim
+                    in Usd.PrimRange.Stage(self._dataModel.stage,
+                                                self._displayPredicate)
+                    if (isMatch(prim.GetMetadata("displayName")) or isMatch(prim.GetName()))]
+        else:
+            matches = [prim.GetPath() for prim
+                    in Usd.PrimRange.Stage(self._dataModel.stage,
+                                                self._displayPredicate)
+                    if isMatch(prim.GetName())]
 
         if self._dataModel.viewSettings.showAllPrototypePrims:
-            for prototype in self._dataModel.stage.GetPrototypes():
-                matches += [prim.GetPath() for prim
-                            in Usd.PrimRange(prototype, self._displayPredicate)
-                            if isMatch(prim.GetName())]
+            if self._dataModel.viewSettings.showPrimDisplayNames:
+                for prototype in self._dataModel.stage.GetPrototypes():
+                    matches += [prim.GetPath() for prim
+                                in Usd.PrimRange(prototype, self._displayPredicate)
+                                if (isMatch(prim.GetMetadata("displayName")) or isMatch(prim.GetName()))]
+            else:
+                for prototype in self._dataModel.stage.GetPrototypes():
+                    matches += [prim.GetPath() for prim
+                                in Usd.PrimRange(prototype, self._displayPredicate)
+                                if isMatch(prim.GetName())]
+
+        #nv end
 
         return matches
 
@@ -3189,6 +3211,15 @@ def _toggleShowAbstractPrims(self):
         self._dataModel.selection.removeAbstractPrims()
         self._resetPrimView()
 
+    # nv begin #prim-display-name
+
+    def _toggleShowPrimDisplayName(self):
+        self._dataModel.viewSettings.showPrimDisplayNames = (
+            self._ui.actionShow_Prim_DisplayName.isChecked())
+        self._resetPrimView()
+
+    # nv end
+
     def _toggleRolloverPrimInfo(self):
         self._dataModel.viewSettings.rolloverPrimInfo = (
             self._ui.actionRollover_Prim_Info.isChecked())
@@ -5234,6 +5265,11 @@ def _refreshShowPrimMenu(self):
         self._ui.actionShow_Abstract_Prims.setChecked(
             self._dataModel.viewSettings.showAbstractPrims)
 
+        # nv begin #prim-display-name
+        self._ui.actionShow_Prim_DisplayName.setChecked(
+            self._dataModel.viewSettings.showPrimDisplayNames)
+        # nv end
+
     def _refreshRedrawOnScrub(self):
         self._ui.redrawOnScrub.setChecked(
             self._dataModel.viewSettings.redrawOnScrub)

pxr/usdImaging/usdviewq/mainWindowUI.ui

@@ -159,6 +159,7 @@
             <addaction name="actionShow_All_Prototype_Prims"/>
             <addaction name="actionShow_Undefined_Prims"/>
             <addaction name="actionShow_Abstract_Prims"/>
+            <addaction name="actionShow_Prim_DisplayName" />
            </widget>
            <addaction name="menuNavigation"/>
            <addaction name="menuShow"/>
@@ -2660,6 +2661,14 @@
     <string>Abstract Prims (Classes)</string>
    </property>
   </action>
+  <action name="actionShow_Prim_DisplayName">
+   <property name="checkable">
+    <bool>true</bool>
+   </property>
+   <property name="text">
+    <string>Use Display Name (Prims)</string>
+   </property>
+  </action>
   <action name="actionPick_Prims">
    <property name="checkable">
     <bool>true</bool>

pxr/usdImaging/usdviewq/primViewItem.py

@@ -129,6 +129,7 @@ def _isComputedDrawModeInherited(self, parentDrawModeIsInherited=None):
         return False
 
     def _extractInfo(self, info):
+        # nv begin #prim-display-name
         ( self.hasArcs,
           self.active,
           self.imageable,
@@ -141,7 +142,10 @@ def _extractInfo(self, info):
           isVisibilityInherited,
           self.visVaries,
           self.name,
-          self.typeName ) = info
+          self.typeName,
+          self.displayName ) = info
+
+        # nv end
 
         parent = self.parent()
         parentIsPrimViewItem = isinstance(parent, PrimViewItem)
@@ -227,7 +231,12 @@ def _GetForegroundColor(self):
 
     def _nameData(self, role):
         if role == QtCore.Qt.DisplayRole:
-            return self.name
+            # nv begin #prim-display-name
+            if self._appController._dataModel.viewSettings.showPrimDisplayNames:
+                return self.displayName if self.displayName != "" else self.name
+            else:
+                return self.name
+            # nv end
         elif role == QtCore.Qt.FontRole:
             # Abstract prims are also considered defined; since we want
             # to distinguish abstract defined prims from non-abstract
@@ -256,6 +265,12 @@ def _nameData(self, role):
                 toolTip = 'Inactive ' + toolTip
             elif self.isInstance:
                 toolTip = 'Instanced ' + toolTip
+
+            # nv begin #prim-display-name
+            # tooltip should always show both name and display name
+            toolTip = toolTip + "<br>Name: " + self.name + "<br>Display Name: " + self.displayName
+            # nv end
+
             if self.hasArcs:
                 toolTip = toolTip + "<br>Has composition arcs"
             return toolTip

pxr/usdImaging/usdviewq/utils.cpp

@@ -104,6 +104,19 @@ UsdviewqUtils::PrimInfo::PrimInfo(const UsdPrim &prim, const UsdTimeCode time)
     else
         name = _tokens->root.GetString();
     typeName = prim.GetTypeName().GetString();
+
+    // nv begin #prim-display-name
+
+    if (prim.HasAuthoredMetadata(SdfFieldKeys->DisplayName))
+    {
+        prim.GetMetadata<std::string>(SdfFieldKeys->DisplayName, &displayName);
+    }
+    else
+    {
+        displayName = "";
+    }
+
+    // nv end
 }
 
 /*static*/

pxr/usdImaging/usdviewq/utils.h

@@ -59,6 +59,10 @@ class UsdviewqUtils {
         bool visVaries;
         std::string name;
         std::string typeName;
+
+        // nv begin #prim-display-name
+        std::string displayName;
+        // nv end
     };
 
     /// For the given \p stage and \p schemaType, return all active, defined

pxr/usdImaging/usdviewq/viewSettingsDataModel.py

@@ -195,6 +195,9 @@ def __init__(self, rootDataModel, parent):
 
         self._showUndefinedPrims = self.stateProperty("showUndefinedPrims", default=False)
         self._showAbstractPrims = self.stateProperty("showAbstractPrims", default=False)
+        # nv begin #prim-display-name
+        self._showPrimDisplayNames = self.stateProperty("showPrimDisplayNames", default=True)
+        # nv end
         self._rolloverPrimInfo = self.stateProperty("rolloverPrimInfo", default=False)
         self._displayCameraOracles = self.stateProperty("cameraOracles", default=False)
         self._cameraMaskMode = self.stateProperty("cameraMaskMode", default=CameraMaskModes.NONE)
@@ -259,6 +262,9 @@ def onSaveState(self, state):
         state["showAllMasterPrims"] = self._showAllPrototypePrims
         state["showUndefinedPrims"] = self._showUndefinedPrims
         state["showAbstractPrims"] = self._showAbstractPrims
+        # nv begin #prim-display-name
+        state["showPrimDisplayNames"] = self._showPrimDisplayNames
+        # nv end
         state["rolloverPrimInfo"] = self._rolloverPrimInfo
         state["cameraOracles"] = self._displayCameraOracles
         state["cameraMaskMode"] = self._cameraMaskMode
@@ -635,6 +641,18 @@ def showAbstractPrims(self):
     def showAbstractPrims(self, value):
         self._showAbstractPrims = value
 
+    # nv begin #prim-display-name
+    @property
+    def showPrimDisplayNames(self):
+        return self._showPrimDisplayNames
+
+    @showPrimDisplayNames.setter
+    @invisibleViewSetting
+    def showPrimDisplayNames(self, value):
+        self._showPrimDisplayNames = value
+
+    # nv end
+
     @property
     def rolloverPrimInfo(self):
         return self._rolloverPrimInfo

pxr/usdImaging/usdviewq/wrapUtils.cpp

@@ -48,6 +48,7 @@ _GetPrimInfo(UsdPrim const &prim, UsdTimeCode time)
 {
     UsdviewqUtils::PrimInfo info = UsdviewqUtils::GetPrimInfo(prim, time);
 
+    // nv begin #prim-display-name
     return boost::python::make_tuple(info.hasCompositionArcs,
                                      info.isActive,
                                      info.isImageable,
@@ -60,7 +61,10 @@ _GetPrimInfo(UsdPrim const &prim, UsdTimeCode time)
                                      info.isVisibilityInherited,
                                      info.visVaries,
                                      info.name,
-                                     info.typeName);
+                                     info.typeName,
+                                     info.displayName);
+
+    // nv end
 }
 
 } // anonymous namespace