Skip to main content

PointerPointProperties Struct

Definition​

Namespace:Avalonia.Input
Assembly:Avalonia.Base
Package:Avalonia
Source:PointerPoint.cs

Describes the state of a pointer device when it generated a specific input.

public struct PointerPointProperties

Inheritance: ValueType -> PointerPointProperties

Implements: IEquatable<PointerPointProperties>

Constructors​

NameDescription
PointerPointProperties (4 overloads)No summary available.

PointerPointProperties overloads​

PointerPointProperties Constructor​

public PointerPointProperties()

PointerPointProperties Constructor​

public PointerPointProperties(Avalonia.Input.RawInputModifiers modifiers, Avalonia.Input.PointerUpdateKind kind)
Parameters​

modifiers Avalonia.Input.RawInputModifiers

kind Avalonia.Input.PointerUpdateKind

PointerPointProperties Constructor​

public PointerPointProperties(Avalonia.Input.RawInputModifiers modifiers, Avalonia.Input.PointerUpdateKind kind, float twist, float pressure, float xTilt, float yTilt)
Parameters​

modifiers Avalonia.Input.RawInputModifiers

kind Avalonia.Input.PointerUpdateKind

twist float

pressure float

xTilt float

yTilt float

PointerPointProperties Constructor​

public PointerPointProperties(Avalonia.Input.RawInputModifiers modifiers, Avalonia.Input.PointerUpdateKind kind, float twist, float pressure, float xTilt, float yTilt, Avalonia.Rect contactRect)
Parameters​

modifiers Avalonia.Input.RawInputModifiers

kind Avalonia.Input.PointerUpdateKind

twist float

pressure float

xTilt float

yTilt float

contactRect Avalonia.Rect

Methods​

NameDescription
Equals (2 overloads)No summary available.
GetHashCodeNo summary available.
ToStringNo summary available.

Equals overloads​

Equals Method​

public bool Equals(Avalonia.Input.PointerPointProperties other)
Parameters​

other Avalonia.Input.PointerPointProperties

Returns​

bool

Equals Method​

public bool Equals(object obj)
Parameters​

obj object

Returns​

bool

GetHashCode Method​

public int GetHashCode()

Returns​

int

ToString Method​

public string ToString()

Returns​

string

Properties​

NameDescription
ContactRectGets the bounding rectangle of the contact area (typically from touch input).
IsBarrelButtonPressedGets whether the barrel button of the pen/stylus device was pressed when this input occurred.
IsEraserGets whether the input was generated by the use of a pen eraser.
IsInvertedGets whether the input was generated by an inverted digitizer pen.
IsLeftButtonPressedGets whether the device's primary action (e.g. Avalonia.Input.MouseButton.Left) was active when this input occurred.
IsMiddleButtonPressedGets whether the device's tertiary action (e.g. Avalonia.Input.MouseButton.Middle) was active when this input occurred.
IsRightButtonPressedGets whether the device's secondary action (e.g. Avalonia.Input.MouseButton.Right) was active when this input occurred.
IsXButton1PressedGets whether the device's first extended action (e.g. Avalonia.Input.MouseButton.XButton1) was active when this input occurred.
IsXButton2PressedGets whether the device's second extended action (e.g. Avalonia.Input.MouseButton.XButton2) was active when this input occurred.
NoneNo summary available.
PointerUpdateKindGets the state change that triggered this input. This is typically a button press or release.
PressureGets the force that the pointer device (typically a pen/stylus) was exerting on the surface of the digitizer when this input occurred.
TwistGets the clockwise rotation in degrees of the pen around its own major axis (such as when the user spins the pen in their fingers) when this input occurred.
XTiltGets how many degrees of rotation the pen/stylus was tilted left (negative values) or right (positive values) when this input occurred.
YTiltGets how many degrees of rotation the pen/stylus was tilted up (negative values) or down (positive values) when this input occurred.

ContactRect Property​

Gets the bounding rectangle of the contact area (typically from touch input).

public Avalonia.Rect ContactRect { get; set; }

IsBarrelButtonPressed Property​

Gets whether the barrel button of the pen/stylus device was pressed when this input occurred.

public bool IsBarrelButtonPressed { get; set; }

IsEraser Property​

Gets whether the input was generated by the use of a pen eraser.

public bool IsEraser { get; set; }

IsInverted Property​

Gets whether the input was generated by an inverted digitizer pen.

public bool IsInverted { get; set; }

IsLeftButtonPressed Property​

Gets whether the device's primary action (e.g. Avalonia.Input.MouseButton.Left) was active when this input occurred.

public bool IsLeftButtonPressed { get; set; }

IsMiddleButtonPressed Property​

Gets whether the device's tertiary action (e.g. Avalonia.Input.MouseButton.Middle) was active when this input occurred.

public bool IsMiddleButtonPressed { get; set; }

IsRightButtonPressed Property​

Gets whether the device's secondary action (e.g. Avalonia.Input.MouseButton.Right) was active when this input occurred.

public bool IsRightButtonPressed { get; set; }

IsXButton1Pressed Property​

Gets whether the device's first extended action (e.g. Avalonia.Input.MouseButton.XButton1) was active when this input occurred.

public bool IsXButton1Pressed { get; set; }

IsXButton2Pressed Property​

Gets whether the device's second extended action (e.g. Avalonia.Input.MouseButton.XButton2) was active when this input occurred.

public bool IsXButton2Pressed { get; set; }

None Property​

public Avalonia.Input.PointerPointProperties None { get; set; }

PointerUpdateKind Property​

Gets the state change that triggered this input. This is typically a button press or release.

public Avalonia.Input.PointerUpdateKind PointerUpdateKind { get; set; }

Pressure Property​

Gets the force that the pointer device (typically a pen/stylus) was exerting on the surface of the digitizer when this input occurred.

public float Pressure { get; set; }

Returns​

A value from 0 to 1.0. The default value is 0.5.

Twist Property​

Gets the clockwise rotation in degrees of the pen around its own major axis (such as when the user spins the pen in their fingers) when this input occurred.

public float Twist { get; set; }

Returns​

A value between 0.0 and 359.0 in degrees of rotation. The default value is 0.0.

XTilt Property​

Gets how many degrees of rotation the pen/stylus was tilted left (negative values) or right (positive values) when this input occurred.

public float XTilt { get; set; }

YTilt Property​

Gets how many degrees of rotation the pen/stylus was tilted up (negative values) or down (positive values) when this input occurred.

public float YTilt { get; set; }

On this page