OmegaEngine API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Public Attributes | Protected Member Functions | Properties | List of all members
OmegaEngine.Input.MouseInputProvider Class Reference

Processes mouse events into higher-level navigational commands. More...

Inheritance diagram for OmegaEngine.Input.MouseInputProvider:
OmegaEngine.Input.InputProvider

Public Member Functions

 MouseInputProvider (Control control)
 Starts monitoring and processing mouse events receieved by a specififc control. More...
 
- Public Member Functions inherited from OmegaEngine.Input.InputProvider
void AddReceiver (IInputReceiver receiver)
 Adds an object that wishes to be notified about navigational commands that are triggered by input. More...
 
void RemoveReceiver (IInputReceiver receiver)
 Removes an object that no longer wishes to be notified about navigational commands. More...
 
void Dispose ()
 

Public Attributes

const int ClickAccuracy = 10
 The number of pixels the mouse may move while pressed to still be considered a click. More...
 
- Public Attributes inherited from OmegaEngine.Input.InputProvider
bool HasReceivers => _receivers.Count != 0
 Indicates whether this handler currently has IInputReceiver attached to it. More...
 

Protected Member Functions

override void Dispose (bool disposing)
 To be called by IDisposable.Dispose and the object destructor.
Parameters
disposingtrue if called manually and not by the garbage collector.

 
- Protected Member Functions inherited from OmegaEngine.Input.InputProvider
virtual void OnPerspectiveChange (Point pan, int rotation, int zoom)
 Raises all registered IInputReceiver.PerspectiveChanges. More...
 
virtual void OnAreaSelection (Rectangle area, bool accumulate, bool done=false)
 Raises all registered IInputReceiver.AreaSelections. More...
 
virtual void OnHover (Point target)
 Raises all registered IInputReceiver.Hovers. More...
 
virtual void OnClick (MouseEventArgs e, bool accumulate)
 Raises all registered IInputReceiver.Clicks. More...
 
virtual void OnDoubleClick (MouseEventArgs e)
 Raises all registered IInputReceiver.DoubleClicks. More...
 

Properties

bool InvertMouse [get, set]
 Invert the mouse axes. More...
 

Detailed Description

Processes mouse events into higher-level navigational commands.

Dragging with the left mouse button allows IInputReceiver.AreaSelection.

Dragging with the right mouse button allows panning.

Dragging with the middle mouse button allows rotating and zooming.

Clicks and double-clicks are passed through.

Constructor & Destructor Documentation

OmegaEngine.Input.MouseInputProvider.MouseInputProvider ( Control  control)
inline

Starts monitoring and processing mouse events receieved by a specififc control.

Parameters
controlThe control receiving the mouse events.

Member Data Documentation

const int OmegaEngine.Input.MouseInputProvider.ClickAccuracy = 10

The number of pixels the mouse may move while pressed to still be considered a click.

Property Documentation

bool OmegaEngine.Input.MouseInputProvider.InvertMouse
getset

Invert the mouse axes.


The documentation for this class was generated from the following file: