Edit Router operations

[gracekumagai]

I have been testing the Edit Router as we are hoping to use it to route edits to the session layer that we don't want to pass downstream (visibility, pickability, etc).

Are there other operations that are supported (in addition to parenting and duplicating)? If so, I was wondering where I can find the list? I tried to pass "visibility" as the operation (mayaUsd.lib.registerEditRouter("visibility", ...)) and after making the prim invisible, the edit was not authored on the session layer.

Thank you so much!

[ppt-adsk]

Hi @gracekumagai, the currently-supported operations for edit routing are here:

maya-usd/lib/mayaUsd/utils/editRouter.cpp

Line 183 in 9f3800b

TfTokenVector defaultOperations = { TfToken("parent"), TfToken("duplicate") };

and here:

maya-usd/lib/mayaUsd/utils/editRouter.cpp

Line 188 in 9f3800b

defaultRouters[TfToken("mayaReferencePush")]

So mayaReferencePush, parent and duplicate for now. Once an edit router is registered, the edit routing registry must be accessed to retrieve the edit router and call it. This requires changing the code that writes to the USD data model. Here is the implementation for parent:

maya-usd/lib/mayaUsd/ufe/UsdUndoInsertChildCommand.cpp

Line 96 in 9f3800b

_parentLayer = getEditRouterLayer(PXR_NS::TfToken("parent"), parentPrim);

For duplicate:

maya-usd/lib/mayaUsd/ufe/UsdUndoDuplicateCommand.cpp

Line 54 in 9f3800b

_srcLayer = srcPrim.GetStage()->GetEditTarget().GetLayer();

And for mayaReferencePush (more complicated example):

maya-usd/lib/usd/translators/mayaReferenceUpdater.cpp

Line 195 in 8d0a425

auto dstEditRouter = MayaUsd::getEditRouter(TfToken("mayaReferencePush"));

I believe that to implement edit routing for visibility, you would need to change the UsdUndoVisibleCommand, somewhere here:

maya-usd/lib/mayaUsd/ufe/UsdUndoVisibleCommand.cpp

Line 55 in 600c31a

_visible ? primImageable.MakeVisible() : primImageable.MakeInvisible();

You would save the current edit target, set it to what your edit router returns, then set it back to its previous value. If the edit target layer is not prim-dependent, you can call upon the edit router in the UsdUndoVisibleCommand() constructor, and further if it's a constant (e.g. the session layer) ask the edit router once and save the result. Hope this helps, cheers.

[dj-mcg]

Thanks @ppt-adsk - were there plans on your end to continue broadening the support for operations that could be routed in this manner? If there were plans to add support for visibility on your end I'd prefer prioritizing the other tasks we know we need to tackle ourselves before circling back to this one. Thanks so much!

[dj-mcg]

Just to followup - it sounds like adding routing operations is something we could implement and contribute, which would allow the mayaUsd team to focus on new features and fixes that might not be plugin-only, so we are happy to schedule this work on our end. Thanks @ppt-adsk and others!

[ppt-adsk]

Hi @dj-mcg, took at crack at it just to test out that it wouldn't be too bad to implement support for this. Have a look at
#2438
Writing visibility edits to the session layer is done in the unit test, so this should be what you're looking for, unless I'm mistaken. Let me know what you think! Cheers.

[dj-mcg]

Rad! Thanks for trying it out and sharing your example!