o3de/Gems/Profiler/Code/Source/ProfilerImGuiSystemComponent.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 <ProfilerImGuiSystemComponent.h>

#include "ImGuiTreemapImpl.h"

#include <AzCore/Debug/ProfilerBus.h>
#include <AzCore/Serialization/SerializeContext.h>
#include <AzCore/Serialization/EditContext.h>
#include <AzCore/Serialization/EditContextConstants.inl>

#include <AzFramework/Components/ConsoleBus.h>

namespace Profiler
{
    static constexpr AZ::Crc32 profilerImGuiServiceCrc = AZ_CRC_CE("ProfilerImGuiService");

    void ProfilerImGuiSystemComponent::Reflect(AZ::ReflectContext* context)
    {
        if (AZ::SerializeContext* serialize = azrtti_cast<AZ::SerializeContext*>(context))
        {
            serialize->Class<ProfilerImGuiSystemComponent, AZ::Component>()
                ->Version(0);

            if (AZ::EditContext* ec = serialize->GetEditContext())
            {
                ec->Class<ProfilerImGuiSystemComponent>("ProfilerImGui", "Provides in-game visualization of the performance data gathered by the ProfilerSystemComponent")
                    ->ClassElement(AZ::Edit::ClassElements::EditorData, "")
                        ->Attribute(AZ::Edit::Attributes::AutoExpand, true);
            }
        }
    }

    void ProfilerImGuiSystemComponent::GetProvidedServices(AZ::ComponentDescriptor::DependencyArrayType& provided)
    {
        provided.push_back(profilerImGuiServiceCrc);
    }

    void ProfilerImGuiSystemComponent::GetIncompatibleServices(AZ::ComponentDescriptor::DependencyArrayType& incompatible)
    {
        incompatible.push_back(profilerImGuiServiceCrc);
    }

    void ProfilerImGuiSystemComponent::GetRequiredServices([[maybe_unused]] AZ::ComponentDescriptor::DependencyArrayType& required)
    {
    }

    void ProfilerImGuiSystemComponent::GetDependentServices([[maybe_unused]] AZ::ComponentDescriptor::DependencyArrayType& dependent)
    {
    }

    ProfilerImGuiSystemComponent::ProfilerImGuiSystemComponent()
    {
#if defined(IMGUI_ENABLED)
        if (ProfilerImGuiInterface::Get() == nullptr)
        {
            ProfilerImGuiInterface::Register(this);
        }

        if (!ImGuiTreemapFactory::Interface::Get())
        {
            ImGuiTreemapFactory::Interface::Register(&m_imguiTreemapFactory);
        }
#endif // defined(IMGUI_ENABLED)
    }

    ProfilerImGuiSystemComponent::~ProfilerImGuiSystemComponent()
    {
#if defined(IMGUI_ENABLED)
        if (ImGuiTreemapFactory::Interface::Get() == &m_imguiTreemapFactory)
        {
            ImGuiTreemapFactory::Interface::Unregister(&m_imguiTreemapFactory);
        }

        if (ProfilerImGuiInterface::Get() == this)
        {
            ProfilerImGuiInterface::Unregister(this);
        }
#endif // defined(IMGUI_ENABLED)
    }

    void ProfilerImGuiSystemComponent::Activate()
    {
#if defined(IMGUI_ENABLED)
        ImGui::ImGuiUpdateListenerBus::Handler::BusConnect();
#endif // defined(IMGUI_ENABLED)
    }

    void ProfilerImGuiSystemComponent::Deactivate()
    {
#if defined(IMGUI_ENABLED)
        ImGui::ImGuiUpdateListenerBus::Handler::BusDisconnect();
#endif // defined(IMGUI_ENABLED)
    }

#if defined(IMGUI_ENABLED)
    void ProfilerImGuiSystemComponent::ShowCpuProfilerWindow(bool& keepDrawing)
    {
        m_imguiCpuProfiler.Draw(keepDrawing);
    }

    void ProfilerImGuiSystemComponent::OnImGuiUpdate()
    {
        if (m_showCpuProfiler)
        {
            ShowCpuProfilerWindow(m_showCpuProfiler);
        }
    }

    void ProfilerImGuiSystemComponent::OnImGuiMainMenuUpdate()
    {
        if (ImGui::BeginMenu("Profiler"))
        {
            if (ImGui::MenuItem("CPU", "", &m_showCpuProfiler))
            {
                AZ::Debug::ProfilerSystemInterface::Get()->SetActive(m_showCpuProfiler);
            }
            ImGui::EndMenu();
        }
    }
#endif // defined(IMGUI_ENABLED)
} // namespace Profiler