Prim metadata editRouting

lib/mayaUsd/resources/ae/usdschemabase/ae_template.py

@@ -220,11 +220,7 @@ def onReplace(self, *args):
         # that case we don't need to update our controls since none will change.
         pass
 
-    def refresh(self):
-        # PrimPath
-        cmds.textFieldGrp(self.primPath, edit=True, text=str(self.prim.GetPath()))
-
-        # Kind
+    def _refreshKind(self):
         model = Usd.ModelAPI(self.prim)
         primKind = model.GetKind()
         if not primKind:
@@ -233,6 +229,13 @@ def refresh(self):
         else:
             cmds.optionMenuGrp(self.kind, edit=True, value=primKind)
 
+    def refresh(self):
+        # PrimPath
+        cmds.textFieldGrp(self.primPath, edit=True, text=str(self.prim.GetPath()))
+
+        # Kind
+        self._refreshKind()
+
         # Active
         cmds.checkBoxGrp(self.active, edit=True, value1=self.prim.IsActive())
 
@@ -246,8 +249,13 @@ def refresh(self):
 
     def _onKindChanged(self, value):
         with mayaUsdLib.UsdUndoBlock():
-            model = Usd.ModelAPI(self.prim)
-            model.SetKind(value)
+            try:
+                usdUfe.SetKindCommand(self.prim, value).execute()
+            except Exception as ex:
+                # Note: the command might not work because there is a stronger
+                #       opinion or an editRouting prevention so update the option menu
+                self._refreshKind()
+
 
     def _onActiveChanged(self, value):
         with mayaUsdLib.UsdUndoBlock():

lib/usdUfe/base/tokens.h

@@ -39,13 +39,16 @@ namespace USDUFE_NS_DEF {
     /* Stage received in the context of some router  */ \
     ((Stage, "stage"))                                  \
     ((EditTarget, "editTarget"))                        \
+    /* Metadata key path received in the context     */ \
+    ((KeyPath, "keyPath"))                              \
                                                         \
     /* Routing operations                            */ \
                                                         \
     ((RouteParent, "parent"))                           \
     ((RouteDuplicate, "duplicate"))                     \
     ((RouteVisibility, "visibility"))                   \
     ((RouteAttribute, "attribute"))                     \
+    ((RoutePrimMetadata, "primMetadata"))               \
     ((RouteDelete, "delete"))                           \
     ((RouteTransform, "transform"))                     \
                                                         \

lib/usdUfe/python/wrapCommands.cpp

@@ -21,6 +21,7 @@
 #include <usdUfe/ufe/UsdUndoPayloadCommand.h>
 #include <usdUfe/ufe/UsdUndoReloadRefCommand.h>
 #include <usdUfe/ufe/UsdUndoSetDefaultPrimCommand.h>
+#include <usdUfe/ufe/UsdUndoSetKindCommand.h>
 #include <usdUfe/ufe/UsdUndoToggleActiveCommand.h>
 #include <usdUfe/ufe/UsdUndoToggleInstanceableCommand.h>
 
@@ -67,6 +68,12 @@ UsdUfe::UsdUndoToggleInstanceableCommand* ToggleInstanceableCommandInit(const PX
     return new UsdUfe::UsdUndoToggleInstanceableCommand(prim);
 }
 
+UsdUfe::UsdUndoSetKindCommand*
+SetKindCommandInit(const PXR_NS::UsdPrim& prim, const PXR_NS::TfToken& kind)
+{
+    return new UsdUfe::UsdUndoSetKindCommand(prim, kind);
+}
+
 UsdUfe::UsdUndoLoadPayloadCommand*
 LoadPayloadCommandInit(const PXR_NS::UsdPrim& prim, PXR_NS::UsdLoadPolicy policy)
 {
@@ -165,6 +172,14 @@ void wrapCommands()
             .def("undo", &UsdUfe::UsdUndoToggleInstanceableCommand::undo)
             .def("redo", &UsdUfe::UsdUndoToggleInstanceableCommand::redo);
     }
+    {
+        using This = UsdUfe::UsdUndoSetKindCommand;
+        class_<This, boost::noncopyable>("SetKindCommand", no_init)
+            .def("__init__", make_constructor(SetKindCommandInit))
+            .def("execute", &UsdUfe::UsdUndoSetKindCommand::execute)
+            .def("undo", &UsdUfe::UsdUndoSetKindCommand::undo)
+            .def("redo", &UsdUfe::UsdUndoSetKindCommand::redo);
+    }
     {
         using This = UsdUfe::UsdUndoLoadPayloadCommand;
         class_<This, boost::noncopyable>("LoadPayloadCommand", no_init)

lib/usdUfe/python/wrapEditRouter.cpp

@@ -198,4 +198,9 @@ void wrapEditRouter()
     using AttrThis = UsdUfe::AttributeEditRouterContext;
     class_<AttrThis, boost::noncopyable>("AttributeEditRouterContext", no_init)
         .def("__init__", make_constructor(AttributeEditRouterContextInit));
+
+    using PrimMdThis = UsdUfe::PrimMetadataEditRouterContext;
+    class_<PrimMdThis, boost::noncopyable>("PrimMetadataEditRouterContext", no_init)
+        .def(init<const PXR_NS::UsdPrim&, const PXR_NS::TfToken&>())
+        .def(init<const PXR_NS::UsdPrim&, const PXR_NS::TfToken&, const PXR_NS::TfToken&>());
 }

lib/usdUfe/ufe/SetVariantSelectionCommand.cpp

@@ -16,6 +16,7 @@
 #include "SetVariantSelectionCommand.h"
 
 #include <usdUfe/ufe/Utils.h>
+#include <usdUfe/utils/editRouterContext.h>
 
 #include <pxr/usd/usd/variantSets.h>
 
@@ -50,15 +51,20 @@ SetVariantSelectionCommand::SetVariantSelectionCommand(
 
 void SetVariantSelectionCommand::redo()
 {
+    const PXR_NS::TfToken metadataKeyPath(_varSet.GetName());
+
+    PrimMetadataEditRouterContext ctx(
+        _prim, PXR_NS::SdfFieldKeys->VariantSelection, metadataKeyPath);
+
     std::string errMsg;
     if (!UsdUfe::isPrimMetadataEditAllowed(
-            _prim,
-            PXR_NS::SdfFieldKeys->VariantSelection,
-            PXR_NS::TfToken(_varSet.GetName()),
-            &errMsg)) {
+            _prim, PXR_NS::SdfFieldKeys->VariantSelection, metadataKeyPath, &errMsg)) {
         throw std::runtime_error(errMsg.c_str());
     }
 
+    // Backup the destination layer for consistent undo.
+    _dstLayer = _prim.GetStage()->GetEditTarget().GetLayer();
+
     // Make a copy of the global selection, to restore it on undo.
     auto globalSn = Ufe::GlobalSelection::get();
     _savedSn.replaceWith(*globalSn);
@@ -69,6 +75,8 @@ void SetVariantSelectionCommand::redo()
 
 void SetVariantSelectionCommand::undo()
 {
+    PrimMetadataEditRouterContext ctx(_prim.GetStage(), _dstLayer);
+
     std::string errMsg;
     if (!UsdUfe::isPrimMetadataEditAllowed(
             _prim,

lib/usdUfe/ufe/SetVariantSelectionCommand.h

@@ -54,12 +54,13 @@ class USDUFE_PUBLIC SetVariantSelectionCommand : public Ufe::UndoableCommand
     void undo() override;
 
 private:
-    const Ufe::Path       _path;
-    PXR_NS::UsdPrim       _prim;
-    PXR_NS::UsdVariantSet _varSet;
-    const std::string     _oldSelection;
-    const std::string     _newSelection;
-    Ufe::Selection        _savedSn; // For global selection save and restore.
+    const Ufe::Path        _path;
+    PXR_NS::UsdPrim        _prim;
+    PXR_NS::UsdVariantSet  _varSet;
+    const std::string      _oldSelection;
+    const std::string      _newSelection;
+    Ufe::Selection         _savedSn;  // For global selection save and restore.
+    PXR_NS::SdfLayerHandle _dstLayer; // To ensure consistent editTarget at undo.
 };
 
 } // namespace USDUFE_NS_DEF

lib/usdUfe/ufe/UsdUndoAddRefOrPayloadCommand.cpp

@@ -15,6 +15,8 @@
 //
 #include "UsdUndoAddRefOrPayloadCommand.h"
 
+#include <usdUfe/utils/editRouterContext.h>
+
 #include <pxr/base/tf/stringUtils.h>
 #include <pxr/usd/sdf/layer.h>
 #include <pxr/usd/sdf/path.h>
@@ -94,10 +96,16 @@ void UsdUndoAddRefOrPayloadCommand::executeImplementation()
     if (_isPayload) {
         SdfPayload  payload(_filePath, primPath);
         UsdPayloads primPayloads = _prim.GetPayloads();
+
+        PrimMetadataEditRouterContext ctx(_prim, SdfFieldKeys->Payload);
+
         primPayloads.AddPayload(payload, _listPos);
     } else {
         SdfReference  ref(_filePath, primPath);
         UsdReferences primRefs = _prim.GetReferences();
+
+        PrimMetadataEditRouterContext ctx(_prim, SdfFieldKeys->References);
+
         primRefs.AddReference(ref, _listPos);
     }
 }

lib/usdUfe/ufe/UsdUndoClearPayloadsCommand.cpp

@@ -16,6 +16,8 @@
 
 #include "UsdUndoClearPayloadsCommand.h"
 
+#include <usdUfe/utils/editRouterContext.h>
+
 #include <pxr/usd/usd/payloads.h>
 
 namespace USDUFE_NS_DEF {
@@ -32,6 +34,8 @@ void UsdUndoClearPayloadsCommand::executeImplementation()
     if (!_prim.IsValid())
         return;
 
+    PrimMetadataEditRouterContext ctx(_prim, SdfFieldKeys->Payload);
+
     _prim.GetPayloads().ClearPayloads();
 }
 

lib/usdUfe/ufe/UsdUndoClearReferencesCommand.cpp

@@ -16,6 +16,8 @@
 
 #include "UsdUndoClearReferencesCommand.h"
 
+#include <usdUfe/utils/editRouterContext.h>
+
 #include <pxr/usd/usd/references.h>
 
 namespace USDUFE_NS_DEF {
@@ -32,6 +34,8 @@ void UsdUndoClearReferencesCommand::executeImplementation()
     if (!_prim.IsValid())
         return;
 
+    PrimMetadataEditRouterContext ctx(_prim, SdfFieldKeys->References);
+
     _prim.GetReferences().ClearReferences();
 }
 

lib/usdUfe/ufe/UsdUndoClearSceneItemMetadataCommand.cpp

@@ -18,6 +18,8 @@
 
 #include <usdUfe/base/tokens.h>
 #include <usdUfe/ufe/Utils.h>
+#include <usdUfe/utils/editRouter.h>
+#include <usdUfe/utils/editRouterContext.h>
 
 #include <pxr/base/tf/diagnostic.h>
 #include <pxr/base/tf/token.h>
@@ -52,7 +54,9 @@ void ClearSceneItemMetadataCommand::executeImplementation()
     const PXR_NS::UsdPrim prim = _stage->GetPrimAtPath(_primPath);
     if (_group.empty()) {
         // If this is not a grouped meta data, remove the key
-        prim.ClearCustomDataByKey(TfToken(_key));
+        PXR_NS::TfToken               key(_key);
+        PrimMetadataEditRouterContext ctx(prim, SdfFieldKeys->CustomData, key);
+        prim.ClearCustomDataByKey(key);
     } else {
         // When the group name starts with "SessionLayer-", remove that prefix
         // and clear in the session layer.
@@ -62,7 +66,8 @@ void ClearSceneItemMetadataCommand::executeImplementation()
             PXR_NS::TfToken        fullKey(prefixlessGroupName + std::string(":") + _key);
             prim.ClearCustomDataByKey(fullKey);
         } else {
-            PXR_NS::TfToken fullKey(_group + std::string(":") + _key);
+            PXR_NS::TfToken               fullKey(_group + std::string(":") + _key);
+            PrimMetadataEditRouterContext ctx(prim, SdfFieldKeys->CustomData, fullKey);
             prim.ClearCustomDataByKey(fullKey);
         }
     }

lib/usdUfe/ufe/UsdUndoSetKindCommand.cpp

@@ -17,6 +17,8 @@
 
 #include <usdUfe/undo/UsdUndoBlock.h>
 
+#include <usdUfe/utils/editRouterContext.h>
+
 #include <pxr/base/tf/token.h>
 #include <pxr/usd/usd/modelAPI.h>
 #include <pxr/usd/usd/prim.h>
@@ -52,6 +54,8 @@ void UsdUndoSetKindCommand::execute()
 {
     UsdUndoBlock undoBlock(&_undoableItem);
 
+    PrimMetadataEditRouterContext ctx(_prim, PXR_NS::SdfFieldKeys->Kind);
+
     PXR_NS::UsdModelAPI(_prim).SetKind(_kind);
 }
 

lib/usdUfe/ufe/UsdUndoSetSceneItemMetadataCommand.cpp

@@ -18,6 +18,8 @@
 
 #include <usdUfe/base/tokens.h>
 #include <usdUfe/ufe/Utils.h>
+#include <usdUfe/utils/editRouter.h>
+#include <usdUfe/utils/editRouterContext.h>
 
 #include <pxr/base/tf/token.h>
 #include <pxr/base/vt/value.h>
@@ -63,9 +65,11 @@ SetSceneItemMetadataCommand::SetSceneItemMetadataCommand(
 void SetSceneItemMetadataCommand::setKeyMetadata()
 {
     const PXR_NS::UsdPrim prim = _stage->GetPrimAtPath(_primPath);
+    const PXR_NS::TfToken key(_key);
 
     // If this is not a grouped metadata, set the _value directly on the _key
-    prim.SetCustomDataByKey(TfToken(_key), ufeValueToVtValue(_value));
+    PrimMetadataEditRouterContext ctx(prim, PXR_NS::SdfFieldKeys->CustomData, key);
+    prim.SetCustomDataByKey(key, ufeValueToVtValue(_value));
 }
 
 void SetSceneItemMetadataCommand::setGroupMetadata()
@@ -80,7 +84,8 @@ void SetSceneItemMetadataCommand::setGroupMetadata()
         PXR_NS::TfToken        fullKey(prefixlessGroupName + std::string(":") + _key);
         prim.SetCustomDataByKey(fullKey, ufeValueToVtValue(_value));
     } else {
-        PXR_NS::TfToken fullKey(_group + std::string(":") + _key);
+        PXR_NS::TfToken               fullKey(_group + std::string(":") + _key);
+        PrimMetadataEditRouterContext ctx(prim, PXR_NS::SdfFieldKeys->CustomData, fullKey);
         prim.SetCustomDataByKey(fullKey, ufeValueToVtValue(_value));
     }
 }

lib/usdUfe/ufe/UsdUndoToggleActiveCommand.cpp

@@ -18,6 +18,7 @@
 
 #include <usdUfe/ufe/UfeNotifGuard.h>
 #include <usdUfe/ufe/Utils.h>
+#include <usdUfe/utils/editRouterContext.h>
 
 namespace USDUFE_NS_DEF {
 
@@ -38,6 +39,8 @@ void UsdUndoToggleActiveCommand::executeImplementation()
     if (!prim.IsValid())
         return;
 
+    PrimMetadataEditRouterContext ctx(prim, PXR_NS::SdfFieldKeys->Active);
+
     std::string errMsg;
     if (!UsdUfe::isPrimMetadataEditAllowed(
             prim, PXR_NS::SdfFieldKeys->Active, PXR_NS::TfToken(), &errMsg)) {

lib/usdUfe/ufe/UsdUndoToggleInstanceableCommand.cpp

@@ -17,6 +17,7 @@
 #include "UsdUndoToggleInstanceableCommand.h"
 
 #include <usdUfe/ufe/Utils.h>
+#include <usdUfe/utils/editRouterContext.h>
 
 namespace USDUFE_NS_DEF {
 
@@ -39,6 +40,8 @@ void UsdUndoToggleInstanceableCommand::executeImplementation()
     if (!prim.IsValid())
         return;
 
+    PrimMetadataEditRouterContext ctx(prim, PXR_NS::SdfFieldKeys->Instanceable);
+
     std::string errMsg;
     if (!UsdUfe::isPrimMetadataEditAllowed(
             prim, PXR_NS::SdfFieldKeys->Instanceable, PXR_NS::TfToken(), &errMsg)) {

lib/usdUfe/utils/editRouter.cpp

@@ -275,6 +275,38 @@ getAttrEditRouterLayer(const PXR_NS::UsdPrim& prim, const PXR_NS::TfToken& attrN
     return _extractLayer(found->second);
 }
 
+PXR_NS::SdfLayerHandle getPrimMetadataEditRouterLayer(
+    const PXR_NS::UsdPrim& prim,
+    const PXR_NS::TfToken& metadataName,
+    const PXR_NS::TfToken& metadataKeyPath)
+{
+    static const PXR_NS::TfToken metadataOp(EditRoutingTokens->RoutePrimMetadata);
+
+    const EditRouter::Ptr dstEditRouter = getEditRouter(metadataOp);
+    if (!dstEditRouter)
+        return nullptr;
+
+    // Optimize the case where we have a per-stage layer routing.
+    // This avoid creating dictionaries just to pass and receive a value.
+    if (auto layerRouter = std::dynamic_pointer_cast<LayerPerStageEditRouter>(dstEditRouter))
+        return layerRouter->getLayerForStage(prim.GetStage());
+
+    PXR_NS::VtDictionary context;
+    PXR_NS::VtDictionary routingData;
+    context[EditRoutingTokens->Prim] = PXR_NS::VtValue(prim);
+    context[EditRoutingTokens->Operation] = metadataOp;
+    context[EditRoutingTokens->KeyPath] = PXR_NS::VtValue(metadataKeyPath);
+    context[metadataOp] = PXR_NS::VtValue(metadataName);
+    (*dstEditRouter)(context, routingData);
+
+    // Try to retrieve the layer from the routing data.
+    const auto found = routingData.find(EditRoutingTokens->Layer);
+    if (found == routingData.end())
+        return nullptr;
+
+    return _extractLayer(found->second);
+}
+
 PXR_NS::UsdEditTarget
 getEditRouterEditTarget(const PXR_NS::TfToken& operation, const PXR_NS::UsdPrim& prim)
 {

lib/usdUfe/utils/editRouter.h

@@ -111,6 +111,14 @@ USDUFE_PUBLIC
 PXR_NS::SdfLayerHandle
 getAttrEditRouterLayer(const PXR_NS::UsdPrim& prim, const PXR_NS::TfToken& attrName);
 
+// Retrieve the layer for the prim metadata operation. If no edit router for the
+// "primMetadata" operation is found, a nullptr is returned.
+USDUFE_PUBLIC
+PXR_NS::SdfLayerHandle getPrimMetadataEditRouterLayer(
+    const PXR_NS::UsdPrim& prim,
+    const PXR_NS::TfToken& metadataName,
+    const PXR_NS::TfToken& metadataKeyPath);
+
 // Utility function that returns a UsdEditTarget for the argument operation.
 // If no edit router exists for that operation, a null UsdEditTarget is returned.
 // The edit router is given the prim in the context with key "prim", and is