[hdSt] Apply render pass cameraVisibility and renderVisibility

rules to point instancers, which are explicitly authored in the
scene by users.  (This integrates an earlier matching change
in HdPrman.)

(Internal change: 2420077)

Author: blevin

pxr/imaging/hdSt/renderPassVisibilitySceneIndexPlugin.cpp

@@ -81,11 +81,35 @@ _IsGeometryType(const TfToken &primType)
             != extraGeomTypes.end();
 }
 
-// Returns true if the renderVisibility rules apply to this prim type.
+// Returns true if the visibility rules apply to this prim
 bool
-_ShouldApplyPassVisibility(const TfToken &primType)
+_ShouldApplyPassVisibility(HdSceneIndexPrim const& prim)
 {
-    return _IsGeometryType(primType) || HdPrimTypeIsLight(primType);
+    // Apply pass visibility to point instancers, which are explicitly created
+    // in the scene by users, but not to other instancers created internally,
+    // e.g. by UsdImaging native instance aggregation.  The latter case is
+    // already handled elsewhere by evaluating the collection against each
+    // instanceLocation.  The general intuition is that user-defined
+    // collections are only ever applied against user-defined paths.
+    if (prim.primType == HdPrimTypeTokens->instancer) {
+        const HdInstancerTopologySchema topoSchema =
+            HdInstancerTopologySchema::GetFromParent(prim.dataSource);
+        if (!topoSchema) {
+            return false;
+        }
+        // If there are no instanceLocations, this is an explicit
+        // point instancer, and we apply visibility rules to the
+        // instancer as a whole.
+        const HdPathArrayDataSourceHandle instanceLocationsDs =
+            topoSchema.GetInstanceLocations();
+        if (!instanceLocationsDs) {
+            return true;
+        }
+        const VtArray<SdfPath> instanceLocations =
+            instanceLocationsDs->GetTypedValue(0.0f);
+        return instanceLocations.empty();
+    }
+    return _IsGeometryType(prim.primType) || HdPrimTypeIsLight(prim.primType);
 }
 
 bool
@@ -131,7 +155,7 @@ struct _RenderPassVisibilityState {
         HdSceneIndexPrim const& prim) const
     {
         return renderVisEval
-            && _ShouldApplyPassVisibility(prim.primType)
+            && _ShouldApplyPassVisibility(prim)
             && !renderVisEval->Match(primPath)
             && _IsVisible(prim.dataSource);
     }

pxr/usdImaging/usdImagingGL/testenv/testUsdImagingGLUsdRenderPass/baseline/renderPassWithInstances_default.exr

@@ -360,7 +360,7 @@ def Scope "Render"
         )
         {
             uniform bool collection:prune:includeRoot = 0
-            uniform pathExpression collection:prune:membershipExpression = "/World/Geom/NativeInstances/SphereInstance_2 /World/Geom/NestedNativeInstances/NestedSpheres_2 /World/Geom/NestedNativeInstances/NestedSpheres_3/SphereInstance_2 /World/Geom/NativeInstancesWithMultiplePrims/NestedSpheres_2 /World/Geom/GroundPlane"
+            uniform pathExpression collection:prune:membershipExpression = "/World/Geom/NativeInstances/SphereInstance_2 /World/Geom/NestedNativeInstances/NestedSpheres_2 /World/Geom/NestedNativeInstances/NestedSpheres_3/SphereInstance_2 /World/Geom/NativeInstancesWithMultiplePrims/NestedSpheres_2 /World/Geom/GroundPlane /World/Geom/PointInstancer"
             uniform token passType = "render"
             # Can use visualizer here
             rel renderSource = </Render/Settings/Visualizer>
@@ -369,7 +369,7 @@ def Scope "Render"
         def RenderPass "matte_test"
         {
             uniform bool collection:matte:includeRoot = 0
-            uniform pathExpression collection:matte:membershipExpression = "/World/Geom/NativeInstances/SphereInstance_2 /World/Geom/NestedNativeInstances/NestedSpheres_2 /World/Geom/NestedNativeInstances/NestedSpheres_3/SphereInstance_2 /World/Geom/NativeInstancesWithMultiplePrims/NestedSpheres_2 /World/Geom/Cube// /World/Geom/Cone// /World/Geom/LargeCone//"
+            uniform pathExpression collection:matte:membershipExpression = "/World/Geom/NativeInstances/SphereInstance_2 /World/Geom/NestedNativeInstances/NestedSpheres_2 /World/Geom/NestedNativeInstances/NestedSpheres_3/SphereInstance_2 /World/Geom/NativeInstancesWithMultiplePrims/NestedSpheres_2 /World/Geom/Cube// /World/Geom/Cone// /World/Geom/LargeCone// /World/Geom/PointInstancer//"
             uniform token passType = "render"
             # Visualizer does not support matte
             rel renderSource = </Render/Settings/Default>
@@ -378,7 +378,7 @@ def Scope "Render"
         def RenderPass "renderVisibility_test"
         {
             uniform bool collection:renderVisibility:includeRoot = 0
-            uniform pathExpression collection:renderVisibility:membershipExpression = "~(/World/Geom/NativeInstances/SphereInstance_2// /World/Geom/NestedNativeInstances/NestedSpheres_2// /World/Geom/NestedNativeInstances/NestedSpheres_3/SphereInstance_2// /World/Geom/NativeInstancesWithMultiplePrims/NestedSpheres_2// /World/Geom/Cube// /World/Geom/Cone// /World/Geom/LargeCone//)"
+            uniform pathExpression collection:renderVisibility:membershipExpression = "~(/World/Geom/NativeInstances/SphereInstance_2// /World/Geom/NestedNativeInstances/NestedSpheres_2// /World/Geom/NestedNativeInstances/NestedSpheres_3/SphereInstance_2// /World/Geom/NativeInstancesWithMultiplePrims/NestedSpheres_2// /World/Geom/Cube// /World/Geom/Cone// /World/Geom/LargeCone// /World/Geom/PointInstancer//)"
             uniform token passType = "render"
             # Can use visualizer here
             rel renderSource = </Render/Settings/Visualizer>
@@ -396,10 +396,9 @@ def Scope "Render"
         def RenderPass "cameraVisibility_test"
         {
             uniform bool collection:cameraVisibility:includeRoot = 0
-            uniform pathExpression collection:cameraVisibility:membershipExpression = "~(/World/Geom/NativeInstances/SphereInstance_2// /World/Geom/NestedNativeInstances/NestedSpheres_2// /World/Geom/NestedNativeInstances/NestedSpheres_3/SphereInstance_2// /World/Geom/NativeInstancesWithMultiplePrims/NestedSpheres_2// /World/Geom/Cube// /World/Geom/Cone// /World/Geom/LargeCone//)"
+            uniform pathExpression collection:cameraVisibility:membershipExpression = "~(/World/Geom/NativeInstances/SphereInstance_2// /World/Geom/NestedNativeInstances/NestedSpheres_2// /World/Geom/NestedNativeInstances/NestedSpheres_3/SphereInstance_2// /World/Geom/NativeInstancesWithMultiplePrims/NestedSpheres_2// /World/Geom/Cube// /World/Geom/Cone// /World/Geom/LargeCone// /World/Geom/PointInstancer//)"
             uniform token passType = "render"
-            # Need lighting to confirm that shadowing from camera-invised
-            # geomtry
+            # Need lighting to confirm shadowing from camera-invised geom
             rel renderSource = </Render/Settings/Default>
         }
     }