MAYA-128473 - Move UFE to its own Project #3109

seando-adsk · 2023-05-19T16:02:30Z

MAYA-128473 - Move UFE to its own Project

MAYA-128474 - UFE for USD: Remove Maya from UFE implementation

Initial usdUfe library creation.
ufeUsd library won't support Ufe v1. Remove Ufe v2 checks - it is minimum supported.
Moved following items to UsdUfe. ** UsdSceneItem
- UfeVersionCompat.h
- UsdUndoSetKindCommand
- Functions: "isEditTargetLayerModifiable",
  - "getUsdRunTimeId", "uniqueName", "uniqueChildName", "UsdUndoAddNewPrimCommand"
- UsdUndoCreateGroupCommand & UsdUndoUngroupCommand
- UsdUndoReorderCommand
- Edit routing (tokens, editRouter, editRouterContext)
- Edit router python bindings (from mayaUsd.lib)
  - Kept Maya specific edit router (registered with new service) in new file mayaEditorRouter.{h/cpp}.
  - Added basic editing routing doc to UsdUfe.
- UsdUndoInsertChildCommand
- UsdRootChildHierarchy and split out MayaUsdRootChildHierarchy.
- UsdHierarchy and split out MayaUsdHierarchy.
  - Both of these MayaXXX versions use the new childrenHook for the pulled objects.** UsdHierarchyHandler and split out MayaUsdHierarchyHandler.
- Registration of USD hierarchyHandler
- sendNotification() / duplicateLoadRules() / removeRulesForPath()
- Util functions stripInstanceIndexFromUfePath, ufePathToInstanceIndex and isRootChild and the associated python wrappers.
Remove "private" folder from mayaUsd/ufe and use one in usdUfe instead.
Copied ufe/Utils.{h/cpp} - initially mostly commented out
Copied "Global.{h/cpp} to usdUfe (mostly empty for now).
Created 'usdUfe' python module.
- Copied wrapGlobal & wrapUtils to usdUfe.
- Imported into mayaUsd.ufe.
- Moved python bindings for "getUsdRunTimeId" and "isEditTargetLayerModifiable".
Moved ufe/Utils helpers: applyCommandRestriction and applyCommandRestrictionNoThrow to UsdUfe.
Moved lib/mayaUsd/utils/layers.{h/cpp} to lib/usdUfe/utils.
Moved lib/usd/utils/util.{h/cpp} to lib/usdUfe/utils/usdUtils.
New ability to set Ufe path to prim function (setUfePathToPrimFn) which is a DCC specific operation. Set this in MayaUsd during ufe initialization.
Code review comments: use special "TEMP (UsdUfe)" tag to make them easier to find.

MAYA-128475 - UFE: Undo refactor for UFE USD implementation

MAYA-128474 - UFE for USD: Remove Maya from UFE implementation

Move "undo/UsdUndo*" (with debugCodes) to UsdUfe
Split UsdUndoBlock with new MayaUsdUndoBlock
Added new UsdUndoManagerAccessor to access UsdUndoManager private method
Move "UsdUndoableCommand" to UsdUfe

MAYA-128474 - UFE for USD: Remove Maya from UFE implementation * Initial usdUfe library creation. * ufeUsd library won't support Ufe v1. Remove Ufe v2 checks - it is minimum supported. * Moved following items to UsdUfe. ** UsdSceneItem ** UfeVersionCompat.h ** UsdUndoSetKindCommand ** Functions: "isEditTargetLayerModifiable", ** "getUsdRunTimeId", "uniqueName", "uniqueChildName", "UsdUndoAddNewPrimCommand" ** UsdUndoCreateGroupCommand & UsdUndoUngroupCommand ** UsdUndoReorderCommand ** Edit routing (tokens, editRouter, editRouterContext) ** Edit router python bindings (from mayaUsd.lib) *** Kept Maya specific edit router (registered with new service) in new file mayaEditorRouter.{h/cpp}. *** Added basic editing routing doc to UsdUfe. ** UsdUndoInsertChildCommand ** UsdRootChildHierarchy and split out MayaUsdRootChildHierarchy. ** UsdHierarchy and split out MayaUsdHierarchy. *** Both of these MayaXXX versions use the new childrenHook for the pulled objects.** UsdHierarchyHandler and split out MayaUsdHierarchyHandler. ** Registration of USD hierarchyHandler ** sendNotification() / duplicateLoadRules() / removeRulesForPath() ** Util functions stripInstanceIndexFromUfePath, ufePathToInstanceIndex and isRootChild and the associated python wrappers. * Remove "private" folder from mayaUsd/ufe and use one in usdUfe instead. * Copied ufe/Utils.{h/cpp} - initially mostly commented out * Copied "Global.{h/cpp} to usdUfe (mostly empty for now). * Created 'usdUfe' python module. * Copied wrapGlobal & wrapUtils to usdUfe. * Imported into mayaUsd.ufe. * Moved python bindings for "getUsdRunTimeId" and "isEditTargetLayerModifiable". * Moved ufe/Utils helpers: applyCommandRestriction and applyCommandRestrictionNoThrow to UsdUfe. * Moved lib/mayaUsd/utils/layers.{h/cpp} to lib/usdUfe/utils. * Moved lib/usd/utils/util.{h/cpp} to lib/usdUfe/utils/usdUtils. * New ability to set Ufe path to prim function (setUfePathToPrimFn) which is a DCC specific operation. Set this in MayaUsd during ufe initialization. * Code review comments: use special "TEMP (UsdUfe)" tag to make them easier to find. MAYA-128475 - UFE: Undo refactor for UFE USD implementation MAYA-128474 - UFE for USD: Remove Maya from UFE implementation * Move "undo/UsdUndo*" (with debugCodes) to UsdUfe * Split UsdUndoBlock with new MayaUsdUndoBlock * Added new UsdUndoManagerAccessor to access UsdUndoManager private method * Move "UsdUndoableCommand" to UsdUfe

seando-adsk · 2023-05-19T16:06:16Z

.clang-format

-  # 7. C++ standard library headers
-  # 8. C system headers
-  # 9. Conditional includes
+  # 4. UsdUfe headers


Added new section for the UsdUfe headers. Running clang-format locally moved all of them to this section.

seando-adsk · 2023-05-19T16:08:14Z

lib/mayaUsd/ufe/CMakeLists.txt

+            MayaUsdHierarchy.cpp
+            MayaUsdHierarchyHandler.cpp
+            MayaUsdRootChildHierarchy.cpp


As discussed put these files here since they need the pulledinfo which requires path mapping which is Ufe v3.

seando-adsk · 2023-05-19T16:09:21Z

lib/mayaUsd/ufe/Global.cpp

+#ifdef UFE_V3_FEATURES_AVAILABLE
+    usdUfeHandlers.hierarchyHandler = MayaUsdHierarchyHandler::create();
+#endif


Only need this one in Ufe v3 (or greater). Otherwise the UsdHierarchyHandler registered by UsdUfe is fine.

seando-adsk · 2023-05-19T16:09:45Z

lib/mayaUsd/ufe/Global.cpp

-    auto usdTrans3dHandler = UsdTransform3dHandler::create();
-    auto usdSceneItemOpsHandler = UsdSceneItemOpsHandler::create();
-    g_USDRtid = runTimeMgr.register_(
-        kUSDRunTimeName, usdHierHandler, usdTrans3dHandler, usdSceneItemOpsHandler);
 #endif


Ufe v1 - not supported anymore.

seando-adsk · 2023-05-19T16:13:39Z

lib/mayaUsd/ufe/wrapGlobal.cpp

+// clang-format off
 void wrapGlobal()
 {
    def("getMayaRunTimeId", ufe::getMayaRunTimeId);
-
-    def("getUsdRunTimeId", ufe::getUsdRunTimeId);
 }
+// clang-format on


Added clang-format off/on to stop it from creating a single line out of all of this.

dgovil · 2023-05-19T17:03:04Z

Hi @seando-adsk
Would you be able to provide a few details about the implications and decisions for this? Or is it purely around internal work that won't affect the open source project materially?

Some questions off the top of my head that I know I'll have to answer if it does affect the Maya USD project materially:

What portion of the maya USD UFE is transitioning to a new project?

Would that new project require a new CLA, and be on GitHub too?

Does the license remain the same?

There's just a lot of legal ramifications that I'm sure every contributor will need to prep for, so having the details before hand would help get ahead of those.

ppt-adsk · 2023-05-19T17:49:35Z

Hi @seando-adsk Would you be able to provide a few details about the implications and decisions for this? Or is it purely around internal work that won't affect the open source project materially?

Some questions off the top of my head that I know I'll have to answer if it does affect the Maya USD project materially:

What portion of the maya USD UFE is transitioning to a new project?

Would that new project require a new CLA, and be on GitHub too?

Does the license remain the same?

There's just a lot of legal ramifications that I'm sure every contributor will need to prep for, so having the details before hand would help get ahead of those.

I'll let @seando-adsk give the definitive answer, and I'm not a lawyer, but this should not affect the nature of the maya-usd open source project.

It is really an attempt to factor out of maya-usd those parts that are not Maya-dependent, for better re-use. Much of the USD implementation of UFE interfaces has nothing to do with Maya, but unfortunately over time some spurious or unnecessary Maya dependencies crept in.

With the new usdUfe library, these Maya dependencies have been removed, and we now have a library with the USD implementation of UFE interfaces where we cannot introduce new and incorrect Maya dependencies, so reuse will be much easier. Hope this helps.

lib/mayaUsd/undo/UsdUndoBlock.cpp

lib/usdUfe/CMakeLists.txt

ppt-adsk · 2023-05-19T18:23:20Z

lib/usdUfe/CMakeLists.txt

+message(STATUS "MAYA_HAS_DISPLAY_LAYER_API is ${MAYA_HAS_DISPLAY_LAYER_API}")
+if (MAYA_HAS_DISPLAY_LAYER_API)
+    target_compile_definitions(${PROJECT_NAME}
+        PRIVATE
+            MAYA_HAS_DISPLAY_LAYER_API=1
+    )
+endif()


This is Maya-specific. Do we need it? Hopefully the answer is no, otherwise we should make plans on how to get rid of it.

lib/usdUfe/python/module.cpp

lib/usdUfe/ufe/private/UfeNotifGuard.h

lib/usdUfe/ufe/private/Utils.h

lib/usdUfe/utils/Utils.h

neilh-adsk · 2023-05-23T13:38:55Z

Hi @seando-adsk Would you be able to provide a few details about the implications and decisions for this? Or is it purely around internal work that won't affect the open source project materially?

Some questions off the top of my head that I know I'll have to answer if it does affect the Maya USD project materially:

What portion of the maya USD UFE is transitioning to a new project?

Would that new project require a new CLA, and be on GitHub too?

Does the license remain the same?

There's just a lot of legal ramifications that I'm sure every contributor will need to prep for, so having the details before hand would help get ahead of those.

Hi, @dgovil For now this is more a case of starting the process to allow the USD UFE runtime to be shareable across other projects, nothing should change in the functionality of MayaUSD at this stage. Some of these projects are internals for example MaxUSD is starting to look at UFE and it made sense to make this code as shareable as possible. The longer term direction of whether this becomes its own official project has not yet been decided and when the discussion starts in more seriousness I will will reach out to the community.

dgovil · 2023-05-23T13:47:53Z

Thanks, that does help me understand the implications somewhat.

seando-adsk · 2023-05-25T18:06:54Z

Hi @seando-adsk Would you be able to provide a few details about the implications and decisions for this? Or is it purely around internal work that won't affect the open source project materially?
Some questions off the top of my head that I know I'll have to answer if it does affect the Maya USD project materially:
What portion of the maya USD UFE is transitioning to a new project?
Would that new project require a new CLA, and be on GitHub too?
Does the license remain the same?
There's just a lot of legal ramifications that I'm sure every contributor will need to prep for, so having the details before hand would help get ahead of those.

Hi, @dgovil For now this is more a case of starting the process to allow the USD UFE runtime to be shareable across other projects, nothing should change in the functionality of MayaUSD at this stage. Some of these projects are internals for example MaxUSD is starting to look at UFE and it made sense to make this code as shareable as possible. The longer term direction of whether this becomes its own official project has not yet been decided and when the discussion starts in more seriousness I will will reach out to the community.

I should also mention that this is just the first pull-request in work that will continue in future PRs. This PR basically moved over everything required in order to move the UsdHierarchy interface. Next I'll probably focus on moving the UsdObject3d interface. I'm working in phases in order to not drift too far from dev branch and have to merge as other changes are made to the mayausd/ufe files.

seando-adsk requested a review from ppt-adsk May 19, 2023 16:02

seando-adsk added the ufe-usd Related to UFE-USD plugin in Maya-Usd label May 19, 2023

seando-adsk commented May 19, 2023

View reviewed changes

ppt-adsk approved these changes May 19, 2023

View reviewed changes

seando-adsk assigned ecp-maya-devops-adsk May 25, 2023

seando-adsk added the ready-for-merge Development process is finished, PR is ready for merge label May 25, 2023

seando-adsk merged commit 4d133df into dev May 25, 2023

seando-adsk deleted the donnels/MAYA-128473/create_new_usdufe_project branch May 25, 2023 18:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MAYA-128473 - Move UFE to its own Project #3109

MAYA-128473 - Move UFE to its own Project #3109

seando-adsk commented May 19, 2023

seando-adsk May 19, 2023

seando-adsk May 19, 2023

seando-adsk May 19, 2023

seando-adsk May 19, 2023

seando-adsk May 19, 2023

dgovil commented May 19, 2023 •

edited

Loading

ppt-adsk commented May 19, 2023

ppt-adsk May 19, 2023

neilh-adsk commented May 23, 2023

dgovil commented May 23, 2023

seando-adsk commented May 25, 2023

MAYA-128473 - Move UFE to its own Project #3109

MAYA-128473 - Move UFE to its own Project #3109

Conversation

seando-adsk commented May 19, 2023

MAYA-128473 - Move UFE to its own Project

MAYA-128474 - UFE for USD: Remove Maya from UFE implementation

MAYA-128475 - UFE: Undo refactor for UFE USD implementation

MAYA-128474 - UFE for USD: Remove Maya from UFE implementation

seando-adsk May 19, 2023

Choose a reason for hiding this comment

seando-adsk May 19, 2023

Choose a reason for hiding this comment

seando-adsk May 19, 2023

Choose a reason for hiding this comment

seando-adsk May 19, 2023

Choose a reason for hiding this comment

seando-adsk May 19, 2023

Choose a reason for hiding this comment

dgovil commented May 19, 2023 • edited Loading

ppt-adsk commented May 19, 2023

ppt-adsk May 19, 2023

Choose a reason for hiding this comment

neilh-adsk commented May 23, 2023

dgovil commented May 23, 2023

seando-adsk commented May 25, 2023

dgovil commented May 19, 2023 •

edited

Loading