Route visibility edits and run clang-format

lib/mayaUsd/ufe/UsdUndoVisibleCommand.cpp

@@ -17,6 +17,7 @@
 
 #include <mayaUsd/ufe/Utils.h>
 #include <mayaUsd/undo/UsdUndoBlock.h>
+#include <mayaUsd/utils/editRouter.h>
 
 #include <pxr/usd/usdGeom/imageable.h>
 
@@ -27,6 +28,7 @@ UsdUndoVisibleCommand::UsdUndoVisibleCommand(const UsdPrim& prim, bool vis)
     : Ufe::UndoableCommand()
     , _prim(prim)
     , _visible(vis)
+    , _layer(getEditRouterLayer(PXR_NS::TfToken("visibility"), prim))
 {
 }
 
@@ -52,6 +54,8 @@ void UsdUndoVisibleCommand::execute()
 
     UsdUndoBlock undoBlock(&_undoableItem);
 
+    EditTargetGuard guard(_prim, _layer);
+
     _visible ? primImageable.MakeVisible() : primImageable.MakeInvisible();
 }
 

lib/mayaUsd/ufe/UsdUndoVisibleCommand.h

@@ -52,6 +52,8 @@ class MAYAUSD_CORE_PUBLIC UsdUndoVisibleCommand : public Ufe::UndoableCommand
 
     bool _visible;
 
+    PXR_NS::SdfLayerHandle _layer;
+
     UsdUndoableItem _undoableItem;
 
 }; // UsdUndoVisibleCommand

lib/mayaUsd/utils/editRouter.cpp

@@ -264,7 +264,8 @@ EditRouters defaultEditRouters()
     PXR_NAMESPACE_USING_DIRECTIVE
 
     EditRouters   defaultRouters;
-    TfTokenVector defaultOperations = { TfToken("parent"), TfToken("duplicate") };
+    TfTokenVector defaultOperations
+        = { TfToken("parent"), TfToken("duplicate"), TfToken("visibility") };
     for (const auto& o : defaultOperations) {
         defaultRouters[o] = std::make_shared<CxxEditRouter>(editTargetLayer);
     }
@@ -291,6 +292,27 @@ bool restoreDefaultEditRouter(const PXR_NS::TfToken& operation)
     return true;
 }
 
+static void setEditTarget(const PXR_NS::UsdPrim& prim, const PXR_NS::UsdEditTarget& editTarget)
+{
+    prim.GetStage()->SetEditTarget(editTarget);
+}
+
+EditTargetGuard::EditTargetGuard(
+    const PXR_NS::UsdPrim&       prim,
+    const PXR_NS::UsdEditTarget& editTarget)
+    : _prim(prim)
+    , _prevEditTarget(_prim.GetStage()->GetEditTarget())
+{
+    // Set editTarget as the edit target
+    setEditTarget(_prim, editTarget);
+}
+
+EditTargetGuard::~EditTargetGuard()
+{
+    // Restore editTarget to the stage's previous edit target
+    setEditTarget(_prim, _prevEditTarget);
+}
+
 EditRouter::Ptr getEditRouter(const PXR_NS::TfToken& operation)
 {
     auto foundRouter = editRouters.find(operation);

lib/mayaUsd/utils/editRouter.h

@@ -64,6 +64,23 @@ class MAYAUSD_CORE_PUBLIC CxxEditRouter : public EditRouter
     EditRouterCb _cb;
 };
 
+// Guard class that holds previous edit target
+// Note : _prevEditTarget is a by-value copy rather than reference
+// since a reference does not change the edit target upon destruction
+class MAYAUSD_CORE_PUBLIC EditTargetGuard
+{
+public:
+    EditTargetGuard(const PXR_NS::UsdPrim& prim, const PXR_NS::UsdEditTarget& editTarget);
+
+    ~EditTargetGuard();
+
+private:
+    const PXR_NS::UsdPrim& _prim;
+
+    // The previous edit target, as a by-value copy.
+    const PXR_NS::UsdEditTarget _prevEditTarget;
+};
+
 using EditRouters
     = PXR_NS::TfHashMap<PXR_NS::TfToken, EditRouter::Ptr, PXR_NS::TfToken::HashFunctor>;
 

test/lib/ufe/CMakeLists.txt

@@ -39,6 +39,7 @@ if(CMAKE_UFE_V2_FEATURES_AVAILABLE)
         testTransform3dChainOfResponsibility.py
         testTransform3dTranslate.py
         testUIInfoHandler.py
+        testVisibilityCmd.py
         testObservableScene.py
     )
 

test/lib/ufe/testVisibilityCmd.py

@@ -0,0 +1,119 @@
+#!/usr/bin/env python 
+
+import fixturesUtils
+from maya import cmds
+from maya import standalone
+import mayaUsd.ufe
+import mayaUtils
+import ufe
+import unittest
+import usdUtils
+
+def filterUsdStr(usdSceneStr):
+    '''Remove empty lines and lines starting with pound character.'''
+    nonBlankLines = filter(None, [l.rstrip() for l in usdSceneStr.splitlines()])
+    finalLines = [l for l in nonBlankLines if not l.startswith('#')]
+    return '\n'.join(finalLines)
+
+def getSessionLayer(context, routingData):
+    prim = context.get('prim')
+    if prim is None:
+        print('Prim not in context')
+        return
+
+    routingData['layer'] = prim.GetStage().GetSessionLayer().identifier
+
+def createUfePathSegment(usdPath):
+    """
+        Create an UFE path from a given usd path.
+        Args:
+            usdPath (str): The usd path to use
+        Returns :
+            PathSegment of the given usdPath
+    """
+    return ufe.PathSegment(usdPath, mayaUsd.ufe.getUsdRunTimeId(), '/')
+
+class VisibilityCmdTestCase(unittest.TestCase):
+     '''Verify the Maya Edit Router for visibility.'''
+     pluginsLoaded = False
+
+     @classmethod
+     def setUpClass(cls):
+        fixturesUtils.readOnlySetUpClass(__file__, loadPlugin=False)
+        if not cls.pluginsLoaded:
+            cls.pluginsLoaded = mayaUtils.isMayaUsdPluginLoaded()
+
+     @classmethod
+     def tearDownClass(cls):
+        standalone.uninitialize()
+
+     def setUp(self):
+        ''' Called initially to set up the Maya test environment '''
+        # Load plugins
+        self.assertTrue(self.pluginsLoaded)
+        cmds.select(clear=True)
+
+     def testEditRouter(self):
+        '''Test edit router functionality.'''
+
+        cmds.file(new=True, force=True)
+        import mayaUsd_createStageWithNewLayer
+
+        # Create the following hierarchy:
+        #
+        # ps
+        #  |_ A
+        #  |_ B
+        #
+
+        psPathStr = mayaUsd_createStageWithNewLayer.createStageWithNewLayer()
+        stage = mayaUsd.lib.GetPrim(psPathStr).GetStage()
+        stage.DefinePrim('/A', 'Xform')
+        stage.DefinePrim('/B', 'Xform')
+
+        psPath = ufe.PathString.path(psPathStr)
+        psPathSegment = psPath.segments[0]
+        aPath = ufe.Path([psPathSegment, usdUtils.createUfePathSegment('/A')])
+        bPath = ufe.Path([psPathSegment, usdUtils.createUfePathSegment('/B')])
+        a = ufe.Hierarchy.createItem(aPath)
+        b = ufe.Hierarchy.createItem(bPath)
+
+        # Select /A
+        sn = ufe.GlobalSelection.get()
+        sn.clear()
+        sn.append(a)
+
+        # Hide A
+        cmds.hide()
+
+        # Get the session layer
+        prim = mayaUsd.ufe.ufePathToPrim("|stage1|stageShape1,/A")
+        sessionLayer = prim.GetStage().GetSessionLayer()
+
+        # Check that the session layer is empty
+        self.assertTrue(sessionLayer.empty)
+
+        # Register visibility
+        mayaUsd.lib.registerEditRouter('visibility', getSessionLayer)
+
+        # Select /B
+        sn = ufe.GlobalSelection.get()
+        sn.clear()
+        sn.append(b)
+
+        # Hide B
+        cmds.hide()
+
+        # Check that something was written to the session layer
+        self.assertIsNotNone(sessionLayer)
+        self.assertIsNotNone(sessionLayer.GetPrimAtPath('/B'))
+
+        # Check that any visibility changes were written to the session layer
+        self.assertIsNotNone(sessionLayer.GetAttributeAtPath('/B.visibility').default)
+
+        # Check that correct visibility changes were written to the session layer
+        self.assertEqual(filterUsdStr(sessionLayer.ExportToString()),
+            'over "B"\n{\n    token visibility = "invisible"\n}')
+
+if __name__ == '__main__':
+ unittest.main(verbosity=2)