Added vsg::SoftShadows and vsg::Percentage CloserSoftShadows support.

CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.7)
 
 project(vsg
-    VERSION 1.1.2
+    VERSION 1.1.3
     DESCRIPTION "VulkanSceneGraph library"
     LANGUAGES CXX
 )

cmake/build_all_h.cmake

@@ -15,6 +15,7 @@ macro(BUILD_ALL_H)
     file(GLOB MATHS_HEADERS RELATIVE ${INCLUDE_DIR} ${INCLUDE_DIR}/vsg/maths/*.h )
     file(GLOB NODES_HEADERS RELATIVE ${INCLUDE_DIR} ${INCLUDE_DIR}/vsg/nodes/*.h )
     file(GLOB ANIMATION_HEADERS RELATIVE ${INCLUDE_DIR} ${INCLUDE_DIR}/vsg/animation/*.h )
+    file(GLOB LIGHTING_HEADERS RELATIVE ${INCLUDE_DIR} ${INCLUDE_DIR}/vsg/lighting/*.h )
     file(GLOB THREADING_HEADERS RELATIVE ${INCLUDE_DIR} ${INCLUDE_DIR}/vsg/threading/*.h )
     file(GLOB UI_HEADERS RELATIVE ${INCLUDE_DIR} ${INCLUDE_DIR}/vsg/ui/*.h )
     file(GLOB UTILS_HEADERS RELATIVE ${INCLUDE_DIR} ${INCLUDE_DIR}/vsg/utils/*.h )
@@ -35,6 +36,7 @@ macro(BUILD_ALL_H)
     APPEND_INCLUDES(ALL_H_CONTENTS MATHS_HEADERS "// Maths header files\n")
     APPEND_INCLUDES(ALL_H_CONTENTS NODES_HEADERS "// Node header files\n")
     APPEND_INCLUDES(ALL_H_CONTENTS ANIMATION_HEADERS "// Animation header files\n")
+    APPEND_INCLUDES(ALL_H_CONTENTS LIGHTING_HEADERS "// Lighting header files\n")
     APPEND_INCLUDES(ALL_H_CONTENTS COMMANDS_HEADERS "// Commands header files\n")
     APPEND_INCLUDES(ALL_H_CONTENTS STATE_HEADERS "// State header files\n")
     APPEND_INCLUDES(ALL_H_CONTENTS THREADING_HEADERS "// Threading header files\n")

include/vsg/all.h

@@ -67,7 +67,6 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 #include <vsg/nodes/InstrumentationNode.h>
 #include <vsg/nodes/LOD.h>
 #include <vsg/nodes/Layer.h>
-#include <vsg/nodes/Light.h>
 #include <vsg/nodes/MatrixTransform.h>
 #include <vsg/nodes/Node.h>
 #include <vsg/nodes/PagedLOD.h>
@@ -90,6 +89,17 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 #include <vsg/animation/MorphSampler.h>
 #include <vsg/animation/TransformSampler.h>
 
+// Lighting header files
+#include <vsg/lighting/AmbientLight.h>
+#include <vsg/lighting/DirectionalLight.h>
+#include <vsg/lighting/HardShadows.h>
+#include <vsg/lighting/Light.h>
+#include <vsg/lighting/PercentageCloserSoftShadows.h>
+#include <vsg/lighting/PointLight.h>
+#include <vsg/lighting/ShadowSettings.h>
+#include <vsg/lighting/SoftShadows.h>
+#include <vsg/lighting/SpotLight.h>
+
 // Commands header files
 #include <vsg/commands/BeginQuery.h>
 #include <vsg/commands/BindIndexBuffer.h>

include/vsg/lighting/AmbientLight.h

@@ -0,0 +1,40 @@
+#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/lighting/Light.h>
+#include <vsg/maths/common.h>
+#include <vsg/nodes/Node.h>
+
+namespace vsg
+{
+
+    /// AmbientLight represents an ambient light source
+    class VSG_DECLSPEC AmbientLight : public Inherit<Light, AmbientLight>
+    {
+    public:
+        AmbientLight();
+        AmbientLight(const AmbientLight& rhs, const CopyOp& copyop = {});
+
+    public:
+        ref_ptr<Object> clone(const CopyOp& copyop = {}) const override { return AmbientLight::create(*this, copyop); }
+
+        void read(Input& input) override;
+        void write(Output& output) const override;
+
+    protected:
+        virtual ~AmbientLight() {}
+    };
+    VSG_type_name(vsg::AmbientLight);
+
+} // namespace vsg

include/vsg/lighting/DirectionalLight.h

@@ -0,0 +1,44 @@
+#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/lighting/Light.h>
+#include <vsg/maths/common.h>
+#include <vsg/nodes/Node.h>
+
+namespace vsg
+{
+
+    /// DirectionalLight represents a directional light source - used for light sources that are treated as if at infinite distance, like sun/moon.
+    class VSG_DECLSPEC DirectionalLight : public Inherit<Light, DirectionalLight>
+    {
+    public:
+        DirectionalLight();
+        DirectionalLight(const DirectionalLight& rhs, const CopyOp& copyop = {});
+
+        dvec3 direction = dvec3(0.0, 0.0, -1.0);
+        float angleSubtended = 0.0090f;
+
+    public:
+        ref_ptr<Object> clone(const CopyOp& copyop = {}) const override { return DirectionalLight::create(*this, copyop); }
+        int compare(const Object& rhs) const override;
+
+        void read(Input& input) override;
+        void write(Output& output) const override;
+
+    protected:
+        virtual ~DirectionalLight() {}
+    };
+    VSG_type_name(vsg::DirectionalLight);
+
+} // namespace vsg

include/vsg/lighting/HardShadows.h

@@ -0,0 +1,35 @@
+#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/lighting/ShadowSettings.h>
+
+namespace vsg
+{
+
+    class VSG_DECLSPEC HardShadows : public Inherit<ShadowSettings, HardShadows>
+    {
+    public:
+        explicit HardShadows(uint32_t in_shadowMaps = 1);
+        HardShadows(const HardShadows& rhs, const CopyOp& copyop = {});
+
+    public:
+        ref_ptr<Object> clone(const CopyOp& copyop = {}) const override { return HardShadows::create(*this, copyop); }
+        int compare(const Object& rhs) const override;
+
+        void read(Input& input) override;
+        void write(Output& output) const override;
+    };
+    VSG_type_name(vsg::HardShadows);
+
+} // namespace vsg

include/vsg/lighting/Light.h

@@ -0,0 +1,51 @@
+#pragma once
+
+/* <editor-fold desc="MIT License">
+
+Copyright(c) 2022 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/lighting/ShadowSettings.h>
+#include <vsg/maths/common.h>
+#include <vsg/nodes/Node.h>
+
+namespace vsg
+{
+
+    /// Light is a base node class for different light types - AmbientLight, DirectionalLight, PointLight and SpotLight.
+    /// Used by the RecordTraversal to represent a light source that is placed in the LightData uniform used by the shaders when implementing lighting.
+    /// Provides name, color and intensity settings common to all Light types.
+    class VSG_DECLSPEC Light : public Inherit<Node, Light>
+    {
+    public:
+        Light();
+        Light(const Light& rhs, const CopyOp& copyop = {});
+
+        std::string name;
+        vec3 color = vec3(1.0f, 1.0f, 1.0f);
+        float intensity = 1.0f;
+        ref_ptr<ShadowSettings> shadowSettings;
+
+    public:
+        ref_ptr<Object> clone(const CopyOp& copyop = {}) const override { return Light::create(*this, copyop); }
+        int compare(const Object& rhs) const override;
+
+        void read(Input& input) override;
+        void write(Output& output) const override;
+
+    protected:
+        virtual ~Light() {}
+    };
+    VSG_type_name(vsg::Light);
+
+    /// convenience method for creating a subgraph with a headlight illumination using a white AmbientLight and DirectionalLight with intensity of 0.05 and 0.95 respectively.
+    extern VSG_DECLSPEC ref_ptr<vsg::Node> createHeadlight();
+
+} // namespace vsg

include/vsg/lighting/PercentageCloserSoftShadows.h

@@ -0,0 +1,35 @@
+#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/lighting/ShadowSettings.h>
+
+namespace vsg
+{
+
+    class VSG_DECLSPEC PercentageCloserSoftShadows : public Inherit<ShadowSettings, PercentageCloserSoftShadows>
+    {
+    public:
+        explicit PercentageCloserSoftShadows(uint32_t in_shadowMaps = 1);
+        PercentageCloserSoftShadows(const PercentageCloserSoftShadows& rhs, const CopyOp& copyop = {});
+
+    public:
+        ref_ptr<Object> clone(const CopyOp& copyop = {}) const override { return PercentageCloserSoftShadows::create(*this, copyop); }
+        int compare(const Object& rhs) const override;
+
+        void read(Input& input) override;
+        void write(Output& output) const override;
+    };
+    VSG_type_name(vsg::PercentageCloserSoftShadows);
+
+} // namespace vsg

include/vsg/lighting/PointLight.h

@@ -0,0 +1,44 @@
+#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/lighting/Light.h>
+#include <vsg/maths/common.h>
+#include <vsg/nodes/Node.h>
+
+namespace vsg
+{
+
+    /// PointLight represents a local point light source where all light radiants event from the light position.
+    class VSG_DECLSPEC PointLight : public Inherit<Light, PointLight>
+    {
+    public:
+        PointLight();
+        PointLight(const PointLight& rhs, const CopyOp& copyop = {});
+
+        dvec3 position = dvec3(0.0, 0.0, 0.0);
+        double radius = 0.0f;
+
+    public:
+        ref_ptr<Object> clone(const CopyOp& copyop = {}) const override { return PointLight::create(*this, copyop); }
+        int compare(const Object& rhs) const override;
+
+        void read(Input& input) override;
+        void write(Output& output) const override;
+
+    protected:
+        virtual ~PointLight() {}
+    };
+    VSG_type_name(vsg::PointLight);
+
+} // namespace vsg

include/vsg/lighting/ShadowSettings.h

@@ -0,0 +1,40 @@
+#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/core/Inherit.h>
+
+namespace vsg
+{
+
+    class VSG_DECLSPEC ShadowSettings : public Inherit<Object, ShadowSettings>
+    {
+    public:
+        explicit ShadowSettings(uint32_t shadowMaps = 1);
+        ShadowSettings(const ShadowSettings& rhs, const CopyOp& copyop = {});
+
+        uint32_t shadowMapCount = 1;
+
+    public:
+        ref_ptr<Object> clone(const CopyOp& copyop = {}) const override { return ShadowSettings::create(*this, copyop); }
+        int compare(const Object& rhs) const override;
+
+        void read(Input& input) override;
+        void write(Output& output) const override;
+
+    protected:
+        virtual ~ShadowSettings() {}
+    };
+    VSG_type_name(vsg::ShadowSettings);
+
+} // namespace vsg

include/vsg/lighting/SoftShadows.h

@@ -0,0 +1,37 @@
+#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/lighting/ShadowSettings.h>
+
+namespace vsg
+{
+
+    class VSG_DECLSPEC SoftShadows : public Inherit<ShadowSettings, SoftShadows>
+    {
+    public:
+        explicit SoftShadows(uint32_t in_shadowMaps = 1, float in_penumbraRadius = 0.05f);
+        SoftShadows(const SoftShadows& rhs, const CopyOp& copyop = {});
+
+        float penumbraRadius = 0.05f;
+
+    public:
+        ref_ptr<Object> clone(const CopyOp& copyop = {}) const override { return SoftShadows::create(*this, copyop); }
+        int compare(const Object& rhs) const override;
+
+        void read(Input& input) override;
+        void write(Output& output) const override;
+    };
+    VSG_type_name(vsg::SoftShadows);
+
+} // namespace vsg