Simplify event classes, combine various input interfaces into one interfaces file.

This commit is contained in:
UnknownShadow200 2015-08-16 11:41:01 +10:00
parent 09939603de
commit 12814a308b
11 changed files with 114 additions and 576 deletions

View File

@ -1,48 +0,0 @@
#region --- License ---
/* Copyright (c) 2006, 2007 Stefanos Apostolopoulos
* See license.txt for license info
*/
#endregion
using System;
using System.Collections.Generic;
using System.Text;
namespace OpenTK.Input
{
/// <summary>
/// Defines a common interface for all input devices.
/// </summary>
public interface IInputDevice
{
/// <summary>
/// Gets a System.String with a unique description of this IInputDevice instance.
/// </summary>
string Description { get; }
/// <summary>
/// Gets an OpenTK.Input.InputDeviceType value, representing the device type of this IInputDevice instance.
/// </summary>
InputDeviceType DeviceType { get; }
}
/// <summary>
/// The type of the input device.
/// </summary>
public enum InputDeviceType
{
/// <summary>
/// Device is a keyboard.
/// </summary>
Keyboard,
/// <summary>
/// Device is a mouse.
/// </summary>
Mouse,
/// <summary>
/// Device is a Human Interface Device. Joysticks, joypads, pens
/// and some specific usb keyboards/mice fall into this category.
/// </summary>
Hid
}
}

View File

@ -1,23 +0,0 @@
#region --- License ---
/* Copyright (c) 2006, 2007 Stefanos Apostolopoulos
* See license.txt for license info
*/
#endregion
using System;
using System.Collections.Generic;
using System.Text;
namespace OpenTK.Input
{
/// <summary>
/// Defines the interface for an input driver.
/// </summary>
public interface IInputDriver : IKeyboardDriver, IMouseDriver, IJoystickDriver, IDisposable
{
/// <summary>
/// Updates the state of the driver.
/// </summary>
void Poll();
}
}

View File

@ -1,44 +0,0 @@
#region License
//
// The Open Toolkit Library License
//
// Copyright (c) 2006 - 2008 the Open Toolkit library, except where noted.
//
// 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;
using System.Collections.Generic;
using System.Text;
namespace OpenTK.Input
{
/// <summary>
/// Defines the interface for JoystickDevice drivers.
/// </summary>
public interface IJoystickDriver
{
/// <summary>
/// Gets the list of available JoystickDevices.
/// </summary>
IList<JoystickDevice> Joysticks { get; }
}
}

View File

@ -1,23 +0,0 @@
#region --- License ---
/* Copyright (c) 2006, 2007 Stefanos Apostolopoulos
* See license.txt for license info
*/
#endregion
using System;
using System.Collections.Generic;
using System.Text;
namespace OpenTK.Input
{
/// <summary>
/// Defines the interface for KeyboardDevice drivers.
/// </summary>
public interface IKeyboardDriver
{
/// <summary>
/// Gets the list of available KeyboardDevices.
/// </summary>
IList<KeyboardDevice> Keyboard { get; }
}
}

View File

@ -1,26 +0,0 @@
#region --- License ---
/* Copyright (c) 2006, 2007 Stefanos Apostolopoulos
* See license.txt for license info
*/
#endregion
using System;
using System.Collections.Generic;
using System.Drawing;
using System.Text;
namespace OpenTK.Input
{
/// <summary>
/// Defines the interface for MouseDevice drivers.
/// </summary>
public interface IMouseDriver
{
/// <summary>
/// Gets the list of available MouseDevices.
/// </summary>
IList<MouseDevice> Mouse { get; }
Point DesktopCursorPos { get; set; }
}
}

View File

@ -0,0 +1,63 @@
#region --- License ---
/* Copyright (c) 2006, 2007 Stefanos Apostolopoulos
* See license.txt for license info
*/
#endregion
using System;
using System.Collections.Generic;
using System.Drawing;
namespace OpenTK.Input {
/// <summary> Defines a common interface for all input devices. </summary>
public interface IInputDevice {
/// <summary> Gets a System.String with a unique description of this IInputDevice instance. </summary>
string Description { get; }
/// <summary> Gets an OpenTK.Input.InputDeviceType value, representing the device type of this IInputDevice instance. </summary>
InputDeviceType DeviceType { get; }
}
/// <summary> The type of the input device. </summary>
public enum InputDeviceType {
/// <summary> Device is a keyboard. </summary>
Keyboard,
/// <summary> Device is a mouse. </summary>
Mouse,
/// <summary> Device is a Human Interface Device. Joysticks, joypads, pens
/// and some specific usb keyboards/mice fall into this category. </summary>
Hid
}
/// <summary> Defines the interface for an input driver. </summary>
public interface IInputDriver : IKeyboardDriver, IMouseDriver, IJoystickDriver, IDisposable {
/// <summary> Updates the state of the driver. </summary>
void Poll();
}
/// <summary> Defines the interface for JoystickDevice drivers. </summary>
public interface IJoystickDriver {
/// <summary> Gets the list of available JoystickDevices. </summary>
IList<JoystickDevice> Joysticks { get; }
}
/// <summary> Defines the interface for KeyboardDevice drivers. </summary>
public interface IKeyboardDriver {
/// <summary> Gets the list of available KeyboardDevices. </summary>
IList<KeyboardDevice> Keyboard { get; }
}
/// <summary> Defines the interface for MouseDevice drivers. </summary>
public interface IMouseDriver {
/// <summary> Gets the list of available MouseDevices. </summary>
IList<MouseDevice> Mouse { get; }
Point DesktopCursorPos { get; set; }
}
}

View File

@ -4,15 +4,8 @@
*/
#endregion
#region --- Using directives ---
using System;
using OpenTK.Input;
using System.Diagnostics;
#endregion
namespace OpenTK.Input
{
/// <summary>
@ -205,4 +198,10 @@ namespace OpenTK.Input
#endregion
}
public class KeyboardKeyEventArgs : EventArgs {
/// <summary> Gets the <see cref="Key"/> that generated this event. </summary>
public Key Key;
}
}

View File

@ -1,83 +0,0 @@
#region License
//
// The Open Toolkit Library License
//
// Copyright (c) 2006 - 2009 the Open Toolkit library.
//
// 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;
using System.Collections.Generic;
using System.Text;
namespace OpenTK.Input
{
/// <summary>
/// Defines the event data for <see cref="KeyboardDevice"/> events.
/// </summary>
/// <remarks>
/// <para>
/// Do not cache instances of this type outside their event handler.
/// If necessary, you can clone a KeyboardEventArgs instance using the
/// <see cref="KeyboardKeyEventArgs(KeyboardKeyEventArgs)"/> constructor.
/// </para>
/// </remarks>
public class KeyboardKeyEventArgs : EventArgs
{
#region Fields
Key key;
#endregion
#region Constructors
/// <summary>
/// Constructs a new KeyboardEventArgs instance.
/// </summary>
public KeyboardKeyEventArgs() { }
/// <summary>
/// Constructs a new KeyboardEventArgs instance.
/// </summary>
/// <param name="args">An existing KeyboardEventArgs instance to clone.</param>
public KeyboardKeyEventArgs(KeyboardKeyEventArgs args)
{
Key = args.Key;
}
#endregion
#region Public Members
/// <summary>
/// Gets the <see cref="Key"/> that generated this event.
/// </summary>
public Key Key
{
get { return key; }
internal set { key = value; }
}
#endregion
}
}

View File

@ -26,67 +26,36 @@
#endregion
using System;
using System.Collections.Generic;
using System.Text;
namespace OpenTK.Input
{
/// <summary>
/// Enumerates all possible mouse buttons.
/// </summary>
public enum MouseButton
{
/// <summary>
/// The left mouse button.
/// </summary>
namespace OpenTK.Input {
/// <summary> Enumerates all possible mouse buttons. </summary>
public enum MouseButton {
/// <summary> The left mouse button. </summary>
Left = 0,
/// <summary>
/// The right mouse button.
/// </summary>
/// <summary> The right mouse button. </summary>
Right,
/// <summary>
/// The middle mouse button.
/// </summary>
/// <summary> The middle mouse button. </summary>
Middle,
/// <summary>
/// The first extra mouse button.
/// </summary>
/// <summary> The first extra mouse button. </summary>
Button1,
/// <summary>
/// The second extra mouse button.
/// </summary>
/// <summary> The second extra mouse button. </summary>
Button2,
/// <summary>
/// The third extra mouse button.
/// </summary>
/// <summary> The third extra mouse button. </summary>
Button3,
/// <summary>
/// The fourth extra mouse button.
/// </summary>
/// <summary> The fourth extra mouse button. </summary>
Button4,
/// <summary>
/// The fifth extra mouse button.
/// </summary>
/// <summary> The fifth extra mouse button. </summary>
Button5,
/// <summary>
/// The sixth extra mouse button.
/// </summary>
/// <summary> The sixth extra mouse button. </summary>
Button6,
/// <summary>
/// The seventh extra mouse button.
/// </summary>
/// <summary> The seventh extra mouse button. </summary>
Button7,
/// <summary>
/// The eigth extra mouse button.
/// </summary>
/// <summary> The eigth extra mouse button. </summary>
Button8,
/// <summary>
/// The ninth extra mouse button.
/// </summary>
/// <summary> The ninth extra mouse button. </summary>
Button9,
/// <summary>
/// Indicates the last available mouse button.
/// </summary>
/// <summary> Indicates the last available mouse button. </summary>
LastButton
}
}

View File

@ -26,10 +26,7 @@
#endregion
using System;
using System.Collections.Generic;
using System.Text;
using System.Drawing;
using System.ComponentModel;
namespace OpenTK.Input
{
@ -287,285 +284,47 @@ namespace OpenTK.Input
#endregion
}
#region Event Arguments
public class MouseEventArgs : EventArgs {
/// <summary>
/// Defines the event data for <see cref="MouseDevice"/> events.
/// </summary>
/// <remarks>
/// <para>
/// Do not cache instances of this type outside their event handler.
/// If necessary, you can clone an instance using the
/// <see cref="MouseEventArgs(MouseEventArgs)"/> constructor.
/// </para>
/// </remarks>
public class MouseEventArgs : EventArgs
{
#region Fields
/// <summary> Gets the X position of the mouse for the event. </summary>
public int X;
int x, y;
#endregion
#region Constructors
/// <summary>
/// Constructs a new instance.
/// </summary>
public MouseEventArgs()
{
}
/// <summary>
/// Constructs a new instance.
/// </summary>
/// <param name="x">The X position.</param>
/// <param name="y">The Y position.</param>
public MouseEventArgs(int x, int y)
{
this.x = x;
this.y = y;
}
/// <summary>
/// Constructs a new instance.
/// </summary>
/// <param name="args">The <see cref="MouseEventArgs"/> instance to clone.</param>
public MouseEventArgs(MouseEventArgs args)
: this(args.x, args.y)
{
}
#endregion
#region Public Members
/// <summary>
/// Gets the X position of the mouse for the event.
/// </summary>
public int X { get { return x; } internal set { x = value; } }
/// <summary>
/// Gets the Y position of the mouse for the event.
/// </summary>
public int Y { get { return y; } internal set { y = value; } }
/// <summary>
/// Gets a System.Drawing.Points representing the location of the mouse for the event.
/// </summary>
public Point Position { get { return new Point(x, y); } }
#endregion
/// <summary>Gets the Y position of the mouse for the event. </summary>
public int Y;
}
/// <summary>
/// Defines the event data for <see cref="MouseDevice.Move"/> events.
/// </summary>
/// <remarks>
/// <para>
/// Do not cache instances of this type outside their event handler.
/// If necessary, you can clone an instance using the
/// <see cref="MouseMoveEventArgs(MouseMoveEventArgs)"/> constructor.
/// </para>
/// </remarks>
public class MouseMoveEventArgs : MouseEventArgs
{
#region Fields
public class MouseMoveEventArgs : MouseEventArgs {
int x_delta, y_delta;
/// <summary> Gets the change in X position produced by this event. </summary>
public int XDelta;
#endregion
#region Constructors
/// <summary>
/// Constructs a new <see cref="MouseMoveEventArgs"/> instance.
/// </summary>
public MouseMoveEventArgs() { }
/// <summary>
/// Constructs a new <see cref="MouseMoveEventArgs"/> instance.
/// </summary>
/// <param name="x">The X position.</param>
/// <param name="y">The Y position.</param>
/// <param name="xDelta">The change in X position produced by this event.</param>
/// <param name="yDelta">The change in Y position produced by this event.</param>
public MouseMoveEventArgs(int x, int y, int xDelta, int yDelta)
: base(x, y)
{
XDelta = xDelta;
YDelta = yDelta;
}
/// <summary>
/// Constructs a new <see cref="MouseMoveEventArgs"/> instance.
/// </summary>
/// <param name="args">The <see cref="MouseMoveEventArgs"/> instance to clone.</param>
public MouseMoveEventArgs(MouseMoveEventArgs args)
: this(args.X, args.Y, args.XDelta, args.YDelta)
{
}
#endregion
#region Public Members
/// <summary>
/// Gets the change in X position produced by this event.
/// </summary>
public int XDelta { get { return x_delta; } internal set { x_delta = value; } }
/// <summary>
/// Gets the change in Y position produced by this event.
/// </summary>
public int YDelta { get { return y_delta; } internal set { y_delta = value; } }
#endregion
/// <summary> Gets the change in Y position produced by this event. </summary>
public int YDelta;
}
/// <summary>
/// Defines the event data for <see cref="MouseDevice.ButtonDown"/> and <see cref="MouseDevice.ButtonUp"/> events.
/// </summary>
/// <remarks>
/// <para>
/// Do not cache instances of this type outside their event handler.
/// If necessary, you can clone an instance using the
/// <see cref="MouseButtonEventArgs(MouseButtonEventArgs)"/> constructor.
/// </para>
/// </remarks>
public class MouseButtonEventArgs : MouseEventArgs
{
#region Fields
public class MouseButtonEventArgs : MouseEventArgs {
/// <summary> The mouse button for the event. </summary>
public MouseButton Button;
MouseButton button;
bool pressed;
#endregion
#region Constructors
/// <summary>
/// Constructs a new <see cref="MouseButtonEventArgs"/> instance.
/// </summary>
public MouseButtonEventArgs() { }
/// <summary>
/// Constructs a new <see cref="MouseButtonEventArgs"/> instance.
/// </summary>
/// <param name="x">The X position.</param>
/// <param name="y">The Y position.</param>
/// <param name="button">The mouse button for the event.</param>
/// <param name="pressed">The current state of the button.</param>
public MouseButtonEventArgs(int x, int y, MouseButton button, bool pressed)
: base(x, y)
{
this.button = button;
this.pressed = pressed;
}
/// <summary>
/// Constructs a new <see cref="MouseButtonEventArgs"/> instance.
/// </summary>
/// <param name="args">The <see cref="MouseButtonEventArgs"/> instance to clone.</param>
public MouseButtonEventArgs(MouseButtonEventArgs args)
: this(args.X, args.Y, args.Button, args.IsPressed)
{
}
#endregion
#region Public Members
/// <summary>
/// The mouse button for the event.
/// </summary>
public MouseButton Button { get { return button; } internal set { button = value; } }
/// <summary>
/// Gets a System.Boolean representing the state of the mouse button for the event.
/// </summary>
public bool IsPressed { get { return pressed; } internal set { pressed = value; } }
#endregion
/// <summary> Gets a System.Boolean representing the state of the mouse button for the event. </summary>
public bool IsPressed;
}
/// <summary>
/// Defines the event data for <see cref="MouseDevice.WheelChanged"/> events.
/// </summary>
/// <remarks>
/// <para>
/// Do not cache instances of this type outside their event handler.
/// If necessary, you can clone an instance using the
/// <see cref="MouseWheelEventArgs(MouseWheelEventArgs)"/> constructor.
/// </para>
/// </remarks>
public class MouseWheelEventArgs : MouseEventArgs
{
#region Fields
public class MouseWheelEventArgs : MouseEventArgs {
float value;
float delta;
/// <summary> Gets the value of the wheel in integer units.
/// To support high-precision mice, it is recommended to use <see cref="ValuePrecise"/> instead. </summary>
public int Value { get { return (int)Math.Round(ValuePrecise, MidpointRounding.AwayFromZero); } }
#endregion
/// <summary> Gets the change in value of the wheel for this event in integer units.
/// To support high-precision mice, it is recommended to use <see cref="DeltaPrecise"/> instead. </summary>
public int Delta { get { return (int)Math.Round(DeltaPrecise, MidpointRounding.AwayFromZero); } }
#region Constructors
/// <summary> Gets the precise value of the wheel in floating-point units. </summary>
public float ValuePrecise;
/// <summary>
/// Constructs a new <see cref="MouseWheelEventArgs"/> instance.
/// </summary>
public MouseWheelEventArgs() { }
/// <summary>
/// Constructs a new <see cref="MouseWheelEventArgs"/> instance.
/// </summary>
/// <param name="x">The X position.</param>
/// <param name="y">The Y position.</param>
/// <param name="value">The value of the wheel.</param>
/// <param name="delta">The change in value of the wheel for this event.</param>
public MouseWheelEventArgs(int x, int y, int value, int delta)
: base(x, y)
{
this.value = value;
this.delta = delta;
}
/// <summary>
/// Constructs a new <see cref="MouseWheelEventArgs"/> instance.
/// </summary>
/// <param name="args">The <see cref="MouseWheelEventArgs"/> instance to clone.</param>
public MouseWheelEventArgs(MouseWheelEventArgs args)
: this(args.X, args.Y, args.Value, args.Delta)
{
}
#endregion
#region Public Members
/// <summary>
/// Gets the value of the wheel in integer units.
/// To support high-precision mice, it is recommended to use <see cref="ValuePrecise"/> instead.
/// </summary>
public int Value { get { return (int)Math.Round(value, MidpointRounding.AwayFromZero); } }
/// <summary>
/// Gets the change in value of the wheel for this event in integer units.
/// To support high-precision mice, it is recommended to use <see cref="DeltaPrecise"/> instead.
/// </summary>
public int Delta { get { return (int)Math.Round(delta, MidpointRounding.AwayFromZero); } }
/// <summary>
/// Gets the precise value of the wheel in floating-point units.
/// </summary>
public float ValuePrecise { get { return value; } internal set { this.value = value; } }
/// <summary>
/// Gets the precise change in value of the wheel for this event in floating-point units.
/// </summary>
public float DeltaPrecise { get { return delta; } internal set { delta = value; } }
#endregion
/// <summary> Gets the precise change in value of the wheel for this event in floating-point units. </summary>
public float DeltaPrecise;
}
#endregion
}

View File

@ -72,15 +72,10 @@
<Compile Include="Graphics\IGraphicsMode.cs" />
<Compile Include="Graphics\OpenGL\GLEnums.cs" />
<Compile Include="Graphics\OpenGL\GLHelper.cs" />
<Compile Include="Input\IInputDevice.cs" />
<Compile Include="Input\IInputDriver.cs" />
<Compile Include="Input\IJoystickDriver.cs" />
<Compile Include="Input\IKeyboardDriver.cs" />
<Compile Include="Input\IMouseDriver.cs" />
<Compile Include="Input\Interfaces.cs" />
<Compile Include="Input\JoystickDevice.cs" />
<Compile Include="Input\Key.cs" />
<Compile Include="Input\KeyboardDevice.cs" />
<Compile Include="Input\KeyboardKeyEventArgs.cs" />
<Compile Include="Input\MouseButton.cs" />
<Compile Include="Input\MouseDevice.cs" />
<Compile Include="Math\Matrix4.cs" />