Fork me on GitHub

Mouse Class

Summary

Mouse base class. To be implemented by specific system (ie. DirectX Mouse) This class is useful as you remain OS independent using this common interface.
Namespace
SharpInputSystem
Interfaces
  • IDisposable
Base Types
Derived Types
graph BT Type-->Base0["InputObject"] click Base0 "/sharpinputsystem/api/SharpInputSystem/InputObject" Base0-->Base1["object"] Type-.->Interface0["IDisposable"] Type["Mouse"] class Type type-node Derived0["SWFMouse"]-->Type click Derived0 "/sharpinputsystem/api/SharpInputSystem.SWF/SWFMouse"

Syntax

public abstract class Mouse : InputObject, IDisposable

Properties

Name Value Summary
Creator InputManager
Returns this input object's creator
Inherited from InputObject
DeviceID string
Not fully implemented yet
Inherited from InputObject
EventListener IMouseListener
Register/unregister a Mouse Listener - Only one allowed for simplicity. If broadcasting is neccessary, just broadcast from the callback you registered.
IsBuffered bool
Get buffered mode - true is buffered, false otherwise
Inherited from InputObject
IsDisposed bool
Inherited from InputObject
MouseState MouseState
Returns the state of the mouse - is valid for both buffered and non buffered mode
Type InputType
Get the type of device
Inherited from InputObject
Vendor string
Get the vender string name
Inherited from InputObject

Methods

Name Value Summary
~InputObject() void
Inherited from InputObject
Capture() void
Used for updating call once per frame before checking state or to update events
Inherited from InputObject
Dispose() void
Inherited from InputObject
Dispose(bool) void
Inherited from InputObject
QueryInterface<T>() IInputObjectInterface
Inherited from InputObject