Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    GestureConfigComposite Class

    Namespace: Stride.Input
    Assembly: Stride.Input.dll

    Configuration class for the Composite gesture.

    System.Object → GestureConfig → GestureConfigComposite
    Derived from GestureConfigComposite:

    public sealed class GestureConfigComposite : GestureConfig
    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.

    Name Description
    Constructors
    GestureConfigComposite()

    Create a default Rotation gesture configuration.

    Properties
    MinimumRotationAngle

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

    MinimumScaleValue

    The scale value above which the gesture is started.

    MinimumTranslationDistance

    The translation distance above which the gesture is started.

    | Improve this Doc View Source

    Constructors


    GestureConfigComposite()

    Create a default Rotation gesture configuration.

    public GestureConfigComposite()
    | Improve this Doc View Source

    Properties


    MinimumRotationAngle

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

    public float MinimumRotationAngle { get; set; }
    Property Value
    Type Description
    System.Single
    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
    Type Condition
    System.ArgumentOutOfRangeException

    The angle has to be strictly positive.

    System.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
    Type Description
    System.Single
    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
    Type Condition
    System.ArgumentOutOfRangeException

    The value has to be greater or equal to 1.

    System.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
    Type Description
    System.Single
    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
    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.


    Inherited Members

    GestureConfig.AssociatedGestureType
    GestureConfig.RequiredNumberOfFingers

    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation