UPBGE: Refactor scene suspended time managment.

Previously when a scene was suspended, the function UpdateSuspendedScenes
was checking that the suspended scene has a valid suspended time, this
value is the clock time when the scene was suspended. If this value was
to zero it was set.
After, when the scene was resumed, the same function checked if the
suspended time was not zero, in this case the scene was just resumed, the
delta suspended time (the time passed during the scene suspend) wad set
and the suspended time was set to zero.

This mechanism is to complicated for the informations we need, indeed
only the suspended delta time is used for animations. This delta time
could be incremented each frame by the frame step.

So the suspended time of a scene is removed and UpdateSuspendedScenes get
as argument the frame step which is incremented to the scene suspended
delta time.

Tested with #D1569.

Author: panzergame

source/gameengine/Ketsji/BL_Action.cpp

@@ -246,7 +246,7 @@ bool BL_Action::Play(const std::string& name,
 	}
 
 	// Now that we have an action, we have something we can play
-	m_starttime = KX_GetActiveEngine()->GetFrameTime() - kxscene->getSuspendedDelta();
+	m_starttime = KX_GetActiveEngine()->GetFrameTime() - kxscene->GetSuspendedDelta();
 	m_startframe = m_localframe = start;
 	m_endframe = end;
 	m_blendin = blendin;
@@ -379,7 +379,8 @@ void BL_Action::Update(float curtime, bool applyToObject)
 	}
 	m_prevUpdate = curtime;
 
-	curtime -= (float)KX_KetsjiEngine::GetSuspendedDelta();
+	KX_Scene *scene = m_obj->GetScene();
+	curtime -= (float)scene->GetSuspendedDelta();
 
 	if (m_calc_localtime)
 		SetLocalTime(curtime);

source/gameengine/Ketsji/KX_KetsjiEngine.cpp

@@ -102,8 +102,6 @@ double KX_KetsjiEngine::m_ticrate = DEFAULT_LOGIC_TIC_RATE;
 int KX_KetsjiEngine::m_maxLogicFrame = 5;
 int KX_KetsjiEngine::m_maxPhysicsFrame = 5;
 double KX_KetsjiEngine::m_anim_framerate = 25.0;
-double KX_KetsjiEngine::m_suspendedtime = 0.0;
-double KX_KetsjiEngine::m_suspendeddelta = 0.0;
 double KX_KetsjiEngine::m_average_framerate = 0.0;
 bool KX_KetsjiEngine::m_restrict_anim_fps = false;
 short KX_KetsjiEngine::m_exitkey = 130; // ESC Key
@@ -480,7 +478,7 @@ bool KX_KetsjiEngine::NextFrame()
 			m_inputDevice->ClearInputs();
 		}
 
-		UpdateSuspendedScenes();
+		UpdateSuspendedScenes(framestep);
 		// scene management
 		ProcessScheduledScenes();
 
@@ -493,21 +491,12 @@ bool KX_KetsjiEngine::NextFrame()
 	return doRender && m_doRender;
 }
 
-void KX_KetsjiEngine::UpdateSuspendedScenes()
+void KX_KetsjiEngine::UpdateSuspendedScenes(double framestep)
 {
 	for (CListValue::iterator<KX_Scene> sceneit = m_scenes->GetBegin(), sceneend = m_scenes->GetEnd(); sceneit != sceneend; ++sceneit) {
 		KX_Scene *scene = *sceneit;
 		if (scene->IsSuspended()) {
-			if (scene->getSuspendedTime() == 0.0f) {
-				scene->setSuspendedTime(m_clockTime);
-			}
-		}
-		else {
-			// if the scene was suspended recalcutlate the delta to "curtime"
-			if (scene->getSuspendedTime() != 0.0f) {
-				scene->setSuspendedDelta(scene->getSuspendedDelta() + m_clockTime - scene->getSuspendedTime());
-			}
-			scene->setSuspendedTime(0.0f);
+			scene->SetSuspendedDelta(scene->GetSuspendedDelta() + framestep);
 		}
 	}
 }
@@ -800,8 +789,6 @@ void KX_KetsjiEngine::UpdateAnimations(KX_Scene *scene)
 		return;
 	}
 
-	// Set scene total pause duration, used for animations played on scene which was suspended.
-	m_suspendeddelta = scene->getSuspendedDelta();
 	// Handle the animations independently of the logic time step
 	if (GetRestrictAnimationFPS()) {
 		double anim_timestep = 1.0 / scene->GetAnimationFPS();
@@ -1489,11 +1476,6 @@ bool KX_KetsjiEngine::GetUseExternalClock(void) const
 	return m_useExternalClock;
 }
 
-double KX_KetsjiEngine::GetSuspendedDelta()
-{
-	return m_suspendeddelta;
-}
-
 double KX_KetsjiEngine::GetTicRate()
 {
 	return m_ticrate;

source/gameengine/Ketsji/KX_KetsjiEngine.h

@@ -139,9 +139,6 @@ class KX_KetsjiEngine
 
 	static bool m_restrict_anim_fps;
 
-	static double m_suspendedtime;
-	static double m_suspendeddelta;
-
 	static bool				m_doRender;  /* whether or not the scene should be rendered after the logic frame */
 
 	/// Key used to exit the BGE
@@ -221,9 +218,9 @@ class KX_KetsjiEngine
 	 * The render functions, called after and which update animations,
 	 * will see the first scene as active and will proceed to it,
 	 * but it will cause some negative current frame on actions because of the
-	 * total pause duration not setted.
+	 * total pause duration not set.
 	 */
-	void UpdateSuspendedScenes();
+	void UpdateSuspendedScenes(double framestep);
 
 	/// Update and return the projection matrix of a camera depending on the viewport.
 	const MT_Matrix4x4& GetCameraProjectionMatrix(KX_Scene *scene, KX_Camera *cam, const RAS_Rect& viewport, const RAS_Rect& area);
@@ -361,12 +358,6 @@ class KX_KetsjiEngine
 	 */
 	double GetRealTime(void) const;
 
-	/**
-	 * Returns the difference between the local time of the scene (when it
-	 * was running and not suspended) and the "curtime"
-	 */
-	static double GetSuspendedDelta();
-
 	/**
 	 * Gets the number of logic updates per second.
 	 */

source/gameengine/Ketsji/KX_Scene.cpp

@@ -151,12 +151,11 @@ KX_Scene::KX_Scene(SCA_IInputDevice *inputDevice,
 	m_sceneName(sceneName),
 	m_active_camera(nullptr),
 	m_ueberExecutionPriority(0),
+	m_suspendeddelta(0.0),
 	m_blenderScene(scene),
 	m_isActivedHysteresis(false),
 	m_lodHysteresisValue(0)
 {
-	m_suspendedtime = 0.0;
-	m_suspendeddelta = 0.0;
 
 	m_dbvt_culling = false;
 	m_dbvt_occlusion_res = 0;
@@ -1817,19 +1816,11 @@ void KX_Scene::SetPhysicsEnvironment(class PHY_IPhysicsEnvironment* physEnv)
 	}
 }
 
-void KX_Scene::setSuspendedTime(double suspendedtime)
-{
-	m_suspendedtime = suspendedtime;
-}
-double KX_Scene::getSuspendedTime()
-{
-	return m_suspendedtime;
-}
-void KX_Scene::setSuspendedDelta(double suspendeddelta)
+void KX_Scene::SetSuspendedDelta(double suspendeddelta)
 {
 	m_suspendeddelta = suspendeddelta;
 }
-double KX_Scene::getSuspendedDelta()
+double KX_Scene::GetSuspendedDelta() const
 {
 	return m_suspendeddelta;
 }

source/gameengine/Ketsji/KX_Scene.h

@@ -248,6 +248,7 @@ class KX_Scene : public CValue, public SCA_IScene
 	 * Suspend (freeze) the entire scene.
 	 */
 	bool m_suspend;
+	double m_suspendeddelta;
 
 	/**
 	 * Radius in Manhattan distance of the box for activity culling.
@@ -287,9 +288,6 @@ class KX_Scene : public CValue, public SCA_IScene
 	void MarkVisible(RAS_IRasterizer* rasty, KX_GameObject* gameobj, KX_Camera*cam, int layer=0);
 	static void PhysicsCullingCallback(KX_ClientObjectInfo* objectInfo, void* cullingInfo);
 
-	double				m_suspendedtime;
-	double				m_suspendeddelta;
-
 	struct Scene* m_blenderScene;
 
 	KX_2DFilterManager *m_filterManager;
@@ -596,24 +594,16 @@ class KX_Scene : public CValue, public SCA_IScene
 	void RunDrawingCallbacks(DrawingCallbackType callbackType, KX_Camera *camera);
 #endif
 
-	/**
-	 * Sets the time the scene was suspended
-	 */ 
-	void setSuspendedTime(double suspendedtime);
-	/**
-	 * Returns the "curtime" the scene was suspended
-	 */ 
-	double getSuspendedTime();
 	/**
 	 * Sets the difference between the local time of the scene (when it
 	 * was running and not suspended) and the "curtime"
 	 */ 
-	void setSuspendedDelta(double suspendeddelta);
+	void SetSuspendedDelta(double suspendeddelta);
 	/**
 	 * Returns the difference between the local time of the scene (when it
 	 * was running and not suspended) and the "curtime"
 	 */
-	double getSuspendedDelta();
+	double GetSuspendedDelta() const;
 	/**
 	 * Returns the Blender scene this was made from
 	 */