Struct PluginPointerEvent

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

One pointer event on a canvas, in the canvas's own pixels from its top-left corner, y down, at whatever anchor, offset or interface scale the canvas is shown at.

public readonly record struct PluginPointerEvent : IEquatable<PluginPointerEvent>

Implements

IEquatable<PluginPointerEvent>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PluginPointerEvent(PluginPointerEventKind, PluginPoint, PluginPointerButton, PluginKeyModifiers, int)

One pointer event on a canvas, in the canvas's own pixels from its top-left corner, y down, at whatever anchor, offset or interface scale the canvas is shown at.

public PluginPointerEvent(PluginPointerEventKind Kind, PluginPoint Position, PluginPointerButton Button, PluginKeyModifiers Modifiers, int WheelDelta = 0)

Parameters

Kind PluginPointerEventKind

What the pointer did.

Position PluginPoint

Where, in the canvas's own pixels; outside the canvas's rectangle only during a drag.

Button PluginPointerButton

The button the event is about: the one pressed, released or held during a move; None for a wheel turn.

Modifiers PluginKeyModifiers

The modifier keys held at the time.

WheelDelta int

How far the wheel turned, in notches, positive away from the user; zero for everything but Wheel.

Properties

Button

The button the event is about: the one pressed, released or held during a move; None for a wheel turn.

public PluginPointerButton Button { get; init; }

Property Value

PluginPointerButton

Kind

What the pointer did.

public PluginPointerEventKind Kind { get; init; }

Property Value

PluginPointerEventKind

Modifiers

The modifier keys held at the time.

public PluginKeyModifiers Modifiers { get; init; }

Property Value

PluginKeyModifiers

Position

Where, in the canvas's own pixels; outside the canvas's rectangle only during a drag.

public PluginPoint Position { get; init; }

Property Value

PluginPoint

WheelDelta

How far the wheel turned, in notches, positive away from the user; zero for everything but Wheel.

public int WheelDelta { get; init; }

Property Value

int