[Input] Renamed MouseScrollWheel to MouseScroll
authorthefiddler <stapostol@gmail.com>
Tue, 13 May 2014 21:25:56 +0000 (23:25 +0200)
committerthefiddler <stapostol@gmail.com>
Tue, 13 May 2014 21:25:56 +0000 (23:25 +0200)
This better describes the functionality of this structure.

Source/OpenTK/Input/MouseScroll.cs
Source/OpenTK/Input/MouseScrollWheel.cs [deleted file]
Source/OpenTK/Input/MouseState.cs
Source/OpenTK/OpenTK.csproj

index 2be06b6..c9f024f 100644 (file)
@@ -34,7 +34,7 @@ namespace OpenTK.Input
     /// <summary>
     /// Represents the state of a mouse wheel.
     /// </summary>
-    public struct MouseScrollWheel : IEquatable<MouseScrollWheel>
+    public struct MouseScroll : IEquatable<MouseScroll>
     {
         #region Public Members
 
@@ -52,31 +52,31 @@ namespace OpenTK.Input
         /// <value>The y.</value>
         public float Y { get; internal set; }
 
-        /// <param name="left">A <see cref="MouseScrollWheel"/> instance to test for equality.</param>
-        /// <param name="right">A <see cref="MouseScrollWheel"/> instance to test for equality.</param>
-        public static bool operator ==(MouseScrollWheel left, MouseScrollWheel right)
+        /// <param name="left">A <see cref="MouseScroll"/> instance to test for equality.</param>
+        /// <param name="right">A <see cref="MouseScroll"/> instance to test for equality.</param>
+        public static bool operator ==(MouseScroll left, MouseScroll right)
         {
             return left.Equals(right);
         }
 
-        /// <param name="left">A <see cref="MouseScrollWheel"/> instance to test for inequality.</param>
-        /// <param name="right">A <see cref="MouseScrollWheel"/> instance to test for inequality.</param>
-        public static bool operator !=(MouseScrollWheel left, MouseScrollWheel right)
+        /// <param name="left">A <see cref="MouseScroll"/> instance to test for inequality.</param>
+        /// <param name="right">A <see cref="MouseScroll"/> instance to test for inequality.</param>
+        public static bool operator !=(MouseScroll left, MouseScroll right)
         {
             return !left.Equals(right);
         }
 
         /// <summary>
-        /// Returns a <see cref="System.String"/> that represents the current <see cref="OpenTK.Input.MouseScrollWheel"/>.
+        /// Returns a <see cref="System.String"/> that represents the current <see cref="OpenTK.Input.MouseScroll"/>.
         /// </summary>
-        /// <returns>A <see cref="System.String"/> that represents the current <see cref="OpenTK.Input.MouseScrollWheel"/>.</returns>
+        /// <returns>A <see cref="System.String"/> that represents the current <see cref="OpenTK.Input.MouseScroll"/>.</returns>
         public override string ToString()
         {
             return string.Format("[X={0:0.00}, Y={1:0.00}]", X, Y);
         }
 
         /// <summary>
-        /// Serves as a hash function for a <see cref="OpenTK.Input.MouseScrollWheel"/> object.
+        /// Serves as a hash function for a <see cref="OpenTK.Input.MouseScroll"/> object.
         /// </summary>
         /// <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a
         /// hash table.</returns>
@@ -86,16 +86,16 @@ namespace OpenTK.Input
         }
 
         /// <summary>
-        /// Determines whether the specified <see cref="System.Object"/> is equal to the current <see cref="OpenTK.Input.MouseScrollWheel"/>.
+        /// Determines whether the specified <see cref="System.Object"/> is equal to the current <see cref="OpenTK.Input.MouseScroll"/>.
         /// </summary>
-        /// <param name="obj">The <see cref="System.Object"/> to compare with the current <see cref="OpenTK.Input.MouseScrollWheel"/>.</param>
+        /// <param name="obj">The <see cref="System.Object"/> to compare with the current <see cref="OpenTK.Input.MouseScroll"/>.</param>
         /// <returns><c>true</c> if the specified <see cref="System.Object"/> is equal to the current
-        /// <see cref="OpenTK.Input.MouseScrollWheel"/>; otherwise, <c>false</c>.</returns>
+        /// <see cref="OpenTK.Input.MouseScroll"/>; otherwise, <c>false</c>.</returns>
         public override bool Equals(object obj)
         {
             return
-                obj is MouseScrollWheel &&
-                Equals((MouseScrollWheel)obj);
+                obj is MouseScroll &&
+                Equals((MouseScroll)obj);
         }
 
         #endregion
@@ -103,12 +103,12 @@ namespace OpenTK.Input
         #region IEquatable Members
 
         /// <summary>
-        /// Determines whether the specified <see cref="OpenTK.Input.MouseScrollWheel"/> is equal to the current <see cref="OpenTK.Input.MouseScrollWheel"/>.
+        /// Determines whether the specified <see cref="OpenTK.Input.MouseScroll"/> is equal to the current <see cref="OpenTK.Input.MouseScroll"/>.
         /// </summary>
-        /// <param name="other">The <see cref="OpenTK.Input.MouseScrollWheel"/> to compare with the current <see cref="OpenTK.Input.MouseScrollWheel"/>.</param>
-        /// <returns><c>true</c> if the specified <see cref="OpenTK.Input.MouseScrollWheel"/> is equal to the current
-        /// <see cref="OpenTK.Input.MouseScrollWheel"/>; otherwise, <c>false</c>.</returns>
-        public bool Equals(MouseScrollWheel other)
+        /// <param name="other">The <see cref="OpenTK.Input.MouseScroll"/> to compare with the current <see cref="OpenTK.Input.MouseScroll"/>.</param>
+        /// <returns><c>true</c> if the specified <see cref="OpenTK.Input.MouseScroll"/> is equal to the current
+        /// <see cref="OpenTK.Input.MouseScroll"/>; otherwise, <c>false</c>.</returns>
+        public bool Equals(MouseScroll other)
         {
             return X == other.X && Y == other.Y;
         }
diff --git a/Source/OpenTK/Input/MouseScrollWheel.cs b/Source/OpenTK/Input/MouseScrollWheel.cs
deleted file mode 100644 (file)
index 2be06b6..0000000
+++ /dev/null
@@ -1,119 +0,0 @@
-#region License
-//
-// MouseWheel.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>
-    /// Represents the state of a mouse wheel.
-    /// </summary>
-    public struct MouseScrollWheel : IEquatable<MouseScrollWheel>
-    {
-        #region Public Members
-
-        /// <summary>
-        /// Gets the absolute horizontal offset of the wheel,
-        /// or 0 if no horizontal scroll wheel exists.
-        /// </summary>
-        /// <value>The x.</value>
-        public float X { get; internal set; }
-
-        /// <summary>
-        /// Gets the absolute vertical offset of the wheel,
-        /// or 0 if no vertical scroll wheel exists.
-        /// </summary>
-        /// <value>The y.</value>
-        public float Y { get; internal set; }
-
-        /// <param name="left">A <see cref="MouseScrollWheel"/> instance to test for equality.</param>
-        /// <param name="right">A <see cref="MouseScrollWheel"/> instance to test for equality.</param>
-        public static bool operator ==(MouseScrollWheel left, MouseScrollWheel right)
-        {
-            return left.Equals(right);
-        }
-
-        /// <param name="left">A <see cref="MouseScrollWheel"/> instance to test for inequality.</param>
-        /// <param name="right">A <see cref="MouseScrollWheel"/> instance to test for inequality.</param>
-        public static bool operator !=(MouseScrollWheel left, MouseScrollWheel right)
-        {
-            return !left.Equals(right);
-        }
-
-        /// <summary>
-        /// Returns a <see cref="System.String"/> that represents the current <see cref="OpenTK.Input.MouseScrollWheel"/>.
-        /// </summary>
-        /// <returns>A <see cref="System.String"/> that represents the current <see cref="OpenTK.Input.MouseScrollWheel"/>.</returns>
-        public override string ToString()
-        {
-            return string.Format("[X={0:0.00}, Y={1:0.00}]", X, Y);
-        }
-
-        /// <summary>
-        /// Serves as a hash function for a <see cref="OpenTK.Input.MouseScrollWheel"/> object.
-        /// </summary>
-        /// <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a
-        /// hash table.</returns>
-        public override int GetHashCode()
-        {
-            return X.GetHashCode() ^ Y.GetHashCode();
-        }
-
-        /// <summary>
-        /// Determines whether the specified <see cref="System.Object"/> is equal to the current <see cref="OpenTK.Input.MouseScrollWheel"/>.
-        /// </summary>
-        /// <param name="obj">The <see cref="System.Object"/> to compare with the current <see cref="OpenTK.Input.MouseScrollWheel"/>.</param>
-        /// <returns><c>true</c> if the specified <see cref="System.Object"/> is equal to the current
-        /// <see cref="OpenTK.Input.MouseScrollWheel"/>; otherwise, <c>false</c>.</returns>
-        public override bool Equals(object obj)
-        {
-            return
-                obj is MouseScrollWheel &&
-                Equals((MouseScrollWheel)obj);
-        }
-
-        #endregion
-
-        #region IEquatable Members
-
-        /// <summary>
-        /// Determines whether the specified <see cref="OpenTK.Input.MouseScrollWheel"/> is equal to the current <see cref="OpenTK.Input.MouseScrollWheel"/>.
-        /// </summary>
-        /// <param name="other">The <see cref="OpenTK.Input.MouseScrollWheel"/> to compare with the current <see cref="OpenTK.Input.MouseScrollWheel"/>.</param>
-        /// <returns><c>true</c> if the specified <see cref="OpenTK.Input.MouseScrollWheel"/> is equal to the current
-        /// <see cref="OpenTK.Input.MouseScrollWheel"/>; otherwise, <c>false</c>.</returns>
-        public bool Equals(MouseScrollWheel other)
-        {
-            return X == other.X && Y == other.Y;
-        }
-
-        #endregion
-    }
-}
-
index a07567c..3a74a0f 100644 (file)
@@ -39,7 +39,7 @@ namespace OpenTK.Input
         #region Fields
 
         int x, y;
-        MouseScrollWheel scroll;
+        MouseScroll scroll;
         ushort buttons;
         bool is_connected;
 
@@ -104,7 +104,7 @@ namespace OpenTK.Input
         /// Gets a <see cref="OpenTK.Input.MouseScrollWheel"/> instance,
         /// representing the current state of the mouse scroll wheel.
         /// </summary>
-        public MouseScrollWheel Scroll
+        public MouseScroll Scroll
         {
             get { return scroll; }
         }
index 333f516..502877f 100644 (file)
     <Compile Include="WindowIcon.cs" />
     <Compile Include="Platform\MacOS\Cocoa\NSBitmapFormat.cs" />
     <Compile Include="Platform\NativeWindowBase.cs" />
-    <Compile Include="Input\MouseScrollWheel.cs" />
     <Compile Include="Input\MouseEventArgs.cs" />
     <Compile Include="Platform\MacOS\Quartz\EventServices.cs" />
     <Compile Include="Platform\MacOS\Quartz\DisplayServices.cs">
     <Compile Include="Platform\MacOS\Quartz\CoreFoundation.cs">
       <SubType>Code</SubType>
     </Compile>
+    <Compile Include="Input\MouseScroll.cs" />
   </ItemGroup>
   <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
   <PropertyGroup>