o3de/Gems/AtomLyIntegration/CommonFeatures/Code/Source/SkinnedMesh/SkinnedMeshDebugDisplay.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 <Atom/RPI.Public/Base.h>
#include <AzFramework/Entity/EntityDebugDisplayBus.h>
#include <CrySystemBus.h>
#include <Atom/Bootstrap/BootstrapNotificationBus.h>


namespace AZ
{
    namespace Render
    {
        //! This class is responsible for displaying stats about Atom's SkinnedMesh feature
        class SkinnedMeshDebugDisplay
            : private AzFramework::ViewportDebugDisplayEventBus::Handler
            , private CrySystemEventBus::Handler
            , private AZ::Render::Bootstrap::NotificationBus::Handler
        {
        public:
            SkinnedMeshDebugDisplay();
            ~SkinnedMeshDebugDisplay();

        private:

            // CrySystemEventBus::Handler overrides
            // Register the r_skinnedMeshDisplaySceneStats cvar
            void OnCrySystemInitialized(ISystem&, const SSystemInitParams&) override;
            void OnCrySystemShutdown(ISystem&) override;
            void OnCryEditorInitialized() override;

            // AzFramework::ViewportDebugDisplayEventBus overrides
            // Display the debug text if r_skinnedMeshDisplaySceneStats = 1
            void DisplayViewport2d(const AzFramework::ViewportInfo& viewportInfo, AzFramework::DebugDisplayRequests& debugDisplay) override;

            // Get the RPI::SceneId, which can be used to query scene stats
            void OnBootstrapSceneReady(AZ::RPI::Scene* bootstrapScene) override;

            void GetSceneId();

            // CVar for toggling the display of the scene stats
            int r_skinnedMeshDisplaySceneStats = 0;
            // SceneId to query for the stats
            RPI::SceneId m_sceneId;
        };
    }// namespace Render
}// namespace AZ