From cfd08bbf28ad50ba609694bf33bb953addd4c7f1 Mon Sep 17 00:00:00 2001
From: elexis <elexis@wildfiregames.com>
Date: Sat, 17 Jun 2017 14:17:30 +0000
Subject: [PATCH] Cinema Path GUI hiding and silhouettes fixes.

Let the JS GUI take care of hiding the GUI and silhouettes and remove
the according hardcoding in the engine following 89aef0b6eb.
Thereby fix some bugs (like not having hid the GUI if there was a
message box or different page shown while playing a path) and
fix these two hotkeys broken by 5d49e6c456.

Differential Revision: https://code.wildfiregames.com/D631
Fixes #4633
Reviewed By: Vladislav
This was SVN commit r19797.
---
 .../mods/public/gui/session/hotkeys/misc.xml  |  9 +++---
 .../data/mods/public/gui/session/session.js   | 32 ++++++++++++++++---
 .../data/mods/public/gui/session/session.xml  |  2 +-
 .../simulation/components/GuiInterface.js     |  5 +++
 source/graphics/CinemaManager.cpp             | 30 -----------------
 source/graphics/CinemaManager.h               |  3 --
 .../components/ICmpCinemaManager.cpp          |  1 +
 7 files changed, 40 insertions(+), 42 deletions(-)

diff --git a/binaries/data/mods/public/gui/session/hotkeys/misc.xml b/binaries/data/mods/public/gui/session/hotkeys/misc.xml
index 7f1510f232..46d84dbfbb 100644
--- a/binaries/data/mods/public/gui/session/hotkeys/misc.xml
+++ b/binaries/data/mods/public/gui/session/hotkeys/misc.xml
@@ -16,6 +16,10 @@
 		<action on="Press">openChat(g_LastChatAddressee);</action>
 	</object>
 
+	<object hotkey="session.gui.toggle">
+		<action on="Press">g_ShowGUI = !g_ShowGUI;</action>
+	</object>
+
 	<object hotkey="session.gui.menu.toggle">
 		<action on="Press">toggleMenu();</action>
 	</object>
@@ -25,10 +29,7 @@
 	</object>
 
 	<object hotkey="silhouettes">
-		<action on="Press">
-			var newSetting = !Engine.Renderer_GetSilhouettesEnabled();
-			Engine.Renderer_SetSilhouettesEnabled(newSetting);
-		</action>
+		<action on="Press">toggleConfigBool("silhouettes");</action>
 	</object>
 
 	<object hotkey="showsky">
diff --git a/binaries/data/mods/public/gui/session/session.js b/binaries/data/mods/public/gui/session/session.js
index 2e1e1d7af3..dc9f762b8c 100644
--- a/binaries/data/mods/public/gui/session/session.js
+++ b/binaries/data/mods/public/gui/session/session.js
@@ -128,6 +128,12 @@ var g_DevSettings = {
 	"controlAll": false
 };
 
+/**
+ * Whether the entire UI should be hidden (useful for promotional screenshots).
+ * Can be toggled with a hotkey.
+ */
+var g_ShowGUI = true;
+
 /**
  * Whether status bars should be shown for all of the player's units.
  */
@@ -801,6 +807,7 @@ function onSimulationUpdate()
 	if (!g_SimState)
 		return;
 
+	updateCinemaPath();
 	handleNotifications();
 	updateGUIObjects();
 
@@ -848,6 +855,14 @@ function confirmExit()
 	g_ConfirmExit = false;
 }
 
+function updateCinemaPath()
+{
+	let isPlayingCinemaPath = GetSimState().cinemaPlaying;
+
+	Engine.GetGUIObjectByName("sn").hidden = !g_ShowGUI || isPlayingCinemaPath;
+	Engine.Renderer_SetSilhouettesEnabled(!isPlayingCinemaPath && Engine.ConfigDB_GetValue("user", "silhouettes") == "true");
+}
+
 function updateGUIObjects()
 {
 	g_Selection.update();
@@ -1268,16 +1283,25 @@ function recalculateStatusBarDisplay(remove = false)
 	});
 }
 
+/**
+ * Inverts the given configuration boolean and returns the current state.
+ * For example "silhouettes".
+ */
+function toggleConfigBool(configName)
+{
+	let enabled = Engine.ConfigDB_GetValue("user", configName) != "true";
+	Engine.ConfigDB_CreateValue("user", configName, String(enabled));
+	Engine.ConfigDB_WriteValueToFile("user", configName, String(enabled), "config/user.cfg");
+	return enabled;
+}
+
 /**
  * Toggles the display of range overlays of selected entities for the given range type.
  * @param {string} type - for example "Aura"
  */
 function toggleRangeOverlay(type)
 {
-	let configString = "gui.session." + type.toLowerCase() + "range";
-	let enabled = Engine.ConfigDB_GetValue("user", configString) != "true";
-	Engine.ConfigDB_CreateValue("user", configString, String(enabled));
-	Engine.ConfigDB_WriteValueToFile("user", configString, String(enabled), "config/user.cfg");
+	let enabled = toggleConfigBool("gui.session." + type.toLowerCase() + "range");
 
 	Engine.GuiInterfaceCall("EnableVisualRangeOverlayType", {
 		"type": type,
diff --git a/binaries/data/mods/public/gui/session/session.xml b/binaries/data/mods/public/gui/session/session.xml
index eafd6f0665..b4d2e31c49 100644
--- a/binaries/data/mods/public/gui/session/session.xml
+++ b/binaries/data/mods/public/gui/session/session.xml
@@ -16,7 +16,7 @@
 
 <script directory="gui/session/"/>
 
-<object name="sn" hotkey="session.gui.toggle">
+<object name="sn">
 	<action on="Tick">
 		onTick();
 	</action>
diff --git a/binaries/data/mods/public/simulation/components/GuiInterface.js b/binaries/data/mods/public/simulation/components/GuiInterface.js
index b2be0e6052..295033405f 100644
--- a/binaries/data/mods/public/simulation/components/GuiInterface.js
+++ b/binaries/data/mods/public/simulation/components/GuiInterface.js
@@ -149,6 +149,11 @@ GuiInterface.prototype.GetSimulationState = function()
 		ret.ceasefireTimeRemaining = ret.ceasefireActive ? cmpCeasefireManager.GetCeasefireStartedTime() + cmpCeasefireManager.GetCeasefireTime() - ret.timeElapsed : 0;
 	}
 
+	// Add cinema path info
+	let cmpCinemaManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_CinemaManager);
+	if (cmpCinemaManager)
+		ret.cinemaPlaying = cmpCinemaManager.IsPlaying();
+
 	// Add the game type and allied victory
 	let cmpEndGameManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_EndGameManager);
 	ret.gameType = cmpEndGameManager.GetGameType();
diff --git a/source/graphics/CinemaManager.cpp b/source/graphics/CinemaManager.cpp
index 87caacbdf4..33500850cd 100644
--- a/source/graphics/CinemaManager.cpp
+++ b/source/graphics/CinemaManager.cpp
@@ -62,9 +62,6 @@ void CCinemaManager::Update(const float deltaRealTime) const
 	if (!cmpCinemaManager)
 		return;
 
-	UpdateSessionVisibility();
-	UpdateSilhouettesVisibility();
-
 	if (IsPlaying())
 		cmpCinemaManager->PlayQueue(deltaRealTime, g_Game->GetView()->GetCamera());
 }
@@ -77,33 +74,6 @@ void CCinemaManager::Render() const
 		DrawPaths();
 }
 
-void CCinemaManager::UpdateSessionVisibility() const
-{
-	// TODO: Enabling/Disabling does not work if the session GUI page is not the top page.
-	// This can happen in various situations, for example when the player wins/loses the game
-	// while the cinematic is running (a message box is the top page in this case).
-
-	IGUIObject *sn = g_GUI->FindObjectByName("sn");
-	if (!sn)
-		return;
-
-	bool hidden = false;
-	GUI<bool>::GetSetting(sn, "hidden", hidden);
-
-	if (hidden != IsPlaying())
-		sn->SetSetting("hidden", IsPlaying() ? L"true" : L"false");
-}
-
-void CCinemaManager::UpdateSilhouettesVisibility() const
-{
-	if (!CRenderer::IsInitialised())
-		return;
-
-	bool silhouettes = false;
-	CFG_GET_VAL("silhouettes", silhouettes);
-	g_Renderer.SetOptionBool(CRenderer::Option::OPT_SILHOUETTES, !IsEnabled() && silhouettes);
-}
-
 void CCinemaManager::DrawPaths() const
 {
 	CmpPtr<ICmpCinemaManager> cmpCinemaManager(g_Game->GetSimulation2()->GetSimContext().GetSystemEntity());
diff --git a/source/graphics/CinemaManager.h b/source/graphics/CinemaManager.h
index b634911947..389b112374 100644
--- a/source/graphics/CinemaManager.h
+++ b/source/graphics/CinemaManager.h
@@ -42,9 +42,6 @@ public:
 	void DrawSpline(const RNSpline& spline, const CColor& splineColor, int smoothness, bool lines) const;
 	void DrawNodes(const RNSpline& spline, const CColor& nodesColor) const;
 
-	void UpdateSessionVisibility() const;
-	void UpdateSilhouettesVisibility() const;
-
 	bool IsPlaying() const;
 	bool IsEnabled() const;
 
diff --git a/source/simulation2/components/ICmpCinemaManager.cpp b/source/simulation2/components/ICmpCinemaManager.cpp
index 08167f138c..95c117a93e 100644
--- a/source/simulation2/components/ICmpCinemaManager.cpp
+++ b/source/simulation2/components/ICmpCinemaManager.cpp
@@ -25,6 +25,7 @@ BEGIN_INTERFACE_WRAPPER(CinemaManager)
 DEFINE_INTERFACE_METHOD_1("AddPath", void, ICmpCinemaManager, AddPath, CCinemaPath)
 DEFINE_INTERFACE_METHOD_1("AddCinemaPathToQueue", void, ICmpCinemaManager, AddCinemaPathToQueue, CStrW)
 DEFINE_INTERFACE_METHOD_1("DeletePath", void, ICmpCinemaManager, DeletePath, CStrW)
+DEFINE_INTERFACE_METHOD_CONST_0("IsPlaying", bool, ICmpCinemaManager, IsEnabled)
 DEFINE_INTERFACE_METHOD_0("Play", void, ICmpCinemaManager, Play)
 DEFINE_INTERFACE_METHOD_0("Stop", void, ICmpCinemaManager, Stop)
 END_INTERFACE_WRAPPER(CinemaManager)