Class MouseInput

Namespace

Fantas.Input

Assembly

Fantas.dll

Mouse Input class

public static class MouseInput

Inheritance

object

MouseInput

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

AnyButtonPressed

True if any mouse button was just pressed

public static bool AnyButtonPressed { get; }

Property Value

bool

AnyButtonReleased

True if any mouse button was just released

public static bool AnyButtonReleased { get; }

Property Value

bool

Cursor

Current mouse cursor

public static Cursor Cursor { get; set; }

Property Value

Cursor

CursorPosition

Get last cursor position (in Scene coordinates)

public static PointF CursorPosition { get; }

Property Value

PointF

IsCursorVisible

Show/Hide the mouse cursor

public static bool IsCursorVisible { get; set; }

Property Value

bool

IsLeftButtonDown

Return true if the left mouse button is current pressed

public static bool IsLeftButtonDown { get; }

Property Value

bool

IsLeftButtonPressed

Return true if the left mouse button was just pressed

public static bool IsLeftButtonPressed { get; }

Property Value

bool

IsLeftButtonReleased

Return true if the left mouse button was just released

public static bool IsLeftButtonReleased { get; }

Property Value

bool

IsMiddleButtonDown

Return true if the middle mouse button is current pressed

public static bool IsMiddleButtonDown { get; }

Property Value

bool

IsMiddleButtonPressed

Return true if the middle mouse button was just pressed

public static bool IsMiddleButtonPressed { get; }

Property Value

bool

IsMiddleButtonReleased

Return true if the middle mouse button was just released

public static bool IsMiddleButtonReleased { get; }

Property Value

bool

IsNodeEventsEnabled

Enable/Disable mouse node events MouseEnter/MouseHover/MouseLeave/Click

public static bool IsNodeEventsEnabled { get; set; }

Property Value

bool

IsRightButtonDown

Return true if the right mouse button is current pressed

public static bool IsRightButtonDown { get; }

Property Value

bool

IsRightButtonPressed

Return true if the right mouse button was just pressed

public static bool IsRightButtonPressed { get; }

Property Value

bool

IsRightButtonReleased

Return true if the right mouse button was just released

public static bool IsRightButtonReleased { get; }

Property Value

bool

IsXButton1Down

Return true if the X1 mouse button is current pressed

public static bool IsXButton1Down { get; }

Property Value

bool

IsXButton1Pressed

Return true if the X1 mouse button was just pressed

public static bool IsXButton1Pressed { get; }

Property Value

bool

IsXButton1Released

Return true if the X1 mouse button was just released

public static bool IsXButton1Released { get; }

Property Value

bool

IsXButton2Down

Return true if the X2 mouse button is current pressed

public static bool IsXButton2Down { get; }

Property Value

bool

IsXButton2Pressed

Return true if the X2 mouse button was just pressed

public static bool IsXButton2Pressed { get; }

Property Value

bool

IsXButton2Released

Return true if the X2 mouse button was just released

public static bool IsXButton2Released { get; }

Property Value

bool

WheelDelta

Get last mouse wheel delta value

public static Vector2 WheelDelta { get; }

Property Value

Vector2

Methods

InvokeMouseDown(MouseButtons, PointF, int)

Invoke MouseDown event handlers

public static void InvokeMouseDown(MouseButtons button, PointF position, int clicks)

Parameters

button MouseButtons

position PointF

clicks int

InvokeMouseDrag(MouseButtons, PointF, int, Vector2)

Invoke Drag event handlers

public static void InvokeMouseDrag(MouseButtons button, PointF position, int clicks, Vector2 dragDelta)

Parameters

button MouseButtons

position PointF

clicks int

dragDelta Vector2

InvokeMouseMove(PointF)

Invoke MouseMove event handlers

public static void InvokeMouseMove(PointF position)

Parameters

position PointF

InvokeMouseUp(MouseButtons, PointF, int)

Invoke MouseUp event handlers

public static void InvokeMouseUp(MouseButtons button, PointF position, int clicks)

Parameters

button MouseButtons

position PointF

clicks int

InvokeMouseWheel(Vector2, PointF, bool)

Invoke MouseWheel event handlers

public static void InvokeMouseWheel(Vector2 delta, PointF position, bool hasPreciseScrollingDeltas)

Parameters

delta Vector2

position PointF

hasPreciseScrollingDeltas bool

PopCursor()

Restore the previous cursor

public static void PopCursor()

PushCursor(Cursor)

Set the new cursor and push the current one on the stack

public static void PushCursor(Cursor cursor)

Parameters

cursor Cursor