GH_CanvasMouseEvent

Class used in Canvas UI events.

Constructors

public GH_CanvasMouseEvent()

Blank constructor.

public GH_CanvasMouseEvent(GH_Viewport vp, MouseEventArgs e_args)

Constructor.

Parameters:

vp (GH_Viewport)	The current canvas viewport state.
e_args (MouseEventArgs)	Original mouse event args.

public GH_CanvasMouseEvent(Point pt_control, PointF pt_canvas, MouseButtons mButton, int iClicks = 0, int iDelta = 0)

Constructor.

Parameters:

pt_control (Point)	Cursor location in control pixel coordinates.
pt_canvas (PointF)	Cursor location in canvas unit coordinates.
mButton (MouseButtons)	Currently pressed mouse buttons.
iClicks (int = 0)	Number of times the buttons were pressed and released.
iDelta (int = 0)	A signed count of the number of detents the mouse wheel has rotated.

public MouseButtons Button { get; }

Gets which mouse button was pressed.

public PointF CanvasLocation { get; }

Gets the location of the cursor in canvas unit coordinates.

public float CanvasX { get; }

Gets the x-coordinate of the cursor location in canvas unit coordinates.

public float CanvasY { get; }

Gets the y-coordinate of the cursor location in canvas unit coordinates.

public int Clicks { get; }

Gets the number of times the mouse button was pressed and released.

public Point ControlLocation { get; }

Gets the location of the cursor in control pixel coordinates.

public int ControlX { get; }

Gets the x-coordinate of the cursor location in control pixel coordinates.

public int ControlY { get; }

Gets the y-coordinate of the cursor location in control pixel coordinates.

public int Delta { get; }

Gets a signed count of the number of detents the mouse wheel has rotated. A detent is one notch of the mouse wheel.

public MouseEventArgs WinFormsEventArgs { get; }

Downcast this data into a Windows.Forms.MouseEventArgs instance.