aboutsummaryrefslogtreecommitdiffstatsci
path: root/src/Input/MouseScroll.cs
blob: a04e9d6912644e6cbda3a7dc7311af348538f1df (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
#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 Crow
{
    /// <summary>
    /// Represents the state of a mouse wheel.
    /// </summary>
    public struct MouseScroll : IEquatable<MouseScroll>
    {
	#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="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="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.MouseScroll"/>.
	/// </summary>
	/// <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.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>
	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.MouseScroll"/>.
	/// </summary>
	/// <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.MouseScroll"/>; otherwise, <c>false</c>.</returns>
	public override bool Equals(object obj)
	{
	    return
		obj is MouseScroll &&
		Equals((MouseScroll)obj);
	}

	#endregion

	#region IEquatable Members

	/// <summary>
	/// 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.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;
	}

	#endregion
    }
}