game pad support (#321)

Author: Mathew O'Dwyer

FinalEngine.Example.Desktop/Startup.cs

@@ -1,5 +1,5 @@
 // <copyright file="Startup.cs" company="Software Antics">
-// Copyright (c) Software Antics. All rights reserved.
+//     Copyright (c) Software Antics. All rights reserved.
 // </copyright>
 
 namespace FinalEngine.Example.Desktop;
@@ -14,5 +14,6 @@ public void ConfigureServices(IServiceCollection services)
     {
         ArgumentNullException.ThrowIfNull(services, nameof(services));
         services.AddRuntime<Game>();
+        services.AddSingleton<GameControllerInputEntitySystem>();
     }
 }

FinalEngine.Example/Game.cs

@@ -1,22 +1,51 @@
 // <copyright file="Game.cs" company="Software Antics">
-// Copyright (c) Software Antics. All rights reserved.
+//     Copyright (c) Software Antics. All rights reserved.
 // </copyright>
 
 namespace FinalEngine.Example;
 
+using System;
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Drawing;
 using System.Numerics;
 using FinalEngine.ECS;
+using FinalEngine.Input.Controllers;
 using FinalEngine.Rendering.Components;
 using FinalEngine.Rendering.Systems;
 using FinalEngine.Rendering.Textures;
 using FinalEngine.Runtime;
 
+public class GameControllerInputEntitySystem : EntitySystemBase
+{
+    private readonly IGameController controller;
+
+    public GameControllerInputEntitySystem(IGameController controller)
+    {
+        this.controller = controller ?? throw new ArgumentNullException(nameof(controller));
+    }
+
+    protected override bool IsMatch([NotNull] IReadOnlyEntity entity)
+    {
+        return entity.ContainsComponent<TransformComponent>();
+    }
+
+    protected override void Process([NotNull] IEnumerable<Entity> entities)
+    {
+        foreach (var entity in entities)
+        {
+            var transform = entity.GetComponent<TransformComponent>();
+            transform.Translate(movement, 1);
+        }
+    }
+}
+
 public sealed class Game : GameContainerBase
 {
     public override void Initialize()
     {
         this.World.AddSystem<SpriteRenderEntitySystem>();
+        this.World.AddSystem<GameControllerInputEntitySystem>();
 
         var entity = new Entity();
 

FinalEngine.Input/Controllers/ControllerAxis.cs

@@ -0,0 +1,16 @@
+// <copyright file="ControllerAxis.cs" company="Software Antics">
+//     Copyright (c) Software Antics. All rights reserved.
+// </copyright>
+
+namespace FinalEngine.Input.Controllers;
+
+public enum ControllerAxis
+{
+    LeftX = 0,
+
+    LeftY = 1,
+
+    RightX = 2,
+
+    RightY = 3,
+}

FinalEngine.Input/Controllers/ControllerButton.cs

@@ -0,0 +1,36 @@
+// <copyright file="ControllerButton.cs" company="Software Antics">
+//     Copyright (c) Software Antics. All rights reserved.
+// </copyright>
+
+namespace FinalEngine.Input.Controllers;
+
+public enum ControllerButton
+{
+    A = 0,
+
+    B = 1,
+
+    X = 2,
+
+    Y = 3,
+
+    L1 = 4,
+
+    R1 = 5,
+
+    Select = 6,
+
+    Start = 7,
+
+    L3 = 8,
+
+    R3 = 9,
+
+    PadUp = 10,
+
+    PadRight = 11,
+
+    PadDown = 12,
+
+    PadLeft = 13,
+}

FinalEngine.Input/Controllers/IGameController.cs

@@ -0,0 +1,16 @@
+// <copyright file="IGameController.cs" company="Software Antics">
+//     Copyright (c) Software Antics. All rights reserved.
+// </copyright>
+
+namespace FinalEngine.Input.Controllers;
+
+public interface IGameController
+{
+    float GetAxis(int index, ControllerAxis axis);
+
+    bool IsButtonDown(int index, ControllerButton button);
+
+    bool IsButtonPressed(int index, ControllerButton button);
+
+    bool IsButtonReleased(int index, ControllerButton button);
+}

FinalEngine.Input/InputDriver.cs

@@ -1,5 +1,5 @@
 // <copyright file="InputDriver.cs" company="Software Antics">
-// Copyright (c) Software Antics. All rights reserved.
+//     Copyright (c) Software Antics. All rights reserved.
 // </copyright>
 
 namespace FinalEngine.Input;

FinalEngine.Platform.Desktop/Extensions/ServiceCollectionExtensions.cs

@@ -1,10 +1,11 @@
 // <copyright file="ServiceCollectionExtensions.cs" company="Software Antics">
-// Copyright (c) Software Antics. All rights reserved.
+//     Copyright (c) Software Antics. All rights reserved.
 // </copyright>
 
 namespace FinalEngine.Platform.Desktop.Extensions;
 
 using System;
+using FinalEngine.Input.Controllers;
 using FinalEngine.Input.Keyboards;
 using FinalEngine.Input.Mouses;
 using FinalEngine.Platform.Desktop.OpenTK;
@@ -60,6 +61,7 @@ public static IServiceCollection AddPlatform(this IServiceCollection services)
 
         services.AddSingleton<IKeyboardDevice, OpenTKKeyboardDevice>();
         services.AddSingleton<IMouseDevice, OpenTKMouseDevice>();
+        services.AddSingleton<IGameController, OpenTKGameController>();
 
         return services;
     }

FinalEngine.Platform.Desktop/OpenTK/Invocation/INativeWindowInvoker.cs

@@ -5,10 +5,12 @@
 namespace FinalEngine.Platform.Desktop.OpenTK.Invocation;
 
 using System;
+using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 using global::OpenTK.Mathematics;
 using global::OpenTK.Windowing.Common;
 using global::OpenTK.Windowing.Desktop;
+using global::OpenTK.Windowing.GraphicsLibraryFramework;
 
 [SuppressMessage("Design", "CA1003:Use generic event handler instances", Justification = "Required by Invocation")]
 internal interface INativeWindowInvoker : IDisposable
@@ -37,6 +39,8 @@ internal interface INativeWindowInvoker : IDisposable
 
     bool IsVisible { get; set; }
 
+    IReadOnlyList<JoystickState> JoystickStates { get; }
+
     Vector2 MousePosition { get; set; }
 
     IMouseStateInvoker MouseState { get; }

FinalEngine.Platform.Desktop/OpenTK/OpenTKGameController.cs

@@ -0,0 +1,58 @@
+// <copyright file="OpenTKGameController.cs" company="Software Antics">
+//     Copyright (c) Software Antics. All rights reserved.
+// </copyright>
+
+namespace FinalEngine.Platform.Desktop.OpenTK;
+
+using FinalEngine.Input.Controllers;
+using FinalEngine.Platform.Desktop.OpenTK.Invocation;
+
+internal sealed class OpenTKGameController : IGameController
+{
+    private readonly INativeWindowInvoker window;
+
+    public OpenTKGameController(INativeWindowInvoker window)
+    {
+        this.window = window ?? throw new System.ArgumentNullException(nameof(window));
+    }
+
+    public float GetAxis(int index, ControllerAxis axis)
+    {
+        if (!(this.window.JoystickStates.Count >= index))
+        {
+            return 0.0f;
+        }
+
+        return this.window.JoystickStates[index].GetAxis((int)axis);
+    }
+
+    public bool IsButtonDown(int index, ControllerButton button)
+    {
+        if (!(this.window.JoystickStates.Count >= index))
+        {
+            return false;
+        }
+
+        return this.window.JoystickStates[index].IsButtonDown((int)button);
+    }
+
+    public bool IsButtonPressed(int index, ControllerButton button)
+    {
+        if (!(this.window.JoystickStates.Count >= index))
+        {
+            return false;
+        }
+
+        return this.window.JoystickStates[index].IsButtonPressed((int)button);
+    }
+
+    public bool IsButtonReleased(int index, ControllerButton button)
+    {
+        if (!(this.window.JoystickStates.Count >= index))
+        {
+            return false;
+        }
+
+        return this.window.JoystickStates[index].IsButtonReleased((int)button);
+    }
+}

FinalEngine.Runtime/GameContainerBase.cs

@@ -1,11 +1,13 @@
 // <copyright file="GameContainerBase.cs" company="Software Antics">
-// Copyright (c) Software Antics. All rights reserved.
+//     Copyright (c) Software Antics. All rights reserved.
 // </copyright>
 
 namespace FinalEngine.Runtime;
 
 using System;
+using System.Drawing;
 using FinalEngine.ECS;
+using FinalEngine.Input.Controllers;
 using FinalEngine.Input.Keyboards;
 using FinalEngine.Input.Mouses;
 using FinalEngine.Platform;
@@ -22,6 +24,7 @@ protected GameContainerBase()
         this.Window = ServiceLocator.Provider.GetRequiredService<IWindow>();
         this.Keyboard = ServiceLocator.Provider.GetRequiredService<IKeyboard>();
         this.Mouse = ServiceLocator.Provider.GetRequiredService<IMouse>();
+        this.Controller = ServiceLocator.Provider.GetRequiredService<IGameController>();
         this.RenderDevice = ServiceLocator.Provider.GetRequiredService<IRenderDevice>();
         this.ResourceManager = ServiceLocator.Provider.GetRequiredService<IResourceManager>();
         this.Drawer = ServiceLocator.Provider.GetRequiredService<ISpriteDrawer>();
@@ -41,6 +44,8 @@ protected GameContainerBase()
         this.Dispose(false);
     }
 
+    protected IGameController Controller { get; private set; }
+
     protected ISpriteDrawer Drawer { get; private set; }
 
     protected bool IsDisposed { get; private set; }
@@ -78,6 +83,7 @@ public virtual void LoadContent()
 
     public virtual void Render(float delta)
     {
+        this.RenderDevice.Clear(Color.CornflowerBlue);
         this.World.ProcessAll(GameLoopType.Render);
     }