Class GestureConfigTap

Namespace

Stride.Input

Assembly

Stride.Input.dll

Configuration class for the Tap gesture.

public sealed class GestureConfigTap : GestureConfig

Inheritance

object

GestureConfig

GestureConfigTap

Inherited Members

GestureConfig.AssociatedGestureType

GestureConfig.RequiredNumberOfFingers

Remarks

A tap gesture can be composed of 1 or more fingers.

Constructors

GestureConfigTap()

Create a default Tap gesture configuration for single touch and single finger detection.

public GestureConfigTap()

GestureConfigTap(int, int)

Create a default Tap gesture configuration for the given numbers of touches and fingers.

public GestureConfigTap(int numberOfTap, int numberOfFingers)

Parameters

numberOfTap int

The number of taps required

numberOfFingers int

The number of fingers required

Properties

MaximumDistanceTaps

The value represents the maximum distance that can separate two touches of the same finger during the gesture. By reducing this value, the system will tend to detect multi-touch gesture has several single touch gesture. By increasing this value, the system will tend to regroup distant single touch gestures into a multi-touch gesture.

public float MaximumDistanceTaps { get; set; }

Property Value

float

Exceptions

ArgumentOutOfRangeException

The value has to be positive.

InvalidOperationException

Tried to modify the configuration after it has been frozen by the system.

MaximumPressTime

This value represents the maximum amount of time that the user can stay touching the screen before taking off its finger.

public TimeSpan MaximumPressTime { get; set; }

Property Value

TimeSpan

MaximumTimeBetweenTaps

This value represents the maximum interval of time that can separate two touches of a same gesture. By reducing this value, the system will tend to detect multi-touch gesture has several single touch gesture. By increasing this value, the system will tend to regroup distant (in time) single touch gestures into a multi-touch gesture.

public TimeSpan MaximumTimeBetweenTaps { get; set; }

Property Value

TimeSpan

RequiredNumberOfTaps

This value represents the required number of successive user touches to trigger the gesture. For example: 1 for single touch, 2 for double touch, and so on...

public int RequiredNumberOfTaps { get; set; }

Property Value

int

Remarks

This value is strictly positive.

Exceptions

ArgumentOutOfRangeException

The given value is not greater or equal to 1.

InvalidOperationException

Tried to modify the configuration after it has been frozen by the system.