The Open Toolkit library  1.1
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Properties | List of all members
OpenTK.Input.MouseWheelEventArgs Class Reference

Defines the event data for MouseDevice.WheelChanged events. More...

Inheritance diagram for OpenTK.Input.MouseWheelEventArgs:
OpenTK.Input.MouseEventArgs

Public Member Functions

 MouseWheelEventArgs ()
 Constructs a new MouseWheelEventArgs instance. More...
 
 MouseWheelEventArgs (int x, int y, int value, int delta)
 Constructs a new MouseWheelEventArgs instance. More...
 
 MouseWheelEventArgs (MouseWheelEventArgs args)
 Constructs a new MouseWheelEventArgs instance. More...
 
- Public Member Functions inherited from OpenTK.Input.MouseEventArgs
 MouseEventArgs ()
 Constructs a new instance. More...
 
 MouseEventArgs (int x, int y)
 Constructs a new instance. More...
 
 MouseEventArgs (MouseEventArgs args)
 Constructs a new instance. More...
 

Properties

int Value [get]
 Gets the value of the wheel in integer units. To support high-precision mice, it is recommended to use ValuePrecise instead. More...
 
int Delta [get]
 Gets the change in value of the wheel for this event in integer units. To support high-precision mice, it is recommended to use DeltaPrecise instead. More...
 
float ValuePrecise [get, set]
 Gets the precise value of the wheel in floating-point units. More...
 
float DeltaPrecise [get, set]
 Gets the precise change in value of the wheel for this event in floating-point units. More...
 
- Properties inherited from OpenTK.Input.MouseEventArgs
int X [get, set]
 Gets the X position of the mouse for the event. More...
 
int Y [get, set]
 Gets the Y position of the mouse for the event. More...
 
Point Position [get]
 Gets a System.Drawing.Points representing the location of the mouse for the event. More...
 

Detailed Description

Defines the event data for MouseDevice.WheelChanged events.

Do not cache instances of this type outside their event handler. If necessary, you can clone an instance using the MouseWheelEventArgs(MouseWheelEventArgs) constructor.

Constructor & Destructor Documentation

OpenTK.Input.MouseWheelEventArgs.MouseWheelEventArgs ( )

Constructs a new MouseWheelEventArgs instance.

OpenTK.Input.MouseWheelEventArgs.MouseWheelEventArgs ( int  x,
int  y,
int  value,
int  delta 
)

Constructs a new MouseWheelEventArgs instance.

Parameters
xThe X position.
yThe Y position.
valueThe value of the wheel.
deltaThe change in value of the wheel for this event.
OpenTK.Input.MouseWheelEventArgs.MouseWheelEventArgs ( MouseWheelEventArgs  args)

Constructs a new MouseWheelEventArgs instance.

Parameters
argsThe MouseWheelEventArgs instance to clone.

Property Documentation

int OpenTK.Input.MouseWheelEventArgs.Delta
get

Gets the change in value of the wheel for this event in integer units. To support high-precision mice, it is recommended to use DeltaPrecise instead.

float OpenTK.Input.MouseWheelEventArgs.DeltaPrecise
getset

Gets the precise change in value of the wheel for this event in floating-point units.

int OpenTK.Input.MouseWheelEventArgs.Value
get

Gets the value of the wheel in integer units. To support high-precision mice, it is recommended to use ValuePrecise instead.

float OpenTK.Input.MouseWheelEventArgs.ValuePrecise
getset

Gets the precise value of the wheel in floating-point units.