Struct PointerPointProperties

Namespace

Avalonia.Input

Assembly

Avalonia.Base.dll

Provides extended properties for a PointerPoint object.

public struct PointerPointProperties : IEquatable<PointerPointProperties>

Implements

IEquatable<PointerPointProperties>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

PointerPointProperties()

public PointerPointProperties()

PointerPointProperties(RawInputModifiers, PointerUpdateKind)

public PointerPointProperties(RawInputModifiers modifiers, PointerUpdateKind kind)

Parameters

modifiers RawInputModifiers

kind PointerUpdateKind

PointerPointProperties(RawInputModifiers, PointerUpdateKind, float, float, float, float)

public PointerPointProperties(RawInputModifiers modifiers, PointerUpdateKind kind, float twist, float pressure, float xTilt, float yTilt)

Parameters

modifiers RawInputModifiers

kind PointerUpdateKind

twist float

pressure float

xTilt float

yTilt float

PointerPointProperties(RawInputModifiers, PointerUpdateKind, float, float, float, float, Rect)

public PointerPointProperties(RawInputModifiers modifiers, PointerUpdateKind kind, float twist, float pressure, float xTilt, float yTilt, Rect contactRect)

Parameters

modifiers RawInputModifiers

kind PointerUpdateKind

twist float

pressure float

xTilt float

yTilt float

contactRect Rect

Properties

ContactRect

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

public readonly Rect ContactRect { get; }

Property Value

Rect

IsBarrelButtonPressed

Gets a value that indicates whether the barrel button of the pen/stylus device is pressed.

public readonly bool IsBarrelButtonPressed { get; }

Property Value

bool

IsEraser

Gets a value that indicates whether the input is from a pen eraser.

public readonly bool IsEraser { get; }

Property Value

bool

IsInverted

Gets a value that indicates whether the digitizer pen is inverted.

public readonly bool IsInverted { get; }

Property Value

bool

IsLeftButtonPressed

Gets a value that indicates whether the pointer input was triggered by the primary action mode of an input device.

public readonly bool IsLeftButtonPressed { get; }

Property Value

bool

IsMiddleButtonPressed

Gets a value that indicates whether the pointer input was triggered by the tertiary action mode of an input device.

public readonly bool IsMiddleButtonPressed { get; }

Property Value

bool

IsRightButtonPressed

Gets a value that indicates whether the pointer input was triggered by the secondary action mode (if supported) of an input device.

public readonly bool IsRightButtonPressed { get; }

Property Value

bool

IsXButton1Pressed

Gets a value that indicates whether the pointer input was triggered by the first extended mouse button (XButton1).

public readonly bool IsXButton1Pressed { get; }

Property Value

bool

IsXButton2Pressed

Gets a value that indicates whether the pointer input was triggered by the second extended mouse button (XButton2).

public readonly bool IsXButton2Pressed { get; }

Property Value

bool

None

public static PointerPointProperties None { get; }

Property Value

PointerPointProperties

PointerUpdateKind

Gets the kind of pointer state change.

public readonly PointerUpdateKind PointerUpdateKind { get; }

Property Value

PointerUpdateKind

Pressure

Gets a value that indicates the force that the pointer device (typically a pen/stylus) exerts on the surface of the digitizer.

public readonly float Pressure { get; }

Property Value

float

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

Twist

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

public readonly float Twist { get; }

Property Value

float

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

XTilt

Gets the plane angle between the Y-Z plane and the plane that contains the Y axis and the axis of the input device (typically a pen/stylus).

public readonly float XTilt { get; }

Property Value

float

The value is 0.0 when the finger or pen is perpendicular to the digitizer surface, between 0.0 and 90.0 when tilted to the right of perpendicular, and between 0.0 and -90.0 when tilted to the left of perpendicular. The default value is 0.0.

YTilt

Gets the plane angle between the X-Z plane and the plane that contains the X axis and the axis of the input device (typically a pen/stylus).

public readonly float YTilt { get; }

Property Value

float

The value is 0.0 when the finger or pen is perpendicular to the digitizer surface, between 0.0 and 90.0 when tilted towards the user, and between 0.0 and -90.0 when tilted away from the user. The default value is 0.0.

Methods

Equals(PointerPointProperties)

public readonly bool Equals(PointerPointProperties other)

Parameters

other PointerPointProperties

Returns

bool

Equals(object)

public override readonly bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override readonly int GetHashCode()

Returns

int

ToString()

public override readonly string ToString()

Returns

string

Operators

operator ==(PointerPointProperties, PointerPointProperties)

public static bool operator ==(PointerPointProperties left, PointerPointProperties right)

Parameters

left PointerPointProperties

right PointerPointProperties

Returns

bool

operator !=(PointerPointProperties, PointerPointProperties)

public static bool operator !=(PointerPointProperties left, PointerPointProperties right)

Parameters

left PointerPointProperties

right PointerPointProperties

Returns

bool