MAYA-125918 auto re-edit when merging a Maya Ref

lib/mayaUsd/fileio/primUpdaterContext.cpp

@@ -16,6 +16,8 @@
 //
 #include "primUpdaterContext.h"
 
+#include <memory>
+
 PXR_NAMESPACE_OPEN_SCOPE
 
 UsdMayaPrimUpdaterContext::UsdMayaPrimUpdaterContext(
@@ -28,6 +30,7 @@ UsdMayaPrimUpdaterContext::UsdMayaPrimUpdaterContext(
     , _pathMap(pathMap)
     , _userArgs(userArgs)
     , _args(UsdMayaPrimUpdaterArgs::createFromDictionary(userArgs))
+    , _additionalCommands(std::make_shared<Ufe::CompositeUndoableCommand>())
 {
 }
 
@@ -41,4 +44,9 @@ MDagPath UsdMayaPrimUpdaterContext::MapSdfPathToDagPath(const SdfPath& sdfPath)
     return found == _pathMap->end() ? MDagPath() : found->second;
 }
 
+void UsdMayaPrimUpdaterContext::SetUsdPathToDagPathMap(const UsdPathToDagPathMapPtr& pathMap)
+{
+    _pathMap = pathMap;
+}
+
 PXR_NAMESPACE_CLOSE_SCOPE

lib/mayaUsd/fileio/primUpdaterContext.h

@@ -27,6 +27,7 @@
 #include <pxr/usd/usd/timeCode.h>
 
 #include <maya/MDagPath.h>
+#include <ufe/undoableCommand.h>
 
 #include <memory> // shared_ptr
 
@@ -68,16 +69,29 @@ class UsdMayaPrimUpdaterContext
     MAYAUSD_CORE_PUBLIC
     MDagPath MapSdfPathToDagPath(const SdfPath& sdfPath) const;
 
+    /// \brief Sets the USD path to DAG path map.
+    MAYAUSD_CORE_PUBLIC
+    void SetUsdPathToDagPathMap(const UsdPathToDagPathMapPtr& pathMap);
+
+    /// \brief Returns the UFE composite command that can be extended and will be executed when
+    ///        the pull or push have completed successfully.
+    const std::shared_ptr<Ufe::CompositeUndoableCommand>& GetAdditionalFinalCommands() const
+    {
+        return _additionalCommands;
+    }
+
     const MayaUsd::ufe::ReplicateExtrasFromUSD _pullExtras;
     const MayaUsd::ufe::ReplicateExtrasToUSD   _pushExtras;
 
 private:
-    const UsdTimeCode&           _timeCode;
-    const UsdStageRefPtr         _stage;
-    const UsdPathToDagPathMapPtr _pathMap;
+    const UsdTimeCode&     _timeCode;
+    const UsdStageRefPtr   _stage;
+    UsdPathToDagPathMapPtr _pathMap;
 
     const VtDictionary&          _userArgs;
     const UsdMayaPrimUpdaterArgs _args;
+
+    std::shared_ptr<Ufe::CompositeUndoableCommand> _additionalCommands;
 };
 
 PXR_NAMESPACE_CLOSE_SCOPE

lib/mayaUsd/fileio/primUpdaterManager.cpp

@@ -760,6 +760,14 @@ class PushPullScope
         }
     }
 
+    void end()
+    {
+        if (_controllingFlag) {
+            *_controllingFlag = false;
+            _controllingFlag = nullptr;
+        }
+    }
+
 private:
     bool* _controllingFlag { nullptr };
 };
@@ -873,6 +881,12 @@ class RemovePullVariantInfoUndoItem : public MayaUsd::OpUndoItem
 };
 #endif
 
+void executeAdditionalCommands(const UsdMayaPrimUpdaterContext& context)
+{
+    std::shared_ptr<Ufe::CompositeUndoableCommand> cmds = context.GetAdditionalFinalCommands();
+    UfeCommandUndoItem::execute("Additional final commands", cmds);
+}
+
 } // namespace
 
 PXR_NAMESPACE_OPEN_SCOPE
@@ -922,7 +936,7 @@ bool PrimUpdaterManager::mergeToUsd(
     MString progStr(
         VtDictionaryIsHolding<std::string>(userArgs, "rn_primName") ? "Caching to USD"
                                                                     : "Merging to USD");
-    MayaUsd::ProgressBarScope progressBar(10, progStr);
+    MayaUsd::ProgressBarScope progressBar(11, progStr);
     PushPullScope             scopeIt(_inPushPull);
 
     auto ctxArgs = VtDictionaryOver(userArgs, UsdMayaJobExportArgs::GetDefaultDictionary());
@@ -996,11 +1010,7 @@ bool PrimUpdaterManager::mergeToUsd(
     // 2) Traverse the in-memory layer, creating a prim updater for each prim,
     // and call Push for each updater.  Build a new context with the USD path
     // to Maya path mapping information.
-    UsdMayaPrimUpdaterContext customizeContext(
-        proxyShape->getTime(),
-        proxyStage,
-        ctxArgs,
-        std::get<UsdPathToDagPathMapPtr>(pushCustomizeSrc));
+    context.SetUsdPathToDagPathMap(std::get<UsdPathToDagPathMapPtr>(pushCustomizeSrc));
 
     if (!isCopy) {
         if (!FunctionUndoItem::execute(
@@ -1016,7 +1026,7 @@ bool PrimUpdaterManager::mergeToUsd(
     }
     progressBar.advance();
 
-    if (!pushCustomize(pulledPath, pushCustomizeSrc, customizeContext)) {
+    if (!pushCustomize(pulledPath, pushCustomizeSrc, context)) {
         return false;
     }
     progressBar.advance();
@@ -1073,6 +1083,10 @@ bool PrimUpdaterManager::mergeToUsd(
     }
     progressBar.advance();
 
+    scopeIt.end();
+    executeAdditionalCommands(context);
+    progressBar.advance();
+
     return true;
 }
 
@@ -1093,7 +1107,7 @@ bool PrimUpdaterManager::editAsMaya(const Ufe::Path& path, const VtDictionary& u
         return false;
     }
 
-    MayaUsd::ProgressBarScope progressBar(6, "Converting to Maya Data");
+    MayaUsd::ProgressBarScope progressBar(7, "Converting to Maya Data");
 
     PushPullScope scopeIt(_inPushPull);
 
@@ -1158,6 +1172,10 @@ bool PrimUpdaterManager::editAsMaya(const Ufe::Path& path, const VtDictionary& u
         scene.notify(Ufe::ObjectAdd(ufeItem));
     progressBar.advance();
 
+    scopeIt.end();
+    executeAdditionalCommands(context);
+    progressBar.advance();
+
     return true;
 }
 
@@ -1218,7 +1236,7 @@ bool PrimUpdaterManager::discardPrimEdits(const Ufe::Path& pulledPath)
         return false;
     }
 
-    MayaUsd::ProgressBarScope progressBar(5);
+    MayaUsd::ProgressBarScope progressBar(6);
     PushPullScope             scopeIt(_inPushPull);
 
     // Record all USD modifications in an undo block and item.
@@ -1310,12 +1328,17 @@ bool PrimUpdaterManager::discardPrimEdits(const Ufe::Path& pulledPath)
         scene.notify(Ufe::SubtreeInvalidate(hier->defaultParent()));
     }
     progressBar.advance();
+
+    scopeIt.end();
+    executeAdditionalCommands(context);
+    progressBar.advance();
+
     return true;
 }
 
 bool PrimUpdaterManager::discardOrphanedEdits(const MDagPath& dagPath, const Ufe::Path& pulledPath)
 {
-    MayaUsd::ProgressBarScope progressBar(2);
+    MayaUsd::ProgressBarScope progressBar(3);
     PushPullScope             scopeIt(_inPushPull);
 
     // Unlock the pulled hierarchy, clear the pull information, and remove the
@@ -1356,6 +1379,10 @@ bool PrimUpdaterManager::discardOrphanedEdits(const MDagPath& dagPath, const Ufe
     }
     progressBar.advance();
 
+    scopeIt.end();
+    executeAdditionalCommands(context);
+    progressBar.advance();
+
     return true;
 }
 
@@ -1401,7 +1428,7 @@ bool PrimUpdaterManager::duplicate(
             return false;
         }
 
-        MayaUsd::ProgressBarScope progressBar(2, "Duplicating to Maya Data");
+        MayaUsd::ProgressBarScope progressBar(3, "Duplicating to Maya Data");
 
         auto ctxArgs = VtDictionaryOver(userArgs, UsdMayaJobImportArgs::GetDefaultDictionary());
 
@@ -1427,6 +1454,11 @@ bool PrimUpdaterManager::duplicate(
 
         pullImport(srcPath, srcPrim, context);
         progressBar.advance();
+
+        scopeIt.end();
+        executeAdditionalCommands(context);
+        progressBar.advance();
+
         return true;
     }
     // Copy from DG to USD
@@ -1437,7 +1469,7 @@ bool PrimUpdaterManager::duplicate(
             return false;
         }
 
-        MayaUsd::ProgressBarScope progressBar(7, "Duplicating to USD");
+        MayaUsd::ProgressBarScope progressBar(8, "Duplicating to USD");
 
         auto ctxArgs = VtDictionaryOver(userArgs, UsdMayaJobExportArgs::GetDefaultDictionary());
 
@@ -1494,6 +1526,11 @@ bool PrimUpdaterManager::duplicate(
             Ufe::Scene::instance().notify(Ufe::SubtreeInvalidate(ufeItem));
         }
         progressBar.advance();
+
+        scopeIt.end();
+        executeAdditionalCommands(context);
+        progressBar.advance();
+
         return true;
     }
 
@@ -1573,6 +1610,8 @@ void PrimUpdaterManager::onProxyContentChanged(
             }
         }
     }
+
+    executeAdditionalCommands(context);
 }
 
 PrimUpdaterManager& PrimUpdaterManager::getInstance()

lib/mayaUsd/python/wrapPrimUpdater.cpp

@@ -246,6 +246,10 @@ void wrapPrimUpdaterContext()
             "GetArgs",
             &UsdMayaPrimUpdaterContext::GetArgs,
             boost::python::return_internal_reference<>())
+        .def(
+            "GetAdditionalFinalCommands",
+            &UsdMayaPrimUpdaterContext::GetAdditionalFinalCommands,
+            boost::python::return_internal_reference<>())
         .def("MapSdfPathToDagPath", &UsdMayaPrimUpdaterContext::MapSdfPathToDagPath);
 }
 
@@ -289,6 +293,7 @@ void wrapPrimUpdater()
             boost::python::return_value_policy<boost::python::return_by_value>())
         .def("getUfePath", &This::getUfePath, boost::python::return_internal_reference<>())
         .def("getUsdPrim", &This::getUsdPrim)
+        .def("getContext", &This::getContext, boost::python::return_internal_reference<>())
         .def("isAnimated", &This::isAnimated)
         .staticmethod("isAnimated")
         .def("Register", &PrimUpdaterWrapper::Register)

lib/mayaUsd/ufe/CMakeLists.txt

@@ -7,6 +7,7 @@ target_sources(${PROJECT_NAME}
         ProxyShapeHandler.cpp
         ProxyShapeHierarchy.cpp
         ProxyShapeHierarchyHandler.cpp
+        SetVariantSelectionCommand.cpp
         StagesSubject.cpp
         UsdHierarchy.cpp
         UsdHierarchyHandler.cpp
@@ -74,6 +75,7 @@ if(CMAKE_UFE_V3_FEATURES_AVAILABLE)
     target_sources(${PROJECT_NAME}
         PRIVATE
             # See MayaUIInfoHandler.h comments.
+            EditAsMayaCommand.cpp
             MayaUIInfoHandler.cpp
             PulledObjectHierarchy.cpp
             PulledObjectHierarchyHandler.cpp
@@ -202,6 +204,7 @@ set(HEADERS
     ProxyShapeHandler.h
     ProxyShapeHierarchy.h
     ProxyShapeHierarchyHandler.h
+    SetVariantSelectionCommand.h
     StagesSubject.h
     UsdHierarchy.h
     UsdHierarchyHandler.h
@@ -270,6 +273,7 @@ if(CMAKE_UFE_V3_FEATURES_AVAILABLE)
     list(APPEND HEADERS
         # Not dependent on UFE v3, but used to draw orphaned pulled Maya nodes
         # in the Outliner, which is a UFE v3 feature.
+        EditAsMayaCommand.h
         MayaUIInfoHandler.h
         PulledObjectHierarchy.h
         PulledObjectHierarchyHandler.h

lib/mayaUsd/ufe/EditAsMayaCommand.cpp

@@ -0,0 +1,58 @@
+//
+// Copyright 2022 Autodesk
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+#include "EditAsMayaCommand.h"
+
+#include <mayaUsd/fileio/primUpdaterManager.h>
+#include <mayaUsd/undo/OpUndoItemRecorder.h>
+
+namespace MAYAUSD_NS_DEF {
+namespace ufe {
+
+EditAsMayaUfeCommand::Ptr EditAsMayaUfeCommand::create(const Ufe::Path& path)
+{
+    return std::make_shared<ufe::EditAsMayaUfeCommand>(path);
+}
+
+EditAsMayaUfeCommand::EditAsMayaUfeCommand(const Ufe::Path& path)
+    : _path(path)
+{
+}
+
+EditAsMayaUfeCommand::~EditAsMayaUfeCommand() { }
+
+void EditAsMayaUfeCommand::execute()
+{
+    bool status = false;
+
+    // Scope the undo item recording so we can undo on failure.
+    {
+        OpUndoItemRecorder undoRecorder(_undoItemList);
+
+        auto& manager = PXR_NS::PrimUpdaterManager::getInstance();
+        status = manager.editAsMaya(_path);
+    }
+
+    // Undo potentially partially-made edit-as-Maya on failure.
+    if (!status)
+        _undoItemList.undo();
+}
+
+void EditAsMayaUfeCommand::undo() { _undoItemList.redo(); }
+
+void EditAsMayaUfeCommand::redo() { _undoItemList.redo(); }
+
+} // namespace ufe
+} // namespace MAYAUSD_NS_DEF