HdRenderIndex: Adding new constructor that takes the terminal scene index and does not construct the emulation scene index, the merging scene index and the subsequent scene indices.

The new constructor is for applications that do not need front-end emulation in the render index and take complete responsibility for creating the entire scene index graph (including the scene index plugins).

(Internal change: 2379800)

Author: unhyperbolic

pxr/imaging/hd/changeTracker.cpp

@@ -48,6 +48,7 @@ HdChangeTracker::HdChangeTracker()
     , _rprimRenderTagVersion(1)
     , _taskRenderTagsVersion(1)
     , _emulationSceneIndex(nullptr)
+    , _disableEmulationAPI(false)
 {
     /*NOTHING*/
 }
@@ -127,6 +128,10 @@ HdChangeTracker::MarkRprimDirty(SdfPath const& id, HdDirtyBits bits)
             _emulationSceneIndex->DirtyPrims({{id, locators}});
         }
     } else {
+        if (_disableEmulationAPI) {
+            TF_CODING_ERROR(
+                "Calling method on HdChangeTracker that requires emulation.");
+        }
         // XXX: During the migration, "DirtyPrimvar" implies DirtyPoints/etc.
         if (bits & DirtyPrimvar) {
             bits |= DirtyPoints | DirtyNormals | DirtyWidths;
@@ -409,6 +414,10 @@ HdChangeTracker::MarkTaskDirty(SdfPath const& id, HdDirtyBits bits)
             _emulationSceneIndex->DirtyPrims({{id, locators}});
         }
     } else {
+        if (_disableEmulationAPI) {
+            TF_CODING_ERROR(
+                "Calling method on HdChangeTracker that requires emulation.");
+        }
         _MarkTaskDirty(id, bits);
     }
 }
@@ -496,6 +505,10 @@ HdChangeTracker::MarkInstancerDirty(SdfPath const& id, HdDirtyBits bits)
             _emulationSceneIndex->DirtyPrims({{id, locators}});
         }
     } else {
+        if (_disableEmulationAPI) {
+            TF_CODING_ERROR(
+                "Calling method on HdChangeTracker that requires emulation.");
+        }
         _MarkInstancerDirty(id, bits);
     }
 }
@@ -623,6 +636,10 @@ HdChangeTracker::MarkSprimDirty(SdfPath const& id, HdDirtyBits bits)
             _emulationSceneIndex->DirtyPrims({{id, locators}});
         }
     } else {
+        if (_disableEmulationAPI) {
+            TF_CODING_ERROR(
+                "Calling method on HdChangeTracker that requires emulation.");
+        }
         _MarkSprimDirty(id, bits);
     }
 }
@@ -720,6 +737,10 @@ HdChangeTracker::MarkBprimDirty(SdfPath const& id, HdDirtyBits bits)
             _emulationSceneIndex->DirtyPrims({{id, locators}});
         }
     } else {
+        if (_disableEmulationAPI) {
+            TF_CODING_ERROR(
+                "Calling method on HdChangeTracker that requires emulation.");
+        }
         _MarkBprimDirty(id, bits);
     }
 }
@@ -993,6 +1014,11 @@ HdChangeTracker::MarkAllRprimsDirty(HdDirtyBits bits)
         return;
     }
 
+    if (_disableEmulationAPI) {
+        TF_CODING_ERROR(
+            "Calling method on HdChangeTracker that requires emulation.");
+    }
+
     //
     // This function runs similar to calling MarkRprimDirty on every prim.
     // First it checks to see if the request will set any new dirty bits that
@@ -1286,5 +1312,11 @@ HdChangeTracker::_SetTargetSceneIndex(HdRetainedSceneIndex *emulationSceneIndex)
     _emulationSceneIndex = emulationSceneIndex;
 }
 
+void
+HdChangeTracker::_SetDisableEmulationAPI(bool disable)
+{
+    _disableEmulationAPI = disable;
+}
+
 PXR_NAMESPACE_CLOSE_SCOPE
 

pxr/imaging/hd/changeTracker.h

@@ -655,7 +655,9 @@ class HdChangeTracker
     // Does not take ownership. The HdRenderIndex manages the lifetime of this
     // scene index.
     HdRetainedSceneIndex * _emulationSceneIndex;
+    bool _disableEmulationAPI;
     void _SetTargetSceneIndex(HdRetainedSceneIndex *emulationSceneIndex);
+    void _SetDisableEmulationAPI(bool);
 
     // Private methods which implement the behaviors of their public
     // equivalents. The public versions check to see if legacy emulation is