Notify out of focus

Author: sweiland-openrails

Source/Documentation/Manual/images/options-system.png

@@ -408,7 +408,7 @@ The default setting is checked.
 
 
 At game start, Electric - power connected
------------------------------------
+-----------------------------------------
 
 When this option is checked, stationary electric locos start the simulation with power available.
 Uncheck this option for a more detailed behaviour in which the player has to switch on electrical equipment.
@@ -602,6 +602,15 @@ specific width and height to be used.
 
 The format is <width>x<height>, for example 1024x768.
 
+.. -options-out-of-focus:
+
+Notify out of focus
+-------------------
+
+When this option is checked, on the corners of the Open Rails main window a red rectangle is shown when the window is not in focus.
+Just a reminder that the main window currently does not react on keystrokes.
+
+The default setting is unchecked.
 
 .. _options-window-glass:
 

Source/Documentation/Manual/options.rst

@@ -303,6 +303,7 @@ orderby folder.Key
 
             checkWindowed.Checked = !Settings.FullScreen;
             comboWindowSize.Text = Settings.WindowSize;
+            checkOutOfFocus.Checked = Settings.OutOfFocus;
             checkWindowGlass.Checked = Settings.WindowGlass;
 
             // keep values in line with enum Orts.Simulation.ConfirmLevel
@@ -507,6 +508,7 @@ void buttonOK_Click(object sender, EventArgs e)
                     UpdateManager.SetChannel((string)control.Tag);
             Settings.FullScreen = !checkWindowed.Checked;
             Settings.WindowSize = GetValidWindowSize(comboWindowSize.Text);
+            Settings.OutOfFocus = checkOutOfFocus.Checked;
             Settings.WindowGlass = checkWindowGlass.Checked;
             Settings.SuppressConfirmations = comboControlConfirmations.SelectedIndex;
             Settings.WebServerPort = (int)numericWebServerPort.Value;
@@ -890,6 +892,7 @@ private void InitializeHelpIcons()
                 (pbLanguage, new Control[] { labelLanguage, comboLanguage }),
                 (pbUpdateMode, new Control[] { labelUpdateMode }),
                 (pbWindowed, new Control[] { checkWindowed, labelWindowSize, comboWindowSize }),
+                (pbOutOfFocus, new[] { checkOutOfFocus }),
                 (pbWindowGlass, new[] { checkWindowGlass }),
                 (pbControlConfirmations, new Control[] { labelControlConfirmations, comboControlConfirmations }),
                 (pbWebServerPort, new Control[] { labelWebServerPort }),
@@ -1036,6 +1039,10 @@ private void HelpIcon_Click(object sender, EventArgs _)
                     pbWindowed,
                     baseUrl + "/options.html#windowed"
                 },
+                {
+                    pbOutOfFocus,
+                    baseUrl + "/options.html#out-of-focus"
+                },
                 {
                     pbWindowGlass,
                     baseUrl + "/options.html#window-glass"

Source/Menu/Options.Designer.cs

@@ -278,6 +278,8 @@ public enum DirectXFeature
         [Default("1024x768")]
         public string WindowSize { get; set; }
         [Default(false)]
+        public bool OutOfFocus { get; set; }
+        [Default(false)]
         public bool WindowGlass { get; set; }
         [Default(0)]
         public int SuppressConfirmations { get; set; }

Source/Menu/Options.cs

@@ -0,0 +1,75 @@
+// 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/>.
+//
+
+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;
+
+        private readonly int Width;
+        private readonly int Height;
+
+        public OutOfFocusWindow(WindowManager owner) : base(owner)
+        {
+            Line = new Texture2D(owner.Viewer.GraphicsDevice, 1, 1, false, SurfaceFormat.Color);
+            Line.SetData(new[] { Color });
+
+            Width = owner.Viewer.GraphicsDevice.Viewport.Width;
+            Height = owner.Viewer.GraphicsDevice.Viewport.Height;
+        }
+
+        public override void Draw(SpriteBatch SpriteBatch)
+        {
+            // 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,
+                (float)ConvertToRadiansFromDegrees(degrees),
+                new Vector2(0, 0),
+                SpriteEffects.None, 0);
+         }
+
+        private float ConvertToRadiansFromDegrees(int angle)
+        {
+            return (float)((System.Math.PI / 180) * angle);
+        }
+
+    }
+}

Source/ORTS.Settings/UserSettings.cs

@@ -45,6 +45,8 @@ public abstract class Window : RenderPrimitive
         VertexBuffer WindowVertexBuffer;
         IndexBuffer WindowIndexBuffer;
 
+        readonly bool DoNotDisplayWindow = false;
+
         public Window(WindowManager owner, int width, int height, string caption)
         {
             Owner = owner;
@@ -66,6 +68,13 @@ public Window(WindowManager owner, int width, int height, string caption)
             Owner.Add(this);
         }
 
+        public Window(WindowManager owner)
+        {
+            Owner = owner;
+            DoNotDisplayWindow = true;
+            Owner.Add(this);
+        }
+
         protected internal virtual void Initialize()
         {
             VisibilityChanged();
@@ -224,6 +233,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).