GestureConfigFlick Class
Namespace: Stride.InputAssembly: Stride.Input.dll
Configuration class for the Flick gesture.
public sealed class GestureConfigFlick : GestureConfig
Remarks
A Flick gesture can be composed of 1 or more fingers.
Name | Description | |
---|---|---|
Constructors | ||
GestureConfigFlick() | Create a default Flick gesture configuration for one finger free flicking. |
|
GestureConfigFlick(GestureShape) | Create a default gesture configuration for one finger flicking. |
|
Properties | ||
AllowedErrorMargins | The (x,y) error margins allowed during directional dragging. |
|
FlickShape | The shape of the flick gesture. |
|
MinimumAverageSpeed | The minimum average speed of the gesture to be detected as a flick. |
|
MinimumFlickLength | The minimum distance that the flick gesture has to cross from its origin to be detected has Flick. |
Constructors
GestureConfigFlick()
Create a default Flick gesture configuration for one finger free flicking.
public GestureConfigFlick()
GestureConfigFlick(GestureShape)
Create a default gesture configuration for one finger flicking.
public GestureConfigFlick(GestureShape flickShape)
Parameters
Type | Name | Description |
---|---|---|
GestureShape | flickShape | The shape of the flicking. |
Properties
AllowedErrorMargins
The (x,y) error margins allowed during directional dragging.
public Vector2 AllowedErrorMargins { get; set; }
Property Value
Type | Description |
---|---|
Vector2 |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Tried to modify the configuration after it has been frozen by the system. |
System.ArgumentOutOfRangeException | The provided x or y value was not positive. |
FlickShape
The shape of the flick gesture.
public GestureShape FlickShape { get; set; }
Property Value
Type | Description |
---|---|
GestureShape |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Tried to modify the configuration after it has been frozen by the system. |
MinimumAverageSpeed
The minimum average speed of the gesture to be detected as a flick.
public float MinimumAverageSpeed { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Exceptions
Type | Condition |
---|---|
System.ArgumentOutOfRangeException | The value must be positive |
System.InvalidOperationException | Tried to modify the configuration after it has been frozen by the system. |
MinimumFlickLength
The minimum distance that the flick gesture has to cross from its origin to be detected has Flick.
public float MinimumFlickLength { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Tried to modify the configuration after it has been frozen by the system. |