Merge pull request #853 from sweiland-openrails/OutOfFocus

Notify out of focus

Author: cjakeman

Source/RunActivity/Viewer3D/Popups/OutOfFocusWindow.cs

@@ -0,0 +1,78 @@
+// COPYRIGHT 2023 by the Open Rails project.
+//
+// This file is part of Open Rails.
+//
+// Open Rails is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Open Rails is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Open Rails.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+/*
+ * This out of focus window is a somewhat strange Window
+ * When the main window is out of focus (so not receving any keystrokes)
+ *     it is surrounded by a red square to notify the user
+ * The red square is the only functionality, so no save, no move, no resize etc.
+ */
+
+using Microsoft.Xna.Framework;
+using Microsoft.Xna.Framework.Graphics;
+
+namespace Orts.Viewer3D.Popups
+{
+    public class OutOfFocusWindow : Window
+    {
+        private readonly Texture2D Line;
+        private readonly int Thickness = 3;
+        private readonly Color Color = Color.Red;
+
+        public OutOfFocusWindow(WindowManager owner) : base(owner)
+        {
+            Line = new Texture2D(Owner.Viewer.GraphicsDevice, 1, 1, false, SurfaceFormat.Color);
+            Line.SetData(new[] { Color });
+        }
+
+        public override void Draw(SpriteBatch spriteBatch)
+        {
+            int width = Owner.Viewer.GraphicsDevice.Viewport.Width;
+            int height = Owner.Viewer.GraphicsDevice.Viewport.Height;
+
+            // top
+            DrawLine(spriteBatch, 0, 0, width, Thickness, 0);
+
+            // bottom
+            DrawLine(spriteBatch, 0, height - Thickness, width, Thickness, 0);
+
+            // left
+            DrawLine(spriteBatch, Thickness, Thickness, height, Thickness, 90);
+
+            // right
+            DrawLine(spriteBatch, width, Thickness, height, Thickness, 90);
+        }
+
+        private void DrawLine(SpriteBatch spriteBatch, int X, int Y, int width, int height, int degrees)
+        {
+            spriteBatch.Draw(
+                Line,
+                new Rectangle(X, Y, width, height),
+                null,
+                Color,
+                ConvertToRadiansFromDegrees(degrees),
+                new Vector2(0, 0),
+                SpriteEffects.None, 0);
+        }
+
+        private float ConvertToRadiansFromDegrees(int angle)
+        {
+            return (float)((System.Math.PI / 180) * angle);
+        }
+    }
+}

Source/RunActivity/Viewer3D/Popups/Window.cs

@@ -45,6 +45,12 @@ public abstract class Window : RenderPrimitive
         VertexBuffer WindowVertexBuffer;
         IndexBuffer WindowIndexBuffer;
 
+        public bool DoNotDisplayWindow // true for a NotInFocus window
+        {
+            get;
+            private set;
+        }
+
         public Window(WindowManager owner, int width, int height, string caption)
         {
             Owner = owner;
@@ -63,6 +69,14 @@ public Window(WindowManager owner, int width, int height, string caption)
             }
 
             Caption = caption;
+            DoNotDisplayWindow = false;
+            Owner.Add(this);
+        }
+
+        protected Window(WindowManager owner)
+        {
+            Owner = owner;
+            DoNotDisplayWindow = true;
             Owner.Add(this);
         }
 
@@ -224,6 +238,11 @@ public virtual void PrepareFrame(RenderFrame frame, ElapsedTime elapsedTime, boo
 
         public override void Draw(GraphicsDevice graphicsDevice)
         {
+            if (DoNotDisplayWindow)
+            {
+                return;
+            }
+
             if (WindowVertexBuffer == null)
             {
                 // Edges/corners are 32px (1/4th image size).

Source/RunActivity/Viewer3D/Popups/WindowManager.cs

@@ -171,14 +171,24 @@ public void Initialize()
         public void Save(BinaryWriter outf)
         {
             foreach (var window in Windows)
-                window.Save(outf);
+                if (!window.DoNotDisplayWindow)
+                {
+                    // This if is added to not do the save in case of the out of focus window
+                    // See Source\RunActivity\Viewer3D\Popups\OutOfFocusWindow.cs
+                    window.Save(outf);
+                }
         }
 
         [CallOnThread("Render")]
         public void Restore(BinaryReader inf)
         {
             foreach (var window in Windows)
-                window.Restore(inf);
+                if (!window.DoNotDisplayWindow)
+                {
+                    // This if is added to not do the restore in case of the out of focus window
+                    // See Source\RunActivity\Viewer3D\Popups\OutOfFocusWindow.cs
+                    window.Restore(inf);
+                }
         }
 
 		[CallOnThread("Updater")]

Source/RunActivity/Viewer3D/Viewer.cs

@@ -103,6 +103,7 @@ public class Viewer
         public TrainListWindow TrainListWindow { get; private set; } // for switching driven train
         public TTDetachWindow TTDetachWindow { get; private set; } // for detaching player train in timetable mode
         public EOTListWindow EOTListWindow { get; private set; } // to select EOT
+        private OutOfFocusWindow OutOfFocusWindow; // to show colored rectangle around the main window when not in focus
 
         // Route Information
         public TileManager Tiles { get; private set; }
@@ -500,6 +501,10 @@ internal void Initialize()
             TrainListWindow = new TrainListWindow(WindowManager);
             TTDetachWindow = new TTDetachWindow(WindowManager);
             EOTListWindow = new EOTListWindow(WindowManager);
+            if (Settings.SuppressConfirmations < (int)ConfirmLevel.Error)
+                // confirm level Error might be set to suppressed when taking a movie
+                // do not show the out of focus red square in that case
+                OutOfFocusWindow = new OutOfFocusWindow(WindowManager);
             WindowManager.Initialize();
 
             InfoDisplay = new InfoDisplay(this);
@@ -853,6 +858,11 @@ public void Update(RenderFrame frame, float elapsedRealTime)
             // TODO: This is not correct. The ActivityWindow's PrepareFrame is already called by the WindowManager!
             if (Simulator.ActivityRun != null) ActivityWindow.PrepareFrame(elapsedTime, true);
 
+            if (Settings.SuppressConfirmations < (int)ConfirmLevel.Error)
+                // confirm level Error might be set to suppressed when taking a movie
+                // do not show the out of focus red square in that case 
+                OutOfFocusWindow.Visible = !this.Game.IsActive;
+
             WindowManager.PrepareFrame(frame, elapsedTime);
 
             SwitchPanelModule.SendSwitchPanelIfChanged();