Added vsg::RegionOfInterst node to help hint for algorithms like shadow map to use tight bounds

include/vsg/all.h

@@ -71,6 +71,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 #include <vsg/nodes/Node.h>
 #include <vsg/nodes/PagedLOD.h>
 #include <vsg/nodes/QuadGroup.h>
+#include <vsg/nodes/RegionOfInterest.h>
 #include <vsg/nodes/StateGroup.h>
 #include <vsg/nodes/Switch.h>
 #include <vsg/nodes/TileDatabase.h>

include/vsg/app/RecordTraversal.h

@@ -51,6 +51,7 @@ namespace vsg
     class View;
     class Bin;
     class Switch;
+    class RegionOfInterest;
     class ViewDependentState;
     class Light;
     class AmbientLight;
@@ -117,6 +118,7 @@ namespace vsg
         void apply(const DepthSorted& depthSorted);
         void apply(const Layer& layer);
         void apply(const Switch& sw);
+        void apply(const RegionOfInterest& roi);
 
         // leaf node
         void apply(const VertexDraw& vid);
@@ -154,6 +156,9 @@ namespace vsg
         // clear the bins to record a new frame.
         void clearBins();
 
+        // list of pairs of modelview matrix & region of interest
+        std::vector<std::pair<dmat4, const RegionOfInterest*>> regionsOfInterest;
+
     protected:
         virtual ~RecordTraversal();
 

include/vsg/core/ConstVisitor.h

@@ -49,6 +49,7 @@ namespace vsg
     class PointLight;
     class SpotLight;
     class InstrumentationNode;
+    class RegionOfInterest;
 
     // forward declare text classes
     class Text;
@@ -337,6 +338,7 @@ namespace vsg
         virtual void apply(const PointLight&);
         virtual void apply(const SpotLight&);
         virtual void apply(const InstrumentationNode&);
+        virtual void apply(const RegionOfInterest&);
 
         // text
         virtual void apply(const Text&);

include/vsg/core/Visitor.h

@@ -49,6 +49,7 @@ namespace vsg
     class PointLight;
     class SpotLight;
     class InstrumentationNode;
+    class RegionOfInterest;
 
     // forward declare text classes
     class Text;
@@ -337,6 +338,7 @@ namespace vsg
         virtual void apply(PointLight&);
         virtual void apply(SpotLight&);
         virtual void apply(InstrumentationNode&);
+        virtual void apply(RegionOfInterest&);
 
         // text
         virtual void apply(Text&);

include/vsg/nodes/RegionOfInterest.h

@@ -0,0 +1,57 @@
+#pragma once
+
+/* <editor-fold desc="MIT License">
+
+Copyright(c) 2024 Robert Osfield
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+</editor-fold> */
+
+#include <vsg/maths/sphere.h>
+#include <vsg/nodes/Node.h>
+
+namespace vsg
+{
+
+    /// RegionOfInterest node is inform applications/algorithms extents that should take account of.
+    class VSG_DECLSPEC RegionOfInterest : public Inherit<Node, RegionOfInterest>
+    {
+    public:
+        RegionOfInterest();
+        RegionOfInterest(const RegionOfInterest& rhs, const CopyOp& copyop = {});
+
+        Mask mask = MASK_ALL;
+        std::string name;
+        std::vector<dvec3> points;
+
+    public:
+        ref_ptr<Object> clone(const CopyOp& copyop = {}) const override { return RegionOfInterest::create(*this, copyop); }
+        int compare(const Object& rhs) const override;
+
+        void accept(Visitor& visitor) override
+        {
+            if ((visitor.traversalMask & (visitor.overrideMask | mask)) != MASK_OFF) visitor.apply(*this);
+        }
+        void accept(ConstVisitor& visitor) const override
+        {
+            if ((visitor.traversalMask & (visitor.overrideMask | mask)) != MASK_OFF) visitor.apply(*this);
+        }
+        void accept(RecordTraversal& visitor) const override
+        {
+            if ((visitor.traversalMask & (visitor.overrideMask | mask)) != MASK_OFF) visitor.apply(*this);
+        }
+
+        void read(Input& input) override;
+        void write(Output& output) const override;
+
+    protected:
+        virtual ~RegionOfInterest();
+    };
+    VSG_type_name(vsg::RegionOfInterest);
+
+} // namespace vsg

src/vsg/CMakeLists.txt

@@ -43,6 +43,7 @@ set(SOURCES
     nodes/StateGroup.cpp
     nodes/TileDatabase.cpp
     nodes/InstrumentationNode.cpp
+    nodes/RegionOfInterest.cpp
 
     lighting/Light.cpp
     lighting/AmbientLight.cpp

src/vsg/app/CommandGraph.cpp

@@ -92,6 +92,7 @@ void CommandGraph::record(ref_ptr<RecordedCommandBuffers> recordedCommandBuffers
     recordTraversal->setFrameStamp(frameStamp);
     recordTraversal->setDatabasePager(databasePager);
     recordTraversal->clearBins();
+    recordTraversal->regionsOfInterest.clear();
 
     ref_ptr<CommandBuffer> commandBuffer;
     for (auto& cb : _commandBuffers)

src/vsg/app/RecordTraversal.cpp

@@ -289,6 +289,13 @@ void RecordTraversal::apply(const Switch& sw)
     }
 }
 
+void RecordTraversal::apply(const RegionOfInterest& roi)
+{
+    CPU_INSTRUMENTATION_L2_NCO(instrumentation, "RegionOfInterest", COLOR_RECORD_L2, &roi);
+
+    regionsOfInterest.emplace_back(_state->modelviewMatrixStack.top(), &roi);
+}
+
 void RecordTraversal::apply(const DepthSorted& depthSorted)
 {
     CPU_INSTRUMENTATION_L2_NCO(instrumentation, "DepthSorted", COLOR_RECORD_L2, &depthSorted);
@@ -497,6 +504,9 @@ void RecordTraversal::apply(const View& view)
     cached_bins.swap(_bins);
     auto cached_viewDependentState = _viewDependentState;
 
+    decltype(regionsOfInterest) cached_regionsOfInterest;
+    cached_regionsOfInterest.swap(regionsOfInterest);
+
     // assign and clear the View's bins
     int32_t min_binNumber = 0;
     int32_t max_binNumber = 0;
@@ -566,6 +576,7 @@ void RecordTraversal::apply(const View& view)
     // swap back previous bin setup.
     _minimumBinNumber = cached_minimumBinNumber;
     cached_bins.swap(_bins);
+    cached_regionsOfInterest.swap(regionsOfInterest);
     _state->_commandBuffer->traversalMask = cached_traversalMask;
     _viewDependentState = cached_viewDependentState;
 }

src/vsg/core/ConstVisitor.cpp

@@ -625,6 +625,10 @@ void ConstVisitor::apply(const InstrumentationNode& value)
 {
     apply(static_cast<const Node&>(value));
 }
+void ConstVisitor::apply(const RegionOfInterest& value)
+{
+    apply(static_cast<const Node&>(value));
+}
 
 ////////////////////////////////////////////////////////////////////////////////
 //

src/vsg/core/Visitor.cpp

@@ -625,6 +625,10 @@ void Visitor::apply(InstrumentationNode& value)
 {
     apply(static_cast<Node&>(value));
 }
+void Visitor::apply(RegionOfInterest& value)
+{
+    apply(static_cast<Node&>(value));
+}
 
 ////////////////////////////////////////////////////////////////////////////////
 //

src/vsg/nodes/RegionOfInterest.cpp

@@ -0,0 +1,62 @@
+/* <editor-fold desc="MIT License">
+
+Copyright(c) 2024 Robert Osfield
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+</editor-fold> */
+
+#include <vsg/io/Options.h>
+#include <vsg/io/stream.h>
+#include <vsg/nodes/RegionOfInterest.h>
+
+using namespace vsg;
+
+RegionOfInterest::RegionOfInterest()
+{
+}
+
+RegionOfInterest::RegionOfInterest(const RegionOfInterest& rhs, const CopyOp& copyop) :
+    Inherit(rhs, copyop),
+    mask(rhs.mask),
+    name(rhs.name),
+    points(rhs.points)
+{
+}
+
+RegionOfInterest::~RegionOfInterest()
+{
+}
+
+int RegionOfInterest::compare(const Object& rhs_object) const
+{
+    int result = Node::compare(rhs_object);
+    if (result != 0) return result;
+
+    auto& rhs = static_cast<decltype(*this)>(rhs_object);
+    if ((result = compare_value(mask, rhs.mask)) != 0) return result;
+    if ((result = compare_value(name, rhs.name)) != 0) return result;
+    return compare_value_container(points, rhs.points);
+}
+
+void RegionOfInterest::read(Input& input)
+{
+    Node::read(input);
+
+    input.read("mask", mask);
+    input.read("name", name);
+    input.read("points", points);
+}
+
+void RegionOfInterest::write(Output& output) const
+{
+    Node::write(output);
+
+    output.write("mask", mask);
+    output.write("name", name);
+    output.write("points", points);
+}

src/vsg/state/ViewDependentState.cpp

@@ -23,6 +23,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 #include <vsg/lighting/PointLight.h>
 #include <vsg/lighting/SoftShadows.h>
 #include <vsg/lighting/SpotLight.h>
+#include <vsg/nodes/RegionOfInterest.h>
 #include <vsg/state/DescriptorImage.h>
 #include <vsg/state/ViewDependentState.h>
 #include <vsg/vk/Context.h>
@@ -576,6 +577,38 @@ void ViewDependentState::traverse(RecordTraversal& rt) const
 
     // info("\n\nViewDependentState::traverse(", &rt, ", ", &view, ") numShadowMaps = ", numShadowMaps);
 
+    // cache general view parameters
+    auto projectionMatrix = view->camera->projectionMatrix->transform();
+    auto viewMatrix = view->camera->viewMatrix->transform();
+    auto inverse_viewMatrix = inverse(viewMatrix);
+    auto view_direction = normalize(dvec3(0.0, 0.0, -1.0) * (projectionMatrix * viewMatrix));
+    auto view_up = normalize(dvec3(0.0, -1.0, 0.0) * (projectionMatrix * viewMatrix));
+
+    auto clipToEye = inverse(projectionMatrix);
+    auto n = -(clipToEye * dvec3(0.0, 0.0, 1.0)).z;
+    auto f = -(clipToEye * dvec3(0.0, 0.0, 0.0)).z;
+
+    // if regions of interest have been found in the scene graph use them to clamp the near/far values.
+    if (!rt.regionsOfInterest.empty())
+    {
+        dbox eyeSpaceRegionBounds;
+        for (auto& [mv, regionOfInterest] : rt.regionsOfInterest)
+        {
+            for (auto& v : regionOfInterest->points)
+            {
+                eyeSpaceRegionBounds.add(mv * v);
+            }
+        }
+
+        if (eyeSpaceRegionBounds)
+        {
+            double regionNear = -eyeSpaceRegionBounds.max.z;
+            double regionFar = -eyeSpaceRegionBounds.min.z;
+            if (regionNear > n) { n = regionNear; }
+            if (regionFar < f) { f = regionFar; }
+        }
+    }
+
     // set up the light data
     auto light_itr = lightData->begin();
     lightData->dirty();
@@ -629,14 +662,6 @@ void ViewDependentState::traverse(RecordTraversal& rt) const
         requiresPerRenderShadowMaps = true;
 
         // compute directional light space
-        auto projectionMatrix = view->camera->projectionMatrix->transform();
-        auto viewMatrix = view->camera->viewMatrix->transform();
-        auto inverse_viewMatrix = inverse(viewMatrix);
-
-        // view direction in world coords
-        auto view_direction = normalize(dvec3(0.0, 0.0, -1.0) * (projectionMatrix * viewMatrix));
-        auto view_up = normalize(dvec3(0.0, -1.0, 0.0) * (projectionMatrix * viewMatrix));
-
         // light direction in world coords
         auto light_direction = normalize(light->direction * (inverse_3x3(mv * inverse_viewMatrix)));
 #if 0
@@ -652,11 +677,6 @@ void ViewDependentState::traverse(RecordTraversal& rt) const
         auto light_y = cross(light_x, light_direction);
         auto light_z = light_direction;
 
-        auto clipToEye = inverse(projectionMatrix);
-
-        auto n = -(clipToEye * dvec3(0.0, 0.0, 1.0)).z;
-        auto f = -(clipToEye * dvec3(0.0, 0.0, 0.0)).z;
-
         // clamp the near and far values
         if (n > maxShadowDistance)
         {