MAYA-104215: improve renaming restriction on prim objects

lib/mayaUsd/ufe/UsdUndoRenameCommand.cpp

@@ -48,7 +48,7 @@ UsdUndoRenameCommand::UsdUndoRenameCommand(const UsdSceneItem::Ptr& srcItem, con
 	_ufeSrcItem = srcItem;
 	_usdSrcPath = prim.GetPath();
 
-    // Every call to rename() (through execute(), undo() or redo()) removes
+	// Every call to rename() (through execute(), undo() or redo()) removes
 	// a prim, which becomes expired.  Since USD UFE scene items contain a
 	// prim, we must recreate them after every call to rename.
 	_usdDstPath = prim.GetParent().GetPath().AppendChild(TfToken(newName.string()));
@@ -59,7 +59,7 @@ UsdUndoRenameCommand::UsdUndoRenameCommand(const UsdSceneItem::Ptr& srcItem, con
 	}
 
     // if the current layer doesn't have any opinions that affects selected prim
-    if (!MayaUsdUtils::doesLayerHavePrimSpec(prim)) {
+    if (!MayaUsdUtils::doesEditTargetLayerHavePrimSpec(prim)) {
         auto possibleTargetLayer = MayaUsdUtils::strongestLayerWithPrimSpec(prim);
         std::string err = TfStringPrintf("Cannot rename [%s] defined on another layer. " 
                                          "Please set [%s] as the target layer to proceed", 
@@ -69,16 +69,16 @@ UsdUndoRenameCommand::UsdUndoRenameCommand(const UsdSceneItem::Ptr& srcItem, con
     }
     else
     {
-        auto layers = MayaUsdUtils::layersWithOpinion(prim);
+        auto layers = MayaUsdUtils::layersWithPrimSpec(prim);
 
         if (layers.size() > 1) {
-            std::string layerNames;
+            std::string layerDisplayNames;
             for (auto layer : layers) {
-                layerNames.append("[" + layer->GetDisplayName() + "]" + ",");
+                layerDisplayNames.append("[" + layer->GetDisplayName() + "]" + ",");
             }
-            layerNames.pop_back();
+            layerDisplayNames.pop_back();
             std::string err = TfStringPrintf("Cannot rename [%s] with definitions or opinions on other layers. "
-                                             "Opinions exist in %s", prim.GetName().GetString(), layerNames);
+                                             "Opinions exist in %s", prim.GetName().GetString(), layerDisplayNames);
             throw std::runtime_error(err.c_str());
         }
     }

lib/usd/utils/util.cpp

@@ -47,22 +47,22 @@ defPrimSpecLayer(const UsdPrim& prim)
 }
 
 std::vector<SdfLayerHandle>
-layersWithOpinion(const UsdPrim& prim)
+layersWithPrimSpec(const UsdPrim& prim)
 {
     // get the list of PrimSpecs that provide opinions for this prim
-    // ordered from strongest to weakest opinion.
+    // ordered from strongest to weakest.
     const auto& primStack = prim.GetPrimStack();
 
-    std::vector<SdfLayerHandle> layersWithOpion;
+    std::vector<SdfLayerHandle> layersWithPrimSpec;
     for (auto primSpec : primStack) {
-        layersWithOpion.emplace_back(primSpec->GetLayer());
+        layersWithPrimSpec.emplace_back(primSpec->GetLayer());
     }
 
-    return layersWithOpion;
+    return layersWithPrimSpec;
 }
 
 bool
-doesLayerHavePrimSpec(const UsdPrim& prim)
+doesEditTargetLayerHavePrimSpec(const UsdPrim& prim)
 {
     auto editTarget = prim.GetStage()->GetEditTarget();
     auto layer = editTarget.GetLayer();

lib/usd/utils/util.h

@@ -29,15 +29,15 @@ namespace MayaUsdUtils {
     MAYA_USD_UTILS_PUBLIC
     SdfLayerHandle defPrimSpecLayer(const UsdPrim&);
 
-    //! Return a list of layers in strength order that have opinions on a prim
+    //! Return a list of layers in strength order that have opinions on the argument prim.
     MAYA_USD_UTILS_PUBLIC
-    std::vector<SdfLayerHandle> layersWithOpinion(const UsdPrim&);
+    std::vector<SdfLayerHandle> layersWithPrimSpec(const UsdPrim&);
 
-    //! Check if a layer has any opinions that affects a particular prim
+    //! Check if a layer has any opinions that affects on the argument prim.
     MAYA_USD_UTILS_PUBLIC
-    bool doesLayerHavePrimSpec(const UsdPrim&);
+    bool doesEditTargetLayerHavePrimSpec(const UsdPrim&);
 
-    //! Return the layer that has any opinions on a particular prim
+    //! Return the strongest layer that has an opinion on the argument prim.
     MAYA_USD_UTILS_PUBLIC
     SdfLayerHandle strongestLayerWithPrimSpec(const UsdPrim&);
 

test/lib/ufe/testMatrices.py

@@ -62,9 +62,8 @@ def setUp(self):
         # Load plugins
         self.assertTrue(self.pluginsLoaded)
 
-        # Read in a simple USD scene: a mesh cylinder at the origin.
-        filePath = os.path.join(os.path.dirname(os.path.realpath(__file__)), "test-samples", "cylinder", "usdCylinder.ma" )
-        cmds.file(filePath, force=True, open=True)
+        # Open usdCylinder.ma scene in test-samples
+        mayaUtils.openCylinderScene()
 
     def assertMatrixAlmostEqual(self, ma, mb):
         for ra, rb in zip(ma, mb):

test/lib/ufe/testObject3d.py

@@ -121,11 +121,8 @@ def testBoundingBox(self):
     def testAnimatedBoundingBox(self):
         '''Test the Object3d bounding box interface for animated geometry.'''
 
-        # Load up a scene with a sphere that has an animated radius, with
-        # time connected to the proxy shape.
-        filePath = os.path.join(os.path.dirname(os.path.realpath(__file__)), "test-samples", "sphereAnimatedRadius", "sphereAnimatedRadiusProxyShape.ma" )
-
-        cmds.file(filePath, force=True, open=True)
+        # Open sphereAnimatedRadiusProxyShape.ma scene in test-samples
+        mayaUtils.openSphereAnimatedRadiusScene()
 
         # The extents of the sphere are copied from the .usda file.
         expected = [

test/lib/ufe/testRename.py

@@ -98,49 +98,66 @@ def assertStageAndPrimAccess(
     def testRename(self):
         '''Rename USD node.'''
 
-        # Select a USD object.
-        ball35Path = ufe.Path([
-            mayaUtils.createUfePathSegment(
-                "|world|transform1|proxyShape1"),
-             usdUtils.createUfePathSegment("/Room_set/Props/Ball_35")])
-        ball35Item = ufe.Hierarchy.createItem(ball35Path)
-        ball35Hierarchy = ufe.Hierarchy.hierarchy(ball35Item)
-        propsItem = ball35Hierarchy.parent()
+        # open usdCylinder.ma scene in test-samples
+        mayaUtils.openCylinderScene()
+
+        # clear selection to start off
+        cmds.select(clear=True)
+
+        # select a USD object.
+        mayaPathSegment = mayaUtils.createUfePathSegment('|world|mayaUsdTransform|shape')
+        usdPathSegment = usdUtils.createUfePathSegment('/pCylinder1')
+        cylinderPath = ufe.Path([mayaPathSegment, usdPathSegment])
+        cylinderItem = ufe.Hierarchy.createItem(cylinderPath)
+        cylinderHierarchy = ufe.Hierarchy.hierarchy(cylinderItem)
+        propsItem = cylinderHierarchy.parent()
 
         propsHierarchy = ufe.Hierarchy.hierarchy(propsItem)
         propsChildrenPre = propsHierarchy.children()
 
-        ufe.GlobalSelection.get().append(ball35Item)
+        ufe.GlobalSelection.get().append(cylinderItem)
+
+        # get the USD stage
+        stage = mayaUsd.ufe.getStage(str(mayaPathSegment))
 
-        newName = 'Ball_35_Renamed'
+        # check GetLayerStack behavior
+        self.assertEqual(stage.GetLayerStack()[0], stage.GetSessionLayer())
+        self.assertEqual(stage.GetEditTarget().GetLayer(), stage.GetSessionLayer())
+
+        # set the edit target to the root layer
+        stage.SetEditTarget(stage.GetRootLayer())
+        self.assertEqual(stage.GetEditTarget().GetLayer(), stage.GetRootLayer())
+
+        # rename
+        newName = 'pCylinder1_Renamed'
         cmds.rename(newName)
 
         # The renamed item is in the selection.
         snIter = iter(ufe.GlobalSelection.get())
-        ball35RenItem = next(snIter)
-        ball35RenName = str(ball35RenItem.path().back())
+        pCylinder1Item = next(snIter)
+        pCylinder1RenName = str(pCylinder1Item.path().back())
 
-        self.assertEqual(ball35RenName, newName)
+        self.assertEqual(pCylinder1RenName, newName)
 
         # MAYA-92350: should not need to re-bind hierarchy interface objects
         # with their item.
         propsHierarchy = ufe.Hierarchy.hierarchy(propsItem)
         propsChildren = propsHierarchy.children()
 
         self.assertEqual(len(propsChildren), len(propsChildrenPre))
-        self.assertIn(ball35RenItem, propsChildren)
+        self.assertIn(pCylinder1Item, propsChildren)
 
         cmds.undo()
 
         def childrenNames(children):
-            return [str(child.path().back()) for child in children]
+           return [str(child.path().back()) for child in children]
 
         propsHierarchy = ufe.Hierarchy.hierarchy(propsItem)
         propsChildren = propsHierarchy.children()
         propsChildrenNames = childrenNames(propsChildren)
 
-        self.assertNotIn(ball35RenName, propsChildrenNames)
-        self.assertIn('Ball_35', propsChildrenNames)
+        self.assertNotIn(pCylinder1RenName, propsChildrenNames)
+        self.assertIn('pCylinder1', propsChildrenNames)
         self.assertEqual(len(propsChildren), len(propsChildrenPre))
 
         cmds.redo()
@@ -149,7 +166,52 @@ def childrenNames(children):
         propsChildren = propsHierarchy.children()
         propsChildrenNames = childrenNames(propsChildren)
 
-        self.assertIn(ball35RenName, propsChildrenNames)
-        self.assertNotIn('Ball_35', propsChildrenNames)
+        self.assertIn(pCylinder1RenName, propsChildrenNames)
+        self.assertNotIn('pCylinder1', propsChildrenNames)
         self.assertEqual(len(propsChildren), len(propsChildrenPre))
 
+    def testRenameRestriction(self):
+        '''Restrict renaming USD node. Cannot rename a prim defined on another layer.'''
+
+        # select a USD object.
+        mayaPathSegment = mayaUtils.createUfePathSegment('|world|transform1|proxyShape1')
+        usdPathSegment = usdUtils.createUfePathSegment('/Room_set/Props/Ball_35')
+        ball35Path = ufe.Path([mayaPathSegment, usdPathSegment])
+        ball35Item = ufe.Hierarchy.createItem(ball35Path)
+
+        ufe.GlobalSelection.get().append(ball35Item)
+
+        # get the USD stage
+        stage = mayaUsd.ufe.getStage(str(mayaPathSegment))
+
+        # check GetLayerStack behavior
+        self.assertEqual(stage.GetLayerStack()[0], stage.GetSessionLayer())
+        self.assertEqual(stage.GetEditTarget().GetLayer(), stage.GetSessionLayer())
+
+        # expect the exception happens
+        with self.assertRaises(RuntimeError):
+            newName = 'Ball_35_Renamed'
+            cmds.rename(newName)
+
+    def testRenameRestriction2(self):
+        '''Restrict renaming USD node. Cannot rename a prim with definitions or opinions on other layers.'''
+
+        # select a USD object.
+        mayaPathSegment = mayaUtils.createUfePathSegment('|world|transform1|proxyShape1')
+        usdPathSegment = usdUtils.createUfePathSegment('/Room_set/Props/Ball_35')
+        ball35Path = ufe.Path([mayaPathSegment, usdPathSegment])
+        ball35Item = ufe.Hierarchy.createItem(ball35Path)
+
+        ufe.GlobalSelection.get().append(ball35Item)
+
+        # get the USD stage
+        stage = mayaUsd.ufe.getStage(str(mayaPathSegment))
+
+        # set the edit target to Assembly_room_set.usda
+        stage.SetEditTarget(stage.GetLayerStack()[2])
+        self.assertEqual(stage.GetEditTarget().GetLayer().GetDisplayName(), "Assembly_room_set.usda")
+
+        # expect the exception happens
+        with self.assertRaises(RuntimeError):
+           newName = 'Ball_35_Renamed'
+           cmds.rename(newName)

test/lib/ufe/testRotatePivot.py

@@ -62,12 +62,8 @@ def setUp(self):
         # Load plugins
         self.assertTrue(self.pluginsLoaded)
 
-        # Create a simple USD scene.  Ideally this would be done
-        # programmatically, but as of 28-Jun-2018 attempts to do so have
-        # resulted in a file that crashes Maya on pickWalk of the scene.
-        # Use a saved scene read from file instead.
-        filePath = os.path.join(os.path.dirname(os.path.realpath(__file__)), "test-samples", "twoSpheres", "twoSpheres.ma" )
-        cmds.file(filePath, force=True, open=True)
+        # Open twoSpheres.ma scene in test-samples
+        mayaUtils.openTwoSpheresScene()
 
     def testRotatePivot(self):
         # mayaSphere is at (10, 0, 10) in local space, and since it has no

test/lib/ufe/ufeTestUtils/mayaUtils.py

@@ -126,4 +126,15 @@ def openTopLayerScene():
     # Open top_layer file which contains the USD scene
     filePath = os.path.join(os.path.dirname(os.path.realpath(__file__)), "..", "test-samples", "ballset", "StandaloneScene", "top_layer.ma" )
     cmds.file(filePath, force=True, open=True)
-
+
+def openCylinderScene():
+    filePath = os.path.join(os.path.dirname(os.path.realpath(__file__)), "..", "test-samples", "cylinder", "usdCylinder.ma" )
+    cmds.file(filePath, force=True, open=True)
+
+def openTwoSpheresScene():
+    filePath = os.path.join(os.path.dirname(os.path.realpath(__file__)), "..", "test-samples", "twoSpheres", "twoSpheres.ma" )
+    cmds.file(filePath, force=True, open=True)
+
+def openSphereAnimatedRadiusScene():
+    filePath = os.path.join(os.path.dirname(os.path.realpath(__file__)), "..", "test-samples", "sphereAnimatedRadius", "sphereAnimatedRadiusProxyShape.ma" )
+    cmds.file(filePath, force=True, open=True)