o3de-multiplayersample/Gem/Code/Source/Components/ScriptableDecalComponent.cpp

/*
 * 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
 *
 */

#include <Components/ScriptableDecalComponent.h>

#include <AzCore/RTTI/BehaviorContext.h>
#include <AzCore/Serialization/EditContext.h>
#include <AzCore/Serialization/SerializeContext.h>
#include <AzCore/Time/ITime.h>

#include <Atom/RPI.Public/Scene.h>
#include <Atom/RPI.Public/Material/Material.h>

namespace MultiplayerSample
{
    void ScriptableDecalComponent::Reflect(AZ::ReflectContext* context)
    {
        SpawnDecalConfig::Reflect(context);

        if (AZ::SerializeContext* serialize = azrtti_cast<AZ::SerializeContext*>(context))
        {
            serialize->Class<MultiplayerSample::ScriptableDecalComponent, AZ::Component>()
                ->Version(0)
                ;

            AZ::EditContext* editContext = serialize->GetEditContext();
            if (editContext)
            {
                editContext->Class<MultiplayerSample::ScriptableDecalComponent>(
                    "Scriptable Decals", "Allows spawning decals directly from script without prefabs.")
                    ->ClassElement(AZ::Edit::ClassElements::EditorData, "")
                    ->Attribute(AZ::Edit::Attributes::Category, "Graphics")
                    ->Attribute(AZ::Edit::Attributes::AppearsInAddComponentMenu, AZStd::vector<AZ::Crc32>({ AZ_CRC_CE("Level") }))
                    ;
            }
        }

        AZ::BehaviorContext* behaviorContext = azrtti_cast<AZ::BehaviorContext*>(context);
        if (behaviorContext)
        {
            behaviorContext->EBus<DecalRequestBus>("RequestBus")
                ->Attribute(AZ::Script::Attributes::Scope, AZ::Script::Attributes::ScopeFlags::Common)
                ->Attribute(AZ::Script::Attributes::Category, "Rendering")
                ->Attribute(AZ::Script::Attributes::Module, "rendering")
                ->Attribute(AZ::Script::Attributes::Scope, AZ::Script::Attributes::ScopeFlags::Common)
                ->Event(
                    "SpawnDecal",
                    &DecalRequestBus::Events::SpawnDecal)
                ;
        }
    }

    void ScriptableDecalComponent::GetProvidedServices(AZ::ComponentDescriptor::DependencyArrayType& services)
    {
        services.push_back(AZ_CRC_CE("ScriptableDecalService"));
    }

    void ScriptableDecalComponent::GetIncompatibleServices(AZ::ComponentDescriptor::DependencyArrayType& services)
    {
        services.push_back(AZ_CRC_CE("ScriptableDecalService"));
    }

    void ScriptableDecalComponent::Activate()
    {
        m_decalFeatureProcessor = AZ::RPI::Scene::GetFeatureProcessorForEntity<AZ::Render::DecalFeatureProcessorInterface>(GetEntityId());
        if (m_decalFeatureProcessor)
        {
            AZ::RPI::Scene* scene = m_decalFeatureProcessor->GetParentScene();
            DecalRequestBus::Handler::BusConnect(scene->GetId());
            AZ::TickBus::Handler::BusConnect();
        }
    }

    void ScriptableDecalComponent::Deactivate()
    {
        AZ::TickBus::Handler::BusDisconnect();
        DecalRequestBus::Handler::BusDisconnect();

        auto removeDecalsFromList = [&](AZStd::vector<DecalInstance>& container)
        {
            for (const DecalInstance& instance : container)
            {
                m_decalFeatureProcessor->ReleaseDecal(instance.m_handle);
            }
            container.clear();
        };

        removeDecalsFromList(m_fadingInDecals);
        removeDecalsFromList(m_fadingOutDecals);
        removeDecalsFromList(m_decalHeap);

        m_decalFeatureProcessor = nullptr;
    }

    void ScriptableDecalComponent::SpawnDecal(const AZ::Transform& worldTm, const SpawnDecalConfig& config)
    {
        DecalHandle handle = m_decalFeatureProcessor->AcquireDecal();

        AZ::Vector3 scale = AZ::Vector3(config.m_scale, config.m_scale, config.m_scale * config.m_thickness);

        // Check for bad state.
        if (config.m_scale <= 0.0f || !config.m_materialAssetId.IsValid() || config.m_opacity <= 0.0f ||
            (config.m_fadeInTimeSec + config.m_lifeTimeSec + config.m_fadeOutTimeSec <= 0.0f))
        {
            return;
        }

        m_decalFeatureProcessor->SetDecalTransform(handle, worldTm, scale);
        m_decalFeatureProcessor->SetDecalMaterial(handle, config.m_materialAssetId);
        m_decalFeatureProcessor->SetDecalOpacity(handle, config.m_opacity);
        m_decalFeatureProcessor->SetDecalAttenuationAngle(handle, config.m_attenuationAngle);
        m_decalFeatureProcessor->SetDecalSortKey(handle, config.m_sortKey);

        uint32_t currentTimeMs = static_cast<uint32_t>(AZ::Interface<AZ::ITime>::Get()->GetElapsedTimeMs());

        if (config.m_fadeInTimeSec > 0.0f)
        {
            m_fadingInDecals.push_back({ config, handle, currentTimeMs });
        }
        else if (config.m_lifeTimeSec > 0.0f)
        {
            uint32_t lifetimeMs = static_cast<uint32_t>(config.m_lifeTimeSec * 1000.0f);
            uint32_t despawnTimeMs = currentTimeMs + lifetimeMs;

            // Store decals in a min heap sorted by when they need to start animating the fade out.
            // This makes it very cheap to check each frame if any decals need to change to the fade-out state.
            m_decalHeap.push_back({ config, handle, despawnTimeMs });
            AZStd::push_heap(m_decalHeap.begin(), m_decalHeap.end(), HeapCompare);
        }
        else
        {
            m_fadingOutDecals.push_back({ config, handle, currentTimeMs });
        }
    }

    void ScriptableDecalComponent::OnTick([[maybe_unused]] float deltaTime, [[maybe_unused]] AZ::ScriptTimePoint time)
    {
        uint32_t currentTimeMs = static_cast<uint32_t>(AZ::Interface<AZ::ITime>::Get()->GetElapsedTimeMs());

        for (size_t i = 0; i < m_fadingInDecals.size();)
        {
            DecalInstance& decalInstance = m_fadingInDecals.at(i);
            uint32_t currentFadeTimeMs = currentTimeMs - decalInstance.m_animationStartTimeMs;
            float fadeInTimeMsFloat = decalInstance.m_config.m_fadeInTimeSec * 1000.0f;

            float opacity = AZStd::GetMin(1.0f, currentFadeTimeMs / fadeInTimeMsFloat);
            opacity *= decalInstance.m_config.m_opacity;
            m_decalFeatureProcessor->SetDecalOpacity(decalInstance.m_handle, opacity);

            uint32_t fadeInTimeMs = static_cast<uint32_t>(fadeInTimeMsFloat);
            if (currentFadeTimeMs > fadeInTimeMs)
            {
                uint32_t lifetimeMs = static_cast<uint32_t>(decalInstance.m_config.m_lifeTimeSec * 1000.0f);
                // Fade out animation starts after the fade in time and life time have passed.
                uint32_t despawnTimeMs = fadeInTimeMs + lifetimeMs; 
                decalInstance.m_animationStartTimeMs += despawnTimeMs;

                m_decalHeap.push_back(decalInstance);
                AZStd::push_heap(m_decalHeap.begin(), m_decalHeap.end(), HeapCompare);

                // Replace this instance with the one on the back
                decalInstance = m_fadingInDecals.back();
                m_fadingInDecals.pop_back();

                // Don't increment, next iteration needs to process the item just moved to this spot.
            }
            else
            {
                ++i;
            }
        }

        // Check to see if any decals need to despawn
        while (!m_decalHeap.empty() && m_decalHeap.front().m_animationStartTimeMs < currentTimeMs)
        {
            AZStd::pop_heap(m_decalHeap.begin(), m_decalHeap.end(), HeapCompare);
            m_fadingOutDecals.push_back(m_decalHeap.back());
            m_decalHeap.pop_back();
        }

        // Animate despawning decals, remove those that are expired.
        for (size_t i = 0; i < m_fadingOutDecals.size();)
        {
            DecalInstance& decalInstance = m_fadingOutDecals.at(i);

            // Clamp our minimum total fade time to 1 millisecond to avoid any potential divide-by-zero
            float totalFadeTimeMs = AZStd::max(decalInstance.m_config.m_fadeOutTimeSec * 1000.0f, 1.0f);
            float currentFadeTimeMs = static_cast<float>(currentTimeMs - decalInstance.m_animationStartTimeMs);
            if (currentFadeTimeMs > totalFadeTimeMs)
            {
                // Despawn the decal, it's done animating;
                m_decalFeatureProcessor->ReleaseDecal(decalInstance.m_handle);

                // Replace this instance with the one on the back
                decalInstance = m_fadingOutDecals.back();
                m_fadingOutDecals.pop_back();

                // Don't increment, next iteration needs to process the item just moved to this spot.
            }
            else
            {
                float opacity = 1.0f - (currentFadeTimeMs / totalFadeTimeMs);
                opacity *= decalInstance.m_config.m_opacity;
                m_decalFeatureProcessor->SetDecalOpacity(decalInstance.m_handle, opacity);
                ++i;
            }
        }
    }

    bool ScriptableDecalComponent::HeapCompare(const DecalInstance& value1, const DecalInstance& value2)
    {
        return value1.m_animationStartTimeMs > value2.m_animationStartTimeMs;
    }
}