HYDRA-926 : Remove Maya Hydra Scene Producer wrapper

doc/codingGuidelines.md

@@ -284,7 +284,7 @@ For source files (.cpp) with an associated header file (.h) that resides in the
 All included public header files from outside and inside the project should be `#include`’d using angle brackets. For example:
 ```cpp
 #include <pxr/base/tf/stringUtils.h>
-#include <mayaHydraLib/mayaHydraSceneProducer.h>
+#include <mayaHydraLib/sceneIndex/mayaHydraSceneIndex.h>
 ```
 
 Private project’s header files should be `#include`'d using double quotes, and a relative path. Private headers may live in the same directory or sub-directories, but they should never be included using "._" or ".._" as part of a relative path. For example:

doc/mayaHydraDetails.md

@@ -91,7 +91,7 @@ classDiagram
     -_renderIndex: HdRenderIndex*
     -_fvpSelectionTracker: Fvp::SelectionTrackerSharedPtr
     -_selectionSceneIndex: Fvp::SelectionSceneIndexRefPtr
-    -_mayaHydraSceneProducer: std::unique_ptr<MayaHydraSceneProducer>
+    -_mayaHydraSceneIndex: std::unique_ptr<MayaHydraSceneIndex>
     +Render(const MHWRender::MDrawContext& drawContext, const MHWRender::MDataServerOperation::MViewportScene& scene)
   }
 ```
@@ -129,8 +129,8 @@ stateDiagram
 
   state InitHydraResources() {
       [*] --> HydraResources
-      HydraResources --> MayaHydraSceneProducer() :  RenderDelegate/RenderIndex
-      MayaHydraSceneProducer() --> Populate() : Creates MayaHydra specific Scene Indices internally       
+      HydraResources --> MayaHydraSceneIndex() :  RenderDelegate/RenderIndex
+      MayaHydraSceneIndex() --> Populate() : Creates MayaHydra specific Scene Indices internally       
       Populate() --> MayaHydraAdapter : Loop over Maya native nodes
       MayaHydraAdapter --> SceneIndexRegistration : Flow Viewport API (WIP) to inject various Scene Indices including USD data and SelectionHighlighting
       SceneIndexRegistration --> [*]

lib/mayaHydra/hydraExtensions/CMakeLists.txt

@@ -13,7 +13,6 @@ target_sources(${TARGET_NAME}
         mayaUtils.cpp
         mhBuildInfo.cpp
         mixedUtils.cpp
-        mayaHydraSceneProducer.cpp
 )
 
 set(HEADERS
@@ -25,7 +24,6 @@ set(HEADERS
     mayaHydraLibInterfaceImp.h
     mayaUtils.h
     mixedUtils.h
-    mayaHydraSceneProducer.h
 )
 
 # -----------------------------------------------------------------------------

lib/mayaHydra/hydraExtensions/adapters/adapter.cpp

@@ -18,7 +18,7 @@
 #include <mayaHydraLib/adapters/adapterDebugCodes.h>
 #include <mayaHydraLib/adapters/materialNetworkConverter.h>
 #include <mayaHydraLib/adapters/mayaAttrs.h>
-#include <mayaHydraLib/mayaHydraSceneProducer.h>
+#include <mayaHydraLib/sceneIndex/mayaHydraSceneIndex.h>
 
 #include <pxr/base/tf/type.h>
 
@@ -36,7 +36,7 @@ void _preRemoval(MObject& node, void* clientData)
     auto* adapter = reinterpret_cast<MayaHydraAdapter*>(clientData);
     TF_DEBUG(MAYAHYDRALIB_ADAPTER_CALLBACKS)
         .Msg("Pre-removal callback triggered for prim (%s)\n", adapter->GetID().GetText());
-    adapter->GetSceneProducer()->RemoveAdapter(adapter->GetID());
+    adapter->GetMayaHydraSceneIndex()->RemoveAdapter(adapter->GetID());
 }
 
 void _nameChanged(MObject& node, const MString& str, void* clientData)
@@ -47,7 +47,7 @@ void _nameChanged(MObject& node, const MString& str, void* clientData)
     TF_DEBUG(MAYAHYDRALIB_ADAPTER_CALLBACKS)
         .Msg("Name-changed callback triggered for prim (%s)\n", adapter->GetID().GetText());
     adapter->RemoveCallbacks();
-    adapter->GetSceneProducer()->RecreateAdapterOnIdle(adapter->GetID(), adapter->GetNode());
+    adapter->GetMayaHydraSceneIndex()->RecreateAdapterOnIdle(adapter->GetID(), adapter->GetNode());
 }
 
 } // namespace
@@ -57,9 +57,9 @@ void _nameChanged(MObject& node, const MString& str, void* clientData)
 MayaHydraAdapter::MayaHydraAdapter(
     const MObject&        node,
     const SdfPath&        id,
-    MayaHydraSceneProducer* producer)
+    MayaHydraSceneIndex*  mayaHydraSceneIndex)
     : _id(id)
-    , _sceneProducer(producer)
+    , _mayaHydraSceneIndex(mayaHydraSceneIndex)
     , _node(node)
 {
 }

lib/mayaHydra/hydraExtensions/adapters/adapter.h

@@ -44,7 +44,7 @@
 
 PXR_NAMESPACE_OPEN_SCOPE
 
-class MayaHydraSceneProducer;
+class MayaHydraSceneIndex;
 
 /**
  * \brief MayaHydraAdapter is the base class for all adapters. An adapter is used to translate from
@@ -55,12 +55,12 @@ class MayaHydraAdapter
 {
 public:
     MAYAHYDRALIB_API
-    MayaHydraAdapter(const MObject& node, const SdfPath& id, MayaHydraSceneProducer* producer);
+    MayaHydraAdapter(const MObject& node, const SdfPath& id, MayaHydraSceneIndex* mayaHydraSceneIndex);
     MAYAHYDRALIB_API
     virtual ~MayaHydraAdapter();
 
-    const SdfPath&        GetID() const { return _id; }
-    MayaHydraSceneProducer* GetSceneProducer() const { return _sceneProducer; }
+    const SdfPath&       GetID() const { return _id; }
+    MayaHydraSceneIndex* GetMayaHydraSceneIndex() const { return _mayaHydraSceneIndex; }
     MAYAHYDRALIB_API
     void AddCallback(MCallbackId callbackId);
     MAYAHYDRALIB_API
@@ -109,7 +109,7 @@ class MayaHydraAdapter
 protected:
     SdfPath                  _id;
     std::vector<MCallbackId> _callbacks;
-    MayaHydraSceneProducer*  _sceneProducer;
+    MayaHydraSceneIndex*     _mayaHydraSceneIndex;
     MObject                  _node;
 
     bool _isPopulated = false;

lib/mayaHydra/hydraExtensions/adapters/adapterRegistry.h

@@ -44,15 +44,15 @@ class MayaHydraAdapterRegistry : public TfSingleton<MayaHydraAdapterRegistry>
 
 public:
     using ShapeAdapterCreator
-        = std::function<MayaHydraShapeAdapterPtr(MayaHydraSceneProducer*, const MDagPath&)>;
+        = std::function<MayaHydraShapeAdapterPtr(MayaHydraSceneIndex*, const MDagPath&)>;
     MAYAHYDRALIB_API
     static void RegisterShapeAdapter(const TfToken& type, ShapeAdapterCreator creator);
 
     MAYAHYDRALIB_API
     static ShapeAdapterCreator GetShapeAdapterCreator(const MDagPath& dag);
 
     using LightAdapterCreator
-        = std::function<MayaHydraLightAdapterPtr(MayaHydraSceneProducer*, const MDagPath&)>;
+        = std::function<MayaHydraLightAdapterPtr(MayaHydraSceneIndex*, const MDagPath&)>;
     MAYAHYDRALIB_API
     static void RegisterLightAdapter(const TfToken& type, LightAdapterCreator creator);
 
@@ -63,15 +63,15 @@ class MayaHydraAdapterRegistry : public TfSingleton<MayaHydraAdapterRegistry>
     static LightAdapterCreator GetLightAdapterCreator(const MObject& dag);
 
     using MaterialAdapterCreator = std::function<
-        MayaHydraMaterialAdapterPtr(const SdfPath&, MayaHydraSceneProducer*, const MObject&)>;
+        MayaHydraMaterialAdapterPtr(const SdfPath&, MayaHydraSceneIndex*, const MObject&)>;
     MAYAHYDRALIB_API
     static void RegisterMaterialAdapter(const TfToken& type, MaterialAdapterCreator creator);
 
     MAYAHYDRALIB_API
     static MaterialAdapterCreator GetMaterialAdapterCreator(const MObject& node);
 
     using CameraAdapterCreator
-        = std::function<MayaHydraCameraAdapterPtr(MayaHydraSceneProducer*, const MDagPath&)>;
+        = std::function<MayaHydraCameraAdapterPtr(MayaHydraSceneIndex*, const MDagPath&)>;
     MAYAHYDRALIB_API
     static void RegisterCameraAdapter(const TfToken& type, CameraAdapterCreator creator);
 

lib/mayaHydra/hydraExtensions/adapters/aiSkydomeLightAdapter.cpp

@@ -20,7 +20,7 @@
 #include <mayaHydraLib/adapters/lightAdapter.h>
 #include <mayaHydraLib/adapters/mayaAttrs.h>
 #include <mayaHydraLib/adapters/tokens.h>
-#include <mayaHydraLib/mayaHydraSceneProducer.h>
+#include <mayaHydraLib/sceneIndex/mayaHydraSceneIndex.h>
 
 #include <pxr/base/tf/type.h>
 #include <pxr/imaging/hd/light.h>
@@ -33,7 +33,7 @@
 
 PXR_NAMESPACE_OPEN_SCOPE
 
-class MayaHydraSceneProducer;
+class MayaHydraSceneIndex;
 
 /**
  * \brief MayaHydraAiSkyDomeLightAdapter is used to handle the translation from an Arnold skydome
@@ -59,8 +59,8 @@ class MayaHydraAiSkyDomeLightAdapter : public MayaHydraLightAdapter
     bool _colorIsConnected  = false;
 
 public:
-    MayaHydraAiSkyDomeLightAdapter(MayaHydraSceneProducer* producer, const MDagPath& dag)
-        : MayaHydraLightAdapter(producer, dag)
+    MayaHydraAiSkyDomeLightAdapter(MayaHydraSceneIndex* mayaHydraSceneIndex, const MDagPath& dag)
+        : MayaHydraLightAdapter(mayaHydraSceneIndex, dag)
     {
         //Init static variables if needed
         if (! _pTextureManager){
@@ -185,7 +185,7 @@ class MayaHydraAiSkyDomeLightAdapter : public MayaHydraLightAdapter
             if (!_colorIsConnected){
                 if (!_dummyTextureFullPathFilename.empty()){
                     // Update Hydra texture resource everytime Domelight color is tweaked.
-                    auto resourceReg = GetSceneProducer()->GetRenderIndex().GetResourceRegistry();
+                    auto resourceReg = GetMayaHydraSceneIndex()->GetRenderIndex().GetResourceRegistry();
                     if (TF_VERIFY(resourceReg, "Unable to update AikSkyDomelights constant color"))
                         resourceReg->ReloadResource(TfToken("texture"), _dummyTextureFullPathFilename);
                     // SdfAssetPath requires both "path" and "resolvedPath"
@@ -240,8 +240,8 @@ TF_REGISTRY_FUNCTION_WITH_TAG(MayaHydraAdapterRegistry, domeLight)
 {
     MayaHydraAdapterRegistry::RegisterLightAdapter(
         TfToken("aiSkyDomeLight"),
-        [](MayaHydraSceneProducer* producer, const MDagPath& dag) -> MayaHydraLightAdapterPtr {
-            return MayaHydraLightAdapterPtr(new MayaHydraAiSkyDomeLightAdapter(producer, dag));
+        [](MayaHydraSceneIndex* mayaHydraSceneIndex, const MDagPath& dag) -> MayaHydraLightAdapterPtr {
+            return MayaHydraLightAdapterPtr(new MayaHydraAiSkyDomeLightAdapter(mayaHydraSceneIndex, dag));
         });
 }
 

lib/mayaHydra/hydraExtensions/adapters/areaLightAdapter.cpp

@@ -16,7 +16,7 @@
 #include <mayaHydraLib/adapters/adapterDebugCodes.h>
 #include <mayaHydraLib/adapters/adapterRegistry.h>
 #include <mayaHydraLib/adapters/lightAdapter.h>
-#include <mayaHydraLib/mayaHydraSceneProducer.h>
+#include <mayaHydraLib/sceneIndex/mayaHydraSceneIndex.h>
 
 #include <pxr/base/tf/type.h>
 #include <pxr/imaging/hd/light.h>
@@ -31,16 +31,16 @@ PXR_NAMESPACE_OPEN_SCOPE
 class MayaHydraAreaLightAdapter : public MayaHydraLightAdapter
 {
 public:
-    MayaHydraAreaLightAdapter(MayaHydraSceneProducer* producer, const MDagPath& dag)
-        : MayaHydraLightAdapter(producer, dag)
+    MayaHydraAreaLightAdapter(MayaHydraSceneIndex* mayaHydraSceneIndex, const MDagPath& dag)
+        : MayaHydraLightAdapter(mayaHydraSceneIndex, dag)
     {
     }
 
     void _CalculateLightParams(GlfSimpleLight& light) override { light.SetSpotCutoff(90.0f); }
 
     const TfToken& LightType() const override
     {
-        if (GetSceneProducer()->IsHdSt()) {
+        if (GetMayaHydraSceneIndex()->IsHdSt()) {
             return HdPrimTypeTokens->simpleLight;
         } else {
             return HdPrimTypeTokens->rectLight;
@@ -73,8 +73,8 @@ TF_REGISTRY_FUNCTION_WITH_TAG(MayaHydraAdapterRegistry, pointLight)
 {
     MayaHydraAdapterRegistry::RegisterLightAdapter(
         TfToken("areaLight"),
-        [](MayaHydraSceneProducer* producer, const MDagPath& dag) -> MayaHydraLightAdapterPtr {
-            return MayaHydraLightAdapterPtr(new MayaHydraAreaLightAdapter(producer, dag));
+        [](MayaHydraSceneIndex* mayaHydraSceneIndex, const MDagPath& dag) -> MayaHydraLightAdapterPtr {
+            return MayaHydraLightAdapterPtr(new MayaHydraAreaLightAdapter(mayaHydraSceneIndex, dag));
         });
 }
 

lib/mayaHydra/hydraExtensions/adapters/cameraAdapter.cpp

@@ -18,7 +18,7 @@
 #include <mayaHydraLib/adapters/adapterDebugCodes.h>
 #include <mayaHydraLib/adapters/adapterRegistry.h>
 #include <mayaHydraLib/adapters/mayaAttrs.h>
-#include <mayaHydraLib/mayaHydraSceneProducer.h>
+#include <mayaHydraLib/sceneIndex/mayaHydraSceneIndex.h>
 
 #include <pxr/base/gf/interval.h>
 #include <pxr/imaging/hd/camera.h>
@@ -40,16 +40,16 @@ TF_REGISTRY_FUNCTION_WITH_TAG(MayaHydraAdapterRegistry, camera)
 {
     MayaHydraAdapterRegistry::RegisterCameraAdapter(
         HdPrimTypeTokens->camera,
-        [](MayaHydraSceneProducer* producer, const MDagPath& dag) -> MayaHydraCameraAdapterPtr {
-            return MayaHydraCameraAdapterPtr(new MayaHydraCameraAdapter(producer, dag));
+        [](MayaHydraSceneIndex* mayaHydraSceneIndex, const MDagPath& dag) -> MayaHydraCameraAdapterPtr {
+            return MayaHydraCameraAdapterPtr(new MayaHydraCameraAdapter(mayaHydraSceneIndex, dag));
         });
 }
 
 } // namespace
 
 // MayaHydraCameraAdapter is used to handle the translation from a Maya camera to hydra.
-MayaHydraCameraAdapter::MayaHydraCameraAdapter(MayaHydraSceneProducer* producer, const MDagPath& dag)
-    : MayaHydraShapeAdapter(producer->GetPrimPath(dag, true), producer, dag)
+MayaHydraCameraAdapter::MayaHydraCameraAdapter(MayaHydraSceneIndex* mayaHydraSceneIndex, const MDagPath& dag)
+    : MayaHydraShapeAdapter(mayaHydraSceneIndex->GetPrimPath(dag, true), mayaHydraSceneIndex, dag)
 {
 }
 
@@ -59,23 +59,23 @@ TfToken MayaHydraCameraAdapter::CameraType() { return HdPrimTypeTokens->camera;
 
 bool MayaHydraCameraAdapter::IsSupported() const
 {
-    return GetSceneProducer()->GetRenderIndex().IsSprimTypeSupported(CameraType());
+    return GetMayaHydraSceneIndex()->GetRenderIndex().IsSprimTypeSupported(CameraType());
 }
 
 void MayaHydraCameraAdapter::Populate()
 {
     if (_isPopulated) {
         return;
     }
-    GetSceneProducer()->InsertSprim(this, CameraType(), GetID(), HdCamera::AllDirty);
+    GetMayaHydraSceneIndex()->InsertPrim(this, CameraType(), GetID());
     _isPopulated = true;
 }
 
 void MayaHydraCameraAdapter::MarkDirty(HdDirtyBits dirtyBits)
 {
     if (_isPopulated && dirtyBits != 0) {
         dirtyBits = dirtyBits & HdCamera::AllDirty;
-        GetSceneProducer()->MarkSprimDirty(GetID(), dirtyBits);
+        GetMayaHydraSceneIndex()->MarkSprimDirty(GetID(), dirtyBits);
     }
 }
 
@@ -120,7 +120,7 @@ void MayaHydraCameraAdapter::RemovePrim()
     if (!_isPopulated) {
         return;
     }
-    GetSceneProducer()->RemoveSprim(CameraType(), GetID());
+    GetMayaHydraSceneIndex()->RemovePrim(GetID());
     _isPopulated = false;
 }
 
@@ -195,20 +195,20 @@ VtValue MayaHydraCameraAdapter::GetCameraParamValue(const TfToken& paramName)
 
     if (paramName == HdCameraTokens->shutterOpen) {
         // No motion samples, instantaneous shutter
-        if (!GetSceneProducer()->GetParams().motionSamplesEnabled())
+        if (!GetMayaHydraSceneIndex()->GetParams().motionSamplesEnabled())
             return VtValue(double(0));
-        return VtValue(double(GetSceneProducer()->GetCurrentTimeSamplingInterval().GetMin()));
+        return VtValue(double(GetMayaHydraSceneIndex()->GetCurrentTimeSamplingInterval().GetMin()));
     }
     if (paramName == HdCameraTokens->shutterClose) {
         // No motion samples, instantaneous shutter
-        if (!GetSceneProducer()->GetParams().motionSamplesEnabled())
+        if (!GetMayaHydraSceneIndex()->GetParams().motionSamplesEnabled())
             return VtValue(double(0));
         const auto shutterAngle = camera.shutterAngle(&status);
         if (hadError(status))
             return {};
         auto constexpr maxRadians = M_PI * 2.0;
         auto shutterClose = std::min(std::max(0.0, shutterAngle), maxRadians) / maxRadians;
-        auto interval = GetSceneProducer()->GetCurrentTimeSamplingInterval();
+        auto interval = GetMayaHydraSceneIndex()->GetCurrentTimeSamplingInterval();
         return VtValue(double(interval.GetMin() + interval.GetSize() * shutterClose));
     }
 

lib/mayaHydra/hydraExtensions/adapters/cameraAdapter.h

@@ -23,7 +23,7 @@
 
 PXR_NAMESPACE_OPEN_SCOPE
 
-class MayaHydraSceneProducer;
+class MayaHydraSceneIndex;
 
 /**
  * \brief MayaHydraCameraAdapter is used to handle the translation from a Maya camera to hydra.
@@ -32,7 +32,7 @@ class MayaHydraCameraAdapter : public MayaHydraShapeAdapter
 {
 public:
     MAYAHYDRALIB_API
-    MayaHydraCameraAdapter(MayaHydraSceneProducer* producer, const MDagPath& dag);
+    MayaHydraCameraAdapter(MayaHydraSceneIndex* mayaHydraSceneIndex, const MDagPath& dag);
 
     MAYAHYDRALIB_API
     virtual ~MayaHydraCameraAdapter();