From 0b4b0698c7be87763b6080979844b453ce46bbba Mon Sep 17 00:00:00 2001
From: amzn-sean <75276488+amzn-sean@users.noreply.github.com>
Date: Thu, 20 May 2021 15:39:39 +0100
Subject: [PATCH] disable physics tick time warning in debug builds and make it
 less spammy (#827)

---
 Gems/PhysX/Code/Source/System/PhysXSystem.cpp | 38 +++++++++++++++++--
 1 file changed, 35 insertions(+), 3 deletions(-)

diff --git a/Gems/PhysX/Code/Source/System/PhysXSystem.cpp b/Gems/PhysX/Code/Source/System/PhysXSystem.cpp
index 1622d04aae..8df9e9a86f 100644
--- a/Gems/PhysX/Code/Source/System/PhysXSystem.cpp
+++ b/Gems/PhysX/Code/Source/System/PhysXSystem.cpp
@@ -21,10 +21,25 @@
 
 #include <PxPhysicsAPI.h>
 
+// only enable physx timestep warning when not running debug or in Release
+#if !defined(DEBUG) && !defined(RELEASE)
+#define ENABLE_PHYSX_TIMESTEP_WARNING
+#endif
+
 namespace PhysX
 {
     AZ_CLASS_ALLOCATOR_IMPL(PhysXSystem, AZ::SystemAllocator, 0);
 
+#ifdef ENABLE_PHYSX_TIMESTEP_WARNING
+    namespace FrameTimeWarning
+    {
+        static constexpr int MaxSamples = 1000;
+        static int NumSamples = 0;
+        static int NumSamplesOverLimit = 0;
+        static float LostTime = 0.0f;
+    }
+#endif
+
     PhysXSystem::MaterialLibraryAssetHelper::MaterialLibraryAssetHelper(PhysXSystem* physXSystem)
         : m_physXSystem(physXSystem)
     {
@@ -140,9 +155,26 @@ namespace PhysX
             }
         };
 
-        AZ_Warning("PhysXSystem", deltaTime <= m_systemConfig.m_maxTimestep,
-            "Frame delta time of [%.6f seconds] exceeds Physics max frame timestep, physics timestep will be clamped to [%.6f seconds].",
-            deltaTime, m_systemConfig.m_maxTimestep);
+#ifdef ENABLE_PHYSX_TIMESTEP_WARNING
+        if (FrameTimeWarning::NumSamples < FrameTimeWarning::MaxSamples)
+        {
+            FrameTimeWarning::NumSamples++;
+            if (deltaTime > m_systemConfig.m_maxTimestep)
+            {
+                FrameTimeWarning::NumSamplesOverLimit++;
+                FrameTimeWarning::LostTime += deltaTime - m_systemConfig.m_maxTimestep;
+            }
+        }
+        else
+        {
+            AZ_Warning("PhysXSystem", FrameTimeWarning::NumSamplesOverLimit <= 0,
+                "[%d] of [%d] frames had a deltatime over the Max physics timestep[%.6f]. Physx timestep was clamped on those frames, losing [%.6f] seconds.",
+                FrameTimeWarning::NumSamplesOverLimit, FrameTimeWarning::NumSamples, m_systemConfig.m_maxTimestep, FrameTimeWarning::LostTime);
+            FrameTimeWarning::NumSamples = 0;
+            FrameTimeWarning::NumSamplesOverLimit = 0;
+            FrameTimeWarning::LostTime = 0.0f;
+        }
+#endif
         deltaTime = AZ::GetClamp(deltaTime, 0.0f, m_systemConfig.m_maxTimestep);
 
         AZ_Assert(m_systemConfig.m_fixedTimestep >= 0.0f, "PhysXSystem - fixed timestep is negitive.");