Class MouseArgs

Arguments for the OnMouseMove(MouseArgs) method.

Inheritance
object
MouseArgs
Inherited Members
Namespace: Gorgon.Editor.Rendering
Assembly: Gorgon.Editor.API.dll
Syntax
public class MouseArgs

Properties

| Edit this page View Source

ButtonClickCount

Property to return the number of times a button has been clicked.

Declaration
public int ButtonClickCount { get; }
Property Value
Type Description
int
| Edit this page View Source

CameraSpacePosition

Property to return the mouse position in camera space.

Declaration
public Vector2 CameraSpacePosition { get; }
Property Value
Type Description
Vector2
Remarks

This returns the location of the mouse in relation to the transformed (i.e. panning and scaling applied) content render region, where 0x0 is the center of the screen.

| Edit this page View Source

ClientPosition

Property to return the mouse position in client space.

Declaration
public Point ClientPosition { get; }
Property Value
Type Description
Point
Remarks

This returns the location of the mouse in relation to the control.

| Edit this page View Source

Handled

Property to set or return whether the mouse event has been handled.

Declaration
public bool Handled { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

Modifiers

Property to return which modifier keys (CTRL, ALT, and Shift) are active during the mouse event.

Declaration
public Keys Modifiers { get; }
Property Value
Type Description
Keys
| Edit this page View Source

MouseButtons

Property to return which of the mouse buttons are held down (or released when the button is released).

Declaration
public MouseButtons MouseButtons { get; }
Property Value
Type Description
MouseButtons
| Edit this page View Source

MouseWheelDelta

Property to return the signed count of the number of detents the mouse wheel has rotated.

Declaration
public int MouseWheelDelta { get; }
Property Value
Type Description
int

Extension Methods