MAYA-104215: improve renaming restriction on prim objects

lib/mayaUsd/ufe/UsdUndoRenameCommand.cpp

@@ -15,14 +15,14 @@
 //
 #include "UsdUndoRenameCommand.h"
 
-#include <ufe/scene.h>
-#include <ufe/sceneNotification.h>
 #include <ufe/log.h>
 
-#include <pxr/usd/usd/stage.h>
-#include <pxr/usd/usd/editContext.h>
-#include <pxr/usd/sdf/copyUtils.h>
 #include <pxr/base/tf/token.h>
+#include <pxr/usd/sdf/copyUtils.h>
+#include <pxr/usd/sdf/path.h>
+#include <pxr/usd/usd/editContext.h>
+#include <pxr/usd/usd/prim.h>
+#include <pxr/usd/usd/stage.h>
 
 #include <mayaUsd/ufe/Utils.h>
 
@@ -41,22 +41,23 @@ MAYAUSD_NS_DEF {
 namespace ufe {
 
 UsdUndoRenameCommand::UsdUndoRenameCommand(const UsdSceneItem::Ptr& srcItem, const Ufe::PathComponent& newName)
-	: Ufe::UndoableCommand()
+    : Ufe::UndoableCommand()
 {
-	const UsdPrim& prim = srcItem->prim();
-	_stage = prim.GetStage();
-	_ufeSrcItem = srcItem;
-	_usdSrcPath = prim.GetPath();
-
-	// 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()));
-	_layer = MayaUsdUtils::defPrimSpecLayer(prim);
-	if (!_layer) {
-		std::string err = TfStringPrintf("No prim found at %s", prim.GetPath().GetString().c_str());
-		throw std::runtime_error(err.c_str());
-	}
+    const UsdPrim& prim = srcItem->prim();
+    _stage = prim.GetStage();
+    _ufeSrcItem = srcItem;
+    _usdSrcPath = prim.GetPath();
+
+    // 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()));
+
+    _layer = MayaUsdUtils::defPrimSpecLayer(prim);
+    if (!_layer) {
+        std::string err = TfStringPrintf("No prim found at %s", prim.GetPath().GetString().c_str());
+        throw std::runtime_error(err.c_str());
+    }
 
     // if the current layer doesn't have any opinions that affects selected prim
     if (!MayaUsdUtils::doesEditTargetLayerHavePrimSpec(prim)) {
@@ -88,84 +89,85 @@ UsdUndoRenameCommand::~UsdUndoRenameCommand()
 {
 }
 
-/*static*/
 UsdUndoRenameCommand::Ptr UsdUndoRenameCommand::create(const UsdSceneItem::Ptr& srcItem, const Ufe::PathComponent& newName)
 {
-	return std::make_shared<UsdUndoRenameCommand>(srcItem, newName);
+    return std::make_shared<UsdUndoRenameCommand>(srcItem, newName);
 }
 
 UsdSceneItem::Ptr UsdUndoRenameCommand::renamedItem() const
 {
-	return _ufeDstItem;
+    return _ufeDstItem;
 }
 
 bool UsdUndoRenameCommand::renameRedo()
 {
-    // Copy the source path using CopySpec, and inactivate the source.
-
-	// We use the source layer as the destination.  An alternate workflow
-	// would be the edit target layer be the destination:
-	// layer = self.fStage.GetEditTarget().GetLayer()
-	bool status = SdfCopySpec(_layer, _usdSrcPath, _layer, _usdDstPath);
-	if (status)
-	{
-        auto srcPrim = _stage->GetPrimAtPath(_usdSrcPath);
-#ifdef UFE_V2_FEATURES_AVAILABLE
-        UFE_ASSERT_MSG(srcPrim, "Invalid prim cannot be inactivated.");
-#else
-        assert(srcPrim);
-#endif
-        status = srcPrim.SetActive(false);
+    // Copy the source path using CopySpec, and remove the source.
+
+    // We use the source layer as the destination.  An alternate workflow
+    // would be the edit target layer be the destination:
+    // _layer = _stage->GetEditTarget().GetLayer()
+    bool status = SdfCopySpec(_layer, _usdSrcPath, _layer, _usdDstPath);
+    if (status) {
+        // remove all scene description for the given path and 
+        // its subtree in the current UsdEditTarget 
+        {
+            UsdEditContext ctx(_stage, _layer);
+            status = _stage->RemovePrim(_ufeSrcItem->prim().GetPath());
+        }
 
         if (status) {
             // The renamed scene item is a "sibling" of its original name.
-            auto ufeSrcPath = _ufeSrcItem->path();
-            _ufeDstItem = createSiblingSceneItem(
-                ufeSrcPath, _usdDstPath.GetElementString());
+            _ufeDstItem = createSiblingSceneItem(_ufeSrcItem->path(), _usdDstPath.GetElementString());
 
-            Ufe::ObjectRename notification(_ufeDstItem, ufeSrcPath);
-            Ufe::Scene::notifyObjectPathChange(notification);
+            sendRenameNotification(_ufeDstItem, _ufeSrcItem->path());
         }
     }
     else {
         UFE_LOG(std::string("Warning: SdfCopySpec(") +
                 _usdSrcPath.GetString() + std::string(") failed."));
     }
 
-	return status;
+    return status;
 }
 
 bool UsdUndoRenameCommand::renameUndo()
 {
-    bool status{false};
-    {
-        // Regardless of where the edit target is currently set, switch to the
-        // layer where we copied the source prim into the destination, then
-        // restore the edit target.
-        UsdEditContext ctx(_stage, _layer);
-        status = _stage->RemovePrim(_usdDstPath);
-    }
+    // Copy the source path using CopySpec, and remove the source.
+    bool status = SdfCopySpec(_layer, _usdDstPath, _layer, _usdSrcPath);
+
     if (status) {
-        auto srcPrim = _stage->GetPrimAtPath(_usdSrcPath);
-#ifdef UFE_V2_FEATURES_AVAILABLE
-        UFE_ASSERT_MSG(srcPrim, "Invalid prim cannot be activated.");
-#else
-        assert(srcPrim);
-#endif
-        status = srcPrim.SetActive(true);
+        // remove all scene description for the given path and 
+        // its subtree in the current UsdEditTarget 
+        {
+            UsdEditContext ctx(_stage, _layer);
+            status = _stage->RemovePrim(_usdDstPath);
+        }
 
         if (status) {
-            Ufe::ObjectRename notification(_ufeSrcItem, _ufeDstItem->path());
-            Ufe::Scene::notifyObjectPathChange(notification);
+            // create a new prim at _usdSrcPath
+            auto newPrim = _stage->DefinePrim(_usdSrcPath);
+
+            #ifdef UFE_V2_FEATURES_AVAILABLE
+                UFE_ASSERT_MSG(newPrim, "Invalid prim cannot be inactivated.");
+            #else
+                assert(newPrim);
+            #endif
+
+            // I shouldn't have to again create a sibling sceneItem here since we already have a valid _ufeSrcItem
+            // however, I get random crashes if I don't which needs furthur investigation.  HS, 6-May-2020.
+            _ufeSrcItem = createSiblingSceneItem(_ufeDstItem->path(), _usdSrcPath.GetElementString());
+
+            sendRenameNotification(_ufeSrcItem, _ufeDstItem->path());
+
             _ufeDstItem = nullptr;
         }
-	}
+    }
     else {
-        UFE_LOG(std::string("Warning: RemovePrim(") +
+        UFE_LOG(std::string("Warning: SdfCopySpec(") +
                 _usdDstPath.GetString() + std::string(") failed."));
     }
 
-	return status;
+    return status;
 }
 
 //------------------------------------------------------------------------------
@@ -174,24 +176,24 @@ bool UsdUndoRenameCommand::renameUndo()
 
 void UsdUndoRenameCommand::undo()
 {
-	// MAYA-92264: Pixar bug prevents undo from working.  Try again with USD
-	// version 0.8.5 or later.  PPT, 7-Jul-2018.
-	try {
+    // MAYA-92264: Pixar bug prevents undo from working.  Try again with USD
+    // version 0.8.5 or later.  PPT, 7-Jul-2018.
+    try {
         InPathChange pc;
-		if (!renameUndo()) {
+        if (!renameUndo()) {
             UFE_LOG("rename undo failed");
         }
-	}
-	catch (const std::exception& e) {
-		UFE_LOG(e.what());
-		throw;	// re-throw the same exception
-	}
+    }
+    catch (const std::exception& e) {
+        UFE_LOG(e.what());
+        throw;  // re-throw the same exception
+    }
 }
 
 void UsdUndoRenameCommand::redo()
 {
     InPathChange pc;
-	if (!renameRedo()) {
+    if (!renameRedo()) {
         UFE_LOG("rename redo failed");
     }
 }

lib/mayaUsd/ufe/UsdUndoRenameCommand.h

@@ -19,9 +19,6 @@
 #include <ufe/pathComponent.h>
 #include <ufe/undoableCommand.h>
 
-#include <pxr/usd/sdf/path.h>
-#include <pxr/usd/usd/prim.h>
-
 #include <mayaUsd/base/api.h>
 #include <mayaUsd/ufe/UsdSceneItem.h>
 
@@ -34,39 +31,39 @@ namespace ufe {
 class MAYAUSD_CORE_PUBLIC UsdUndoRenameCommand : public Ufe::UndoableCommand
 {
 public:
-	typedef std::shared_ptr<UsdUndoRenameCommand> Ptr;
+    typedef std::shared_ptr<UsdUndoRenameCommand> Ptr;
 
-	UsdUndoRenameCommand(const UsdSceneItem::Ptr& srcItem, const Ufe::PathComponent& newName);
-	~UsdUndoRenameCommand() override;
+    UsdUndoRenameCommand(const UsdSceneItem::Ptr& srcItem, const Ufe::PathComponent& newName);
+    ~UsdUndoRenameCommand() override;
 
-	// Delete the copy/move constructors assignment operators.
-	UsdUndoRenameCommand(const UsdUndoRenameCommand&) = delete;
-	UsdUndoRenameCommand& operator=(const UsdUndoRenameCommand&) = delete;
-	UsdUndoRenameCommand(UsdUndoRenameCommand&&) = delete;
-	UsdUndoRenameCommand& operator=(UsdUndoRenameCommand&&) = delete;
+    // Delete the copy/move constructors assignment operators.
+    UsdUndoRenameCommand(const UsdUndoRenameCommand&) = delete;
+    UsdUndoRenameCommand& operator=(const UsdUndoRenameCommand&) = delete;
+    UsdUndoRenameCommand(UsdUndoRenameCommand&&) = delete;
+    UsdUndoRenameCommand& operator=(UsdUndoRenameCommand&&) = delete;
 
-	//! Create a UsdUndoRenameCommand from a USD scene item and UFE pathcomponent.
-	static UsdUndoRenameCommand::Ptr create(const UsdSceneItem::Ptr& srcItem, const Ufe::PathComponent& newName);
+    //! Create a UsdUndoRenameCommand from a USD scene item and UFE pathcomponent.
+    static UsdUndoRenameCommand::Ptr create(const UsdSceneItem::Ptr& srcItem, const Ufe::PathComponent& newName);
 
-	UsdSceneItem::Ptr renamedItem() const;
+    UsdSceneItem::Ptr renamedItem() const;
 
 private:
 
-	// UsdUndoRenameCommand overrides
-	void undo() override;
-	void redo() override;
+    // UsdUndoRenameCommand overrides
+    void undo() override;
+    void redo() override;
 
-	bool renameRedo();
-	bool renameUndo();
+    bool renameRedo();
+    bool renameUndo();
 
-	UsdStageWeakPtr _stage;
-	SdfLayerHandle _layer;
+    UsdStageWeakPtr _stage;
+    SdfLayerHandle _layer;
 
     UsdSceneItem::Ptr _ufeSrcItem;
-	SdfPath _usdSrcPath;
+    SdfPath _usdSrcPath;
 
-	UsdSceneItem::Ptr _ufeDstItem;
-	SdfPath _usdDstPath;
+    UsdSceneItem::Ptr _ufeDstItem;
+    SdfPath _usdDstPath;
 
 }; // UsdUndoRenameCommand
 

lib/mayaUsd/ufe/Utils.cpp

@@ -22,6 +22,9 @@
 #include <string>
 #include <unordered_map>
 
+#include <ufe/scene.h>
+#include <ufe/sceneNotification.h>
+
 #include <maya/MGlobal.h>
 #include <maya/MSelectionList.h>
 #include <maya/MObjectHandle.h>
@@ -242,5 +245,11 @@ UsdTimeCode getTime(const Ufe::Path& path)
     return proxyShape->getTime();
 }
 
+void sendRenameNotification(const Ufe::SceneItem::Ptr& item, const Ufe::Path& previousPath)
+{
+	Ufe::ObjectRename notification(item, previousPath);
+	Ufe::Scene::notifyObjectPathChange(notification);
+}
+
 } // namespace ufe
 } // namespace MayaUsd

lib/mayaUsd/ufe/Utils.h

@@ -82,5 +82,9 @@ MDagPath nameToDagPath(const std::string& name);
 MAYAUSD_CORE_PUBLIC
 UsdTimeCode getTime(const Ufe::Path& path);
 
+//! Object renamed scene notification
+MAYAUSD_CORE_PUBLIC
+void sendRenameNotification(const Ufe::SceneItem::Ptr& item, const Ufe::Path& previousPath);
+
 } // namespace ufe
 } // namespace MayaUsd