HYDRA-691 : Move mayaUsd code for managing stages inside mayaHydra

CMakeLists.txt

@@ -127,7 +127,7 @@ else()
     message(STATUS "UFE not found.")
 endif()
 
-find_package(MayaUsd OPTIONAL_COMPONENTS)
+find_package(MayaUsd)
 if(MayaUsd_FOUND)
     message(STATUS "Building with MayaUsd.")
 else()

cmake/modules/FindMayaUsd.cmake

@@ -5,8 +5,7 @@
 # It searches for MayaUsd's libraries and include header files.
 #
 # Variables that will be defined:
-# MAYAUSD_FOUND           Defined if a MayaUsd installation has been detected
-# MAYAUSD_LIBRARY_DIR     Path to MayaUsd libraries directory
+# MayaUsd_FOUND           Defined if a MayaUsd installation has been detected
 # MAYAUSD_INCLUDE_DIR     Path to the MayaUsd include directory
 # MAYAUSDAPI_LIBRARY      Path to MayaUsdAPI library
 # MAYAUSD_MOD_PATH        Path to mayaUSD.mod file
@@ -22,23 +21,11 @@ find_path(MAYAUSD_INCLUDE_DIR
         "MayaUsd header path"
 )
 
-find_path(MAYAUSD_LIBRARY_DIR
-        mayaUsd.lib
-    HINTS
-        ${MAYAUSD_LOCATION}
-    PATH_SUFFIXES
-        lib/
-    DOC
-        "MayaUsd libraries path"
-)
-
 find_library(MAYAUSDAPI_LIBRARY
     NAMES
         mayaUsdAPI
     HINTS
         ${MAYAUSD_LOCATION}
-    PATHS
-        ${MAYAUSD_LIBRARY_DIR}
     PATH_SUFFIXES
         lib/
     DOC
@@ -55,36 +42,20 @@ find_path(MAYAUSD_MOD_PATH
 )
 
 
-# Handle the QUIETLY and REQUIRED arguments and set MAYAUSD_FOUND to TRUE if
+# Handle the QUIETLY and REQUIRED arguments and set MayaUsd_FOUND to TRUE if
 # all listed variables are TRUE.
 include(FindPackageHandleStandardArgs)
 
-find_package_handle_standard_args(MAYAUSD
+find_package_handle_standard_args(MayaUsd
     REQUIRED_VARS
         MAYAUSD_INCLUDE_DIR
-        MAYAUSD_LIBRARY_DIR
+        MAYAUSDAPI_LIBRARY
+        MAYAUSD_MOD_PATH
 )
 
-if(MAYAUSD_FOUND)
-    message(STATUS "MayaUsd found : ${MAYAUSD_LOCATION}")
+if(MayaUsd_FOUND)
     message(STATUS "MayaUsd include dir: ${MAYAUSD_INCLUDE_DIR}")
-    message(STATUS "MayaUsd libraries dir: ${MAYAUSD_LIBRARY_DIR}")
-    message(STATUS "MayaUsdAPI.lib fullpath : ${MAYAUSDAPI_LIBRARY}")
+    message(STATUS "MayaUsdAPI library fullpath : ${MAYAUSDAPI_LIBRARY}")
     message(STATUS "MAYAUSD_MOD_PATH : ${MAYAUSD_MOD_PATH}")
-
-    #Add MAYAUSD_MOD_PATH (the path where maya USD .mod file is) to the MAYA_MODULE_PATH
-
-    # Get the current value of the environment variable
-    set(CURRENT_MAYA_MODULE_PATH $ENV{MAYA_MODULE_PATH})
-
-    # Append the new path to the current value
-    set(MAYA_MODULE_PATH "${CURRENT_MAYA_MODULE_PATH}:${MAYAUSD_MOD_PATH}")
-
-    # Export the new value to the environment
-    set(ENV{MAYA_MODULE_PATH} ${MAYA_MODULE_PATH})
-else()
-    if(DEFINED MAYAUSD_LOCATION)
-        message(WARNING "Could not find MayaUsd library and include directories in the folder provided : ${MAYAUSD_LOCATION}")
-    endif()
 endif()
 

cmake/test.cmake

@@ -1,5 +1,22 @@
 set(MAYA_USD_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 
+if(MayaUsd_FOUND)
+    #Add MAYAUSD_MOD_PATH (the path where maya USD .mod file is) to the MAYA_MODULE_PATH
+    # Get the current value of the environment variable
+    set(CURRENT_MAYA_MODULE_PATH $ENV{MAYA_MODULE_PATH})
+    # Append the new path to the current value
+    if(IS_MACOSX OR IS_LINUX) 
+        #Linux and OSX
+        set(MAYA_MODULE_PATH "${CURRENT_MAYA_MODULE_PATH}:${MAYAUSD_MOD_PATH}")
+    else()
+        #Windows
+        set(MAYA_MODULE_PATH "${CURRENT_MAYA_MODULE_PATH}\;${MAYAUSD_MOD_PATH}")
+    endif()
+    # Export the new value to the environment
+    set(ENV{MAYA_MODULE_PATH} ${MAYA_MODULE_PATH})
+    message(STATUS "MAYA_MODULE_PATH is now : ${MAYA_MODULE_PATH}")
+endif()
+
 function(mayaUsd_get_unittest_target unittest_target unittest_basename)
     get_filename_component(unittest_name ${unittest_basename} NAME_WE)
     set(${unittest_target} "${unittest_name}" PARENT_SCOPE)

lib/flowViewport/API/interfacesImp/fvpDataProducerSceneIndexInterfaceImp.cpp

@@ -272,4 +272,10 @@ void DataProducerSceneIndexInterfaceImp::setSceneIndexDataFactory(DataProducerSc
     sceneIndexDataFactory = &factory;
 }
 
+void DataProducerSceneIndexInterfaceImp::ClearDataProducerSceneIndicesThatApplyToAllViewports() 
+{ 
+    std::lock_guard<std::mutex> lockDataProducerSceneIndicesDataPerViewport(dataProducerSceneIndicesThatApplyToAllViewports_mutex);
+    dataProducerSceneIndicesThatApplyToAllViewports.clear();
+}
+
 } //End of namespace FVP_NS_DEF

lib/flowViewport/API/interfacesImp/fvpDataProducerSceneIndexInterfaceImp.h

@@ -68,6 +68,8 @@ class DataProducerSceneIndexInterfaceImp : public DataProducerSceneIndexInterfac
                                               const std::string& hydraViewportId = PXR_NS::FvpViewportAPITokens->allViewports)override;
 
 
+    FVP_API void ClearDataProducerSceneIndicesThatApplyToAllViewports();
+
     //Called by flow viewport
     ///hydraViewportSceneIndexAdded is called when a new hydra viewport is created by the ViewportInformationAndSceneIndicesPerViewportDataManager, it's not a callback.
     void hydraViewportSceneIndexAdded(const InformationInterface::ViewportInformation& viewportInfo);

lib/mayaHydra/hydraExtensions/CMakeLists.txt

@@ -33,7 +33,7 @@ set(HEADERS
 target_compile_definitions(${TARGET_NAME} 
     PRIVATE 
         MAYAHYDRALIB_EXPORT
-        $<$<BOOL:${MAYAUSDAPI_LIBRARY}>:MAYAHYDRALIB_MAYAUSDAPI_ENABLED>
+        $<$<BOOL:${MayaUsd_FOUND}>:MAYAHYDRALIB_MAYAUSDAPI_ENABLED>
         $<$<BOOL:${IS_MACOSX}>:OSMac_>
         # Copy-pasted from lib/mayaUsd/CMakeLists.txt
 )
@@ -52,7 +52,7 @@ target_include_directories(${TARGET_NAME}
                 ${CMAKE_BINARY_DIR}/include
             PRIVATE
                 $<$<BOOL:${UFE_FOUND}>:${UFE_INCLUDE_DIR}>
-                $<$<BOOL:${MAYAUSDAPI_LIBRARY}>:${MAYAUSD_INCLUDE_DIR}>
+                $<$<BOOL:${MayaUsd_FOUND}>:${MAYAUSD_INCLUDE_DIR}>
 )
 
 target_compile_definitions(${TARGET_NAME}
@@ -123,7 +123,7 @@ target_link_libraries(${TARGET_NAME}
         $<$<BOOL:${USD_001905_BUILD}>:hio>
         ${PYTHON_LIBRARIES} 
         $<$<BOOL:${UFE_FOUND}>:${UFE_LIBRARY}>
-        $<$<BOOL:${MAYAUSDAPI_LIBRARY}>:${MAYAUSDAPI_LIBRARY}>
+        $<$<BOOL:${MayaUsd_FOUND}>:${MAYAUSDAPI_LIBRARY}>
 )
 
 # -----------------------------------------------------------------------------

lib/mayaHydra/hydraExtensions/sceneIndex/mhMayaUsdProxyShapeSceneIndex.cpp

@@ -38,15 +38,17 @@ MayaUsdProxyShapeSceneIndex::MayaUsdProxyShapeSceneIndex(const MAYAUSDAPI_NS::Pr
     , _dagNodeHandle(dagNodeHandle)
 {
     TfWeakPtr<MayaUsdProxyShapeSceneIndex> ptr(this);
-    TfNotice::Register(ptr, &MayaUsdProxyShapeSceneIndex::_StageSet);
-    TfNotice::Register(ptr, &MayaUsdProxyShapeSceneIndex::_ObjectsChanged);
+    _stageSetNoticeKey = TfNotice::Register(ptr, &MayaUsdProxyShapeSceneIndex::_StageSet);
+    _objectsChangedNoticeKey = TfNotice::Register(ptr, &MayaUsdProxyShapeSceneIndex::_ObjectsChanged);
 
     _timeChangeCallbackId = MEventMessage::addEventCallback("timeChanged", onTimeChanged, this);
 }
 
 MayaUsdProxyShapeSceneIndex::~MayaUsdProxyShapeSceneIndex()
 {
     MMessage::removeCallback(_timeChangeCallbackId);
+    TfNotice::Revoke(_stageSetNoticeKey);
+    TfNotice::Revoke(_objectsChangedNoticeKey);
 }
 
 MayaUsdProxyShapeSceneIndexRefPtr MayaUsdProxyShapeSceneIndex::New(const MAYAUSDAPI_NS::ProxyStage& proxyStage, 

lib/mayaHydra/hydraExtensions/sceneIndex/mhMayaUsdProxyShapeSceneIndex.h

@@ -100,6 +100,8 @@ class MayaUsdProxyShapeSceneIndex : public HdSingleInputFilteringSceneIndexBase
     std::atomic<bool>               _populated { false };
     MCallbackId                     _timeChangeCallbackId = 0;
     MObjectHandle                   _dagNodeHandle;
+    TfNotice::Key                   _stageSetNoticeKey;
+    TfNotice::Key                   _objectsChangedNoticeKey;
 };
 
 } // namespace MAYAHYDRA_NS_DEF

lib/mayaHydra/mayaPlugin/renderOverride.cpp

@@ -277,7 +277,8 @@ MtohRenderOverride::~MtohRenderOverride()
     if (_timerCallback)
         MMessage::removeCallback(_timerCallback);
 
-    ClearHydraResources();
+    static const bool fullReset = true;
+    ClearHydraResources(fullReset);
 
     for (auto operation : _operations) {
         delete operation;
@@ -549,7 +550,8 @@ MStatus MtohRenderOverride::Render(
 
     _DetectMayaDefaultLighting(drawContext);
     if (_needsClear.exchange(false)) {
-        ClearHydraResources();
+        static const bool fullReset = false;
+        ClearHydraResources(fullReset);
     }
 
     if (!_initializationAttempted) {
@@ -808,7 +810,7 @@ void MtohRenderOverride::_InitHydraResources(const MHWRender::MDrawContext& draw
     _initializationSucceeded = true;
 }
 
-void MtohRenderOverride::ClearHydraResources()
+void MtohRenderOverride::ClearHydraResources(bool fullReset)
 {
     if (!_initializationAttempted) {
         return;
@@ -820,6 +822,13 @@ void MtohRenderOverride::ClearHydraResources()
     //We don't have any viewport using Hydra any more
     Fvp::ViewportInformationAndSceneIndicesPerViewportDataManager::Get().RemoveAllViewportsInformation();
 
+    if (fullReset){
+        //Remove the data producer scene indices that apply to all viewports
+        Fvp::DataProducerSceneIndexInterfaceImp::get().ClearDataProducerSceneIndicesThatApplyToAllViewports();
+        //Remove the scene index registry
+        _sceneIndexRegistry.reset();
+    }
+
     _mayaHydraSceneProducer.reset();
     _selectionSceneIndex.Reset();
     _selection.reset();
@@ -845,8 +854,6 @@ void MtohRenderOverride::ClearHydraResources()
         _rendererPlugin = nullptr;
     }
 
-    _sceneIndexRegistry.reset();
-
     //Decrease ref count on the render index proxy which owns the merging scene index at the end of this function as some previous calls may likely use it to remove some scene indices
     _renderIndexProxy.reset();
 
@@ -894,7 +901,8 @@ void MtohRenderOverride::_RemovePanel(MString panelName)
     }
 
     if (_renderPanelCallbacks.empty()) {
-        ClearHydraResources();
+        static const bool fullReset = false;
+        ClearHydraResources(fullReset);
     }
 }
 
@@ -1265,7 +1273,8 @@ void MtohRenderOverride::_ClearHydraCallback(void* data)
     if (!TF_VERIFY(instance)) {
         return;
     }
-    instance->ClearHydraResources();
+    static const bool fullReset = true;
+    instance->ClearHydraResources(fullReset);
 }
 
 void MtohRenderOverride::_PlayblastingChanged(bool playBlasting, void* userData)

lib/mayaHydra/mayaPlugin/renderOverride.h

@@ -112,7 +112,7 @@ class MtohRenderOverride : public MHWRender::MRenderOverride
         const MHWRender::MDrawContext&                         drawContext,
         const MHWRender::MDataServerOperation::MViewportScene& scene);
 
-    void ClearHydraResources();
+    void ClearHydraResources(bool fullReset);
     void SelectionChanged(const Ufe::SelectionChanged& notification);
     void SetRenderPurposeTags(const MayaHydraParams& delegateParams) { _SetRenderPurposeTags(delegateParams); };
     MString uiName() const override { return MString(_rendererDesc.displayName.GetText()); }

test/lib/mayaUsd/render/mayaToHydra/CMakeLists.txt

@@ -27,10 +27,10 @@ set(TEST_SCRIPT_FILES
     cpp/testFlowViewportAPIFilterPrims.py
 )
 
-#Add this test only if the MAYAUSDAPI_LIBRARY has been found during compile time.
-if(MAYAUSDAPI_LIBRARY)
+#Add this test only if the MayaUsd_FOUND (so also MAYAUSDAPI_LIBRARY) has been found during compile time.
+if(MayaUsd_FOUND)
     list(APPEND TEST_SCRIPT_FILES testMayaUsdAPIUsage.py)
-endif(MAYAUSDAPI_LIBRARY)
+endif(MayaUsd_FOUND)
 
 # Test use of mesh adapter code for mesh support, using environment variable.
 # As of 13-Jun-2023, if a test in this list is identical to a test in