GestureConfigTap Class
Namespace: Stride.InputAssembly: Stride.Input.dll
Configuration class for the Tap gesture.
public sealed class GestureConfigTap : GestureConfig
Remarks
A tap gesture can be composed of 1 or more fingers.
Name | Description | |
---|---|---|
Constructors | ||
GestureConfigTap() | Create a default Tap gesture configuration for single touch and single finger detection. |
|
GestureConfigTap(Int32, Int32) | Create a default Tap gesture configuration for the given numbers of touches and fingers. |
|
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. |
|
MaximumPressTime | This value represents the maximum amount of time that the user can stay touching the screen before taking off its finger. |
|
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. |
|
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... |
Constructors
GestureConfigTap()
Create a default Tap gesture configuration for single touch and single finger detection.
public GestureConfigTap()
GestureConfigTap(Int32, Int32)
Create a default Tap gesture configuration for the given numbers of touches and fingers.
public GestureConfigTap(int numberOfTap, int numberOfFingers)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | numberOfTap | The number of taps required |
System.Int32 | numberOfFingers | 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
Type | Description |
---|---|
System.Single |
Exceptions
Type | Condition |
---|---|
System.ArgumentOutOfRangeException | The value has to be positive. |
System.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
Type | Description |
---|---|
System.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
Type | Description |
---|---|
System.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
Type | Description |
---|---|
System.Int32 |
Remarks
This value is strictly positive.
Exceptions
Type | Condition |
---|---|
System.ArgumentOutOfRangeException | The given value is not greater or equal to 1. |
System.InvalidOperationException | Tried to modify the configuration after it has been frozen by the system. |