Merge branch 'joyhat' into develop

Source/OpenTK/Input/HatPosition.cs

@@ -0,0 +1,77 @@
+#region License
+//
+// HatPosition.cs
+//
+// Author:
+//       Stefanos A. <stapostol@gmail.com>
+//
+// Copyright (c) 2006-2014 Stefanos Apostolopoulos
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+#endregion
+
+using System;
+
+namespace OpenTK.Input
+{
+    /// <summary>
+    /// Enumerates discrete positions for a joystick hat.
+    /// </summary>
+    public enum HatPosition : byte
+    {
+        /// <summary>
+        /// The hat is in its centered (neutral) position
+        /// </summary>
+        Centered = 0,
+        /// <summary>
+        /// The hat is in its top position.
+        /// </summary>
+        Up,
+        /// <summary>
+        /// The hat is in its top-right position.
+        /// </summary>
+        UpRight,
+        /// <summary>
+        /// The hat is in its right position.
+        /// </summary>
+        Right,
+        /// <summary>
+        /// The hat is in its bottom-right position.
+        /// </summary>
+        DownRight,
+        /// <summary>
+        /// The hat is in its bottom position.
+        /// </summary>
+        Down,
+        /// <summary>
+        /// The hat is in its bottom-left position.
+        /// </summary>
+        DownLeft,
+        /// <summary>
+        /// The hat is in its left position.
+        /// </summary>
+        Left,
+        /// <summary>
+        /// The hat is in its top-left position.
+        /// </summary>
+        UpLeft,
+    }
+}
+

Source/OpenTK/Input/JoystickCapabilities.cs

@@ -40,21 +40,23 @@ public struct JoystickCapabilities : IEquatable<JoystickCapabilities>
     {
         byte axis_count;
         byte button_count;
-        byte dpad_count;
+        byte hat_count;
         bool is_connected;
 
         #region Constructors
 
-        internal JoystickCapabilities(int axis_count, int button_count, bool is_connected)
+        internal JoystickCapabilities(int axis_count, int button_count, int hat_count, bool is_connected)
         {
-            if (axis_count < 0 || axis_count >= JoystickState.MaxAxes)
+            if (axis_count < 0 || axis_count > JoystickState.MaxAxes)
                 throw new ArgumentOutOfRangeException("axis_count");
-            if (button_count < 0 || button_count >= JoystickState.MaxButtons)
+            if (button_count < 0 || button_count > JoystickState.MaxButtons)
                 throw new ArgumentOutOfRangeException("axis_count");
+            if (hat_count < 0 || hat_count > JoystickState.MaxHats)
+                throw new ArgumentOutOfRangeException("hat_count");
 
             this.axis_count = (byte)axis_count;
             this.button_count = (byte)button_count;
-            this.dpad_count = 0; // Todo: either remove dpad_count or add it as a parameter
+            this.hat_count = (byte)hat_count;
             this.is_connected = is_connected;
         }
 
@@ -78,6 +80,14 @@ public int ButtonCount
             get { return button_count; }
         }
 
+        /// <summary>
+        /// Gets the number of hats supported by this <see cref="JoystickDevice"/>.
+        /// </summary>
+        public int HatCount
+        {
+            get { return hat_count; }
+        }
+
         /// <summary>
         /// Gets a value indicating whether this <see cref="JoystickDevice"/> is connected.
         /// </summary>
@@ -94,8 +104,8 @@ public bool IsConnected
         public override string ToString()
         {
             return String.Format(
-                "{{Axes: {0}; Buttons: {1}; IsConnected: {2}}}",
-                AxisCount, ButtonCount, IsConnected);
+                "{{Axes: {0}; Buttons: {1}; Hats: {2}; IsConnected: {2}}}",
+                AxisCount, ButtonCount, HatCount, IsConnected);
         }
 
         /// <summary>
@@ -108,6 +118,7 @@ public override int GetHashCode()
             return
                 AxisCount.GetHashCode() ^
                 ButtonCount.GetHashCode() ^
+                HatCount.GetHashCode() ^
                 IsConnected.GetHashCode();
         }
 
@@ -126,15 +137,6 @@ obj is JoystickCapabilities &&
 
         #endregion
 
-        #region Private Members
-
-        int DPadCount
-        {
-            get { return dpad_count; }
-        }
-
-        #endregion
-
         #region IEquatable<JoystickCapabilities> Members
 
         /// <summary>
@@ -148,6 +150,7 @@ public bool Equals(JoystickCapabilities other)
             return
                 AxisCount == other.AxisCount &&
                 ButtonCount == other.ButtonCount &&
+                HatCount == other.HatCount &&
                 IsConnected == other.IsConnected;
         }
 

Source/OpenTK/Input/JoystickHat.cs

@@ -0,0 +1,60 @@
+#region License
+//
+// JoystickHat.cs
+//
+// Author:
+//       Stefanos A. <stapostol@gmail.com>
+//
+// Copyright (c) 2006-2014 Stefanos Apostolopoulos
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+#endregion
+
+using System;
+
+namespace OpenTK.Input
+{
+    /// <summary>
+    /// Defines available Joystick hats.
+    /// </summary>
+    public enum JoystickHat
+    {
+        /// <summary>
+        /// The first hat of the Joystick device.
+        /// </summary>
+        Hat0,
+        /// <summary>
+        /// The second hat of the Joystick device.
+        /// </summary>
+        Hat1,
+        /// <summary>
+        /// The third hat of the Joystick device.
+        /// </summary>
+        Hat2,
+        /// <summary>
+        /// The fourth hat of the Joystick device.
+        /// </summary>
+        Hat3,
+        /// <summary>
+        /// The last hat of the Joystick device.
+        /// </summary>
+        Last = Hat3
+    }
+}

Source/OpenTK/Input/JoystickHatState.cs

@@ -0,0 +1,118 @@
+#region License
+//
+// JoystickHatState.cs
+//
+// Author:
+//       Stefanos A. <stapostol@gmail.com>
+//
+// Copyright (c) 2006-2014 Stefanos Apostolopoulos
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+#endregion
+
+using System;
+
+namespace OpenTK.Input
+{
+    /// <summary>
+    /// Describes the state of a joystick hat.
+    /// </summary>
+    public struct JoystickHatState
+    {
+        HatPosition position;
+
+        internal JoystickHatState(HatPosition pos)
+        {
+            position = pos;
+        }
+
+        /// <summary>
+        /// Gets a <see cref="HatPosition"/> value indicating
+        /// the position of this hat. 
+        /// </summary>
+        /// <value>The position.</value>
+        public HatPosition Position { get { return position; } }
+
+        /// <summary>
+        /// Gets a <see cref="System.Boolean"/> indicating
+        /// whether this hat lies in the top hemicircle.
+        /// </summary>
+        /// <value><c>true</c> if this hat lies in the top hemicircle; otherwise, <c>false</c>.</value>
+        public bool IsUp
+        {
+            get
+            {
+                return
+                    Position == HatPosition.Up ||
+                    Position == HatPosition.UpLeft ||
+                    Position == HatPosition.UpRight;
+            }
+        }
+
+        /// <summary>
+        /// Gets a <see cref="System.Boolean"/> indicating
+        /// whether this hat lies in the bottom hemicircle.
+        /// </summary>
+        /// <value><c>true</c> if this hat lies in the bottom hemicircle; otherwise, <c>false</c>.</value>
+        public bool IsDown
+        {
+            get
+            {
+                return
+                    Position == HatPosition.Down ||
+                    Position == HatPosition.DownLeft ||
+                    Position == HatPosition.DownRight;
+            }
+        }
+
+        /// <summary>
+        /// Gets a <see cref="System.Boolean"/> indicating
+        /// whether this hat lies in the left hemicircle.
+        /// </summary>
+        /// <value><c>true</c> if this hat lies in the left hemicircle; otherwise, <c>false</c>.</value>
+        public bool IsLeft
+        {
+            get
+            {
+                return
+                    Position == HatPosition.Left ||
+                    Position == HatPosition.UpLeft ||
+                    Position == HatPosition.DownLeft;
+            }
+        }
+
+        /// <summary>
+        /// Gets a <see cref="System.Boolean"/> indicating
+        /// whether this hat lies in the right hemicircle.
+        /// </summary>
+        /// <value><c>true</c> if this hat lies in the right hemicircle; otherwise, <c>false</c>.</value>
+        public bool IsRight
+        {
+            get
+            {
+                return
+                    Position == HatPosition.Right ||
+                    Position == HatPosition.UpRight ||
+                    Position == HatPosition.DownRight;
+            }
+        }
+    }
+}
+