o3de-atom-sampleviewer/Gem/Code/Source/ShadowedSponzaExampleComponent.h

/*
 * Copyright (c) Contributors to the Open 3D Engine Project.
 * For complete copyright and license terms please see the LICENSE at the root of this distribution.
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 *
 */

#pragma once

#include <CommonSampleComponentBase.h>
#include <Atom/Feature/CoreLights/DirectionalLightFeatureProcessorInterface.h>
#include <Atom/Feature/CoreLights/ShadowConstants.h>
#include <Atom/Feature/CoreLights/DiskLightFeatureProcessorInterface.h>
#include <AzCore/Component/TickBus.h>
#include <AzCore/std/containers/vector.h>
#include <AzCore/Math/Aabb.h>
#include <AzCore/Math/Random.h>
#include <Utils/ImGuiSidebar.h>

namespace AtomSampleViewer
{
    /*
     * This component creates a scene of Sponza with shadowing.
     */
    class ShadowedSponzaExampleComponent final
        : public CommonSampleComponentBase
        , public AZ::TickBus::Handler
    {
    public:
        AZ_COMPONENT(ShadowedSponzaExampleComponent, "AAA320C7-1CF7-4CBA-9279-D29BB04B9CA9", CommonSampleComponentBase);

        static void Reflect(AZ::ReflectContext* context);

        ShadowedSponzaExampleComponent() = default;
        ~ShadowedSponzaExampleComponent() override = default;

        void Activate() override;
        void Deactivate() override;

    private:
        using DirectionalLightHandle = AZ::Render::DirectionalLightFeatureProcessorInterface::LightHandle;
        using DiskLightHandle = AZ::Render::DiskLightFeatureProcessorInterface::LightHandle;

        class DiskLight
        {
        public:
            DiskLight() = delete;
            explicit DiskLight(
                const AZ::Color& color,
                const AZ::Vector3& relativePosition,
                AZ::Render::ShadowmapSize shadowmapSize)
                : m_color{ color }
                , m_relativePosition{ relativePosition }
                , m_shadowmapSize{ shadowmapSize }
            {}
            ~DiskLight() = default;

            const AZ::Color m_color;
            const AZ::Vector3 m_relativePosition;
            const AZ::Render::ShadowmapSize m_shadowmapSize;
            DiskLightHandle m_handle;
        };

        static constexpr int DiskLightCountMax = 50;
        static constexpr int DiskLightCountDefault = 10;
        static constexpr float CutoffIntensity = 0.1f;

        static const AZ::Color DirectionalLightColor;
        
        // AZ::TickBus::Handler
        void OnTick(float deltaTime, AZ::ScriptTimePoint timePoint) override;

        void OnModelReady(AZ::Data::Instance<AZ::RPI::Model> model);

        void SaveCameraConfiguration();
        void RestoreCameraConfiguration();
        void SetInitialCameraTransform();

        void SetupScene();
        void BuildDiskLightParameters();
        void UpdateDiskLightCount(uint16_t count);
        const AZ::Color& GetRandomColor();
        AZ::Vector3 GetRandomPosition();
        AZ::Render::ShadowmapSize GetRandomShadowmapSize();

        void DrawSidebar();
        void UpdateDiskLightShadowmapSize();
        void UpdateDiskLightPositions();
        void UpdateDiskLightPosition(int index);
        void SetupDebugFlags();

        float m_originalFarClipDistance = 0.f;

        // lights
        AZ::Render::DirectionalLightFeatureProcessorInterface* m_directionalLightFeatureProcessor = nullptr;
        AZ::Render::DiskLightFeatureProcessorInterface* m_diskLightFeatureProcessor = nullptr;
        DirectionalLightHandle m_directionalLightHandle;
        AZStd::vector<DiskLight> m_diskLights;

        // scene setup
        AZ::SimpleLcgRandom m_random;
        AZ::Aabb m_worldAabb = AZ::Aabb::CreateNull();

        // model
        AZ::Render::MeshFeatureProcessorInterface::MeshHandle m_meshHandle;
        bool m_sponzaExteriorAssetLoaded = false;

        // GUI
        ImGuiSidebar m_imguiSidebar;
        float m_directionalLightPitch = -AZ::Constants::QuarterPi;
        float m_directionalLightYaw = 0.f;
        float m_directionalLightIntensity = 5.f;
        float m_diskLightIntensity = 500.f;
        int m_diskLightCount = 0;
        float m_diskLightsBasePosition[3] = {0.f, 0.f, 0.f};
        float m_diskLightsPositionScatteringRatio = 0.0f;
        bool m_cameraTransformInitialized = false;

        // Shadowmap
        static const AZ::Render::ShadowmapSize s_shadowmapSizes[];
        static const char* s_directionalLightShadowmapSizeLabels[];
        static constexpr int s_shadowmapSizeIndexDefault = 3;
        static constexpr int s_cascadesCountDefault = 4;
        static constexpr float s_ratioLogarithmUniformDefault = 0.8f;
        int m_directionalLightShadowmapSizeIndex = 0;
        int m_cascadeCount = 0;
        float m_ratioLogarithmUniform = 0.f;
        AZ::Render::ShadowmapSize m_diskLightShadowmapSize = AZ::Render::ShadowmapSize::None;
        bool m_diskLightShadowEnabled = true;

        // Edge-softening of directional light shadows
        static const AZ::Render::ShadowFilterMethod s_shadowFilterMethods[];
        static const char* s_shadowFilterMethodLabels[];
        int m_shadowFilterMethodIndexDirectional = 0; // filter method is None.
        int m_shadowFilterMethodIndexDisk = 0; // filter method is None
        int m_filteringSampleCountDirectional = 16;
        int m_filteringSampleCountDisk = 16;

        bool m_shadowEnabled = true;
        bool m_useFullscreenBlur = false;
        bool m_isCascadeCorrectionEnabled = false;
        bool m_isDebugColoringEnabled = false;
        bool m_isDebugBoundingBoxEnabled = false;
    };
} // namespace AtomSampleViewer