Table of Contents

Class GestureConfigComposite

Namespace
Stride.Input
Assembly
Stride.Input.dll

Configuration class for the Composite gesture.

public sealed class GestureConfigComposite : GestureConfig
Inheritance
GestureConfigComposite
Inherited Members

Remarks

A composite gesture is a transformation which is a composition of a translation, a rotation and a scale. It is performed by using two fingers and performing translation, scale and rotation motions.

A composite gesture can only be composed of 2 fingers. Trying to modify the RequiredNumberOfFingers field will throw an exception.

Constructors

GestureConfigComposite()

Create a default Rotation gesture configuration.

public GestureConfigComposite()

Properties

MinimumRotationAngle

The rotation angle (in radian) above which the gesture is started.

public float MinimumRotationAngle { get; set; }

Property Value

float

Remarks

The user can increase this value if he has small or no interest in the rotation component of the transformation. By doing so, he avoids triggering the Composite Gesture when only small rotation changes happen. On the contrary, the user can decrease this value if he wants to be immediately warned about the smallest change in rotation.

Exceptions

ArgumentOutOfRangeException

The angle has to be strictly positive.

InvalidOperationException

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

MinimumScaleValue

The scale value above which the gesture is started.

public float MinimumScaleValue { get; set; }

Property Value

float

Remarks

The user can increase this value if he has small or no interest in the scale component of the transformation. By doing so, he avoids triggering the Composite Gesture when only small scale changes happen. On the contrary, the user can decrease this value if he wants to be immediately warned about the smallest change in scale.

Exceptions

ArgumentOutOfRangeException

The value has to be greater or equal to 1.

InvalidOperationException

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

MinimumTranslationDistance

The translation distance above which the gesture is started.

public float MinimumTranslationDistance { get; set; }

Property Value

float

Remarks

The user can increase this value if he has small or no interest in the translation component of the transformation. By doing so, he avoids triggering the Composite Gesture when only small translation changes happen. On the contrary, the user can decrease this value if he wants to be immediately warned about the smallest change in translation.

Exceptions

ArgumentOutOfRangeException

The value has to be positive.

InvalidOperationException

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