Xenko基础API笔记2-手势

Posted 2020-08-06 晓风.NET

交互：

Drag Gesture

Type : Continuous

Configuration class: GestureConfigDrag

Event class: GestureEventDrag

Action description:The user touched the screen, performed a translation and withdraw its finger(s).

Comments: The number of finger on the screen cannot vary during the gesture. The programmer can modify the MinimumDragDistance field if he need the gesture to be triggered for smaller drags.

配置类:GestureConfigDrag
事件类:GestureEventDrag
动作描述:用户触摸屏幕时,进行了翻译和撤回手指(s)。
评论:手指在屏幕上的数量不能改变姿态。程序员可以修改MinimumDragDistance字段如果他需要被触发的动作小拖。

Flick Gesture

Type : Discrete

Configuration class: GestureConfigFlick

Event class: GestureEventFlick

Action description:The user touched the screen, performed a quick straight translation and withdraw its finger(s).

Comments: The number of finger on the screen cannot vary during the gesture. The programmer can modify the MinimumFlickLength field to constrain the flick to have a minimum length.

类型:离散
配置类:GestureConfigFlick
事件类:GestureEventFlick
动作描述:用户触摸屏幕时,执行一个快速直接翻译和撤回手指(s)。
评论:手指在屏幕上的数量不能改变姿态。程序员可以修改MinimumFlickLength字段来限制有一个最小长度的电影。

 

Long Press Gesture

Type : Discrete

Configuration class: GestureConfigLongPress

Event class: GestureEventLongPress

Action description:The user touched the screen, and maintained the pressure without moving during a given time (default about 1 second).

Comments: The number of finger on the screen cannot vary during the gesture. The programmer can modify the RequiredPressTime field to change the press time.

长按手势
类型:离散
配置类:GestureConfigLongPress
事件类:GestureEventLongPress
动作描述:用户触摸屏幕,保持不动的压力在一个给定的时间(默认约1秒)。
评论:手指在屏幕上的数量不能改变姿态。程序员可以修改RequiredPressTime字段改变新闻时间。

 

Composite Gesture

Type : Continuous

Configuration class: GestureConfigComposite

Event class: GestureEventComposite

Action description:The user touched the screen with two fingers, and moved them independently.

Comments: This gesture is a composition the 3 basic transformations translation, scale, rotation. It requires exactly 2 fingers on the screen. The gesture is triggered when the system detect a small translation, scale or rotation. To perform a translation, the user translates uniformly the two fingers together. To perform a scale, the user moves closer or further the two fingers from each other. To perform a rotation, the user turns the two fingers around there their middle.

复合动作
类型:连续
配置类:GestureConfigComposite
事件类:GestureEventComposite
动作描述:用户用两个手指触摸屏幕,并独立地移动。
评论:这个手势是三个基本成分转换翻译,规模、旋转。它需要2根手指在屏幕上。触发手势当系统检测到一个小翻译,规模或旋转。进行翻译时,用户将统一在一起的两根手指。执行规模、用户移动接近或进一步的两根手指。执行一个旋转,用户就那里的两个手指在他们的中间。

 

Tap Gesture

Type : Discrete

Configuration class: GestureConfigTap

Event class: GestureEventTap

Action description:The user touched the screen, and removed its fingers quickly without moving.

Comments: The number of finger on the screen cannot vary during the gesture.The programmer can modify the RequiredNumberOfTaps field to decide the number tap that he wants to detect. Note that to be able to distinguish single taps from multi-tap taps, the system has to wait a given time and thus introduces latency in tap events. If the programmer is interested only in single taps, he can put the MaximumTimeBetweenTaps field to 0 to avoid this latency.

点击手势
类型:离散
配置类:GestureConfigTap
事件类:GestureEventTap
动作描述:用户触摸屏幕,并删除其手指快速不动。
评论:手指在屏幕上的数量不能改变姿态。程序员可以修改RequiredNumberOfTaps字段决定利用他想检测数量。注意,能够区分单从转接插座水龙头水龙头,系统必须等待一个给定的时间,因此介绍了延时水龙头事件。如果程序员只对单一的水龙头感兴趣,他可以把MaximumTimeBetweenTaps字段为0来避免这种延迟。

 

Usage

By default, the input system does not recognize any Gesture. To start (resp. stop) some gesture recognition the programmer has to add (resp. remove) gesture configurations to the @‘SiliconStudio.Xenko.Input.ActivatedGestures‘ collection. Once a gesture is activated for recognition, its associated configuration is frozen and the user cannot modify it any more. If the user wants to stop all gesture recognition he can directly clear the collection.

Code: Activate/Desactivate Gestures Recognitions

var singleTapConfig = new GestureConfigTap(); // create the configuration of the gesture we want to recognize
Input.ActivatedGestures.Add(singleTapConfig); // start the tap gesture recognition

var doubleTapConfig = new GestureConfigTap(2, 1); // create the configuration of the gesture we want to recognize
Input.ActivatedGestures.Add(doubleTapConfig ); // start the double tap gesture recognition

 // ...

Input.ActivatedGestures.Remove(singleTapConfig); // stop the tap gesture recognition

// ...
Input.ActivatedGestures.Clear(); // stop all remaining gesture recognitions

Each configuration class has a parameterless constructor corresponding to the default gesture configuration. Special constructors have also been implemented for parameters that the programmer may modify frequently. Other parameters correspond to fields that are not recommended to modify to keep a good coherency of the system. Those fields can be modified by accessing the corresponding properties.

Code: Set gesture configuration

var singleTapConfig = new GestureConfigTap(); // default config for the gesture.
var doubleTapConfig = new GestureConfigTap(2, 2); // personalize the gesture config by using the dedicated constructor
var noLatencyTap = new GestureConfigTap() { MaximumTimeBetweenTaps= TimeSpan.Zero }; // personalize the gesture config by directly accessing the desired property (user must be aware of was he does, this may break the input system coherency in some cases)

The programmer can access the recognized gestures via the @‘SiliconStudio.Xenko.Input.IInputManager.GestureEvents‘ collections. The collection is automatically cleared every frame.

Code: Access Gesture events

var currentFrameGestureEvents = Input.GestureEvents;

One can use the Type field to identity the gesture type and then cast it to the appropriate event type to have extra info about the event.

Code: Identifying the gesture type

foreach( var gestureEvent in Input.GestureEvents)
{
       if (gestureEvent.Type != GestureType.Tap) // determine if the event is from a tap gesture
        continue;

    GestureEventTap  tapEvent = (GestureEventTap) gestureEvent; // cast the event the specific tap event class
    log.Info("Tap position: {0}.", tapEvent.TapPosition); // access tap event specific field
}

One can know the gesture state by analyzing the @‘ SiliconStudio.Xenko.Input.GestureEvent.State‘ field.

Code: Identifying the event state

switch(compositeGestureEvent.State)
{
case GestureState.Began:
    image.ComputePreview();
    break;
case GestureState.Changed:
    image.TransformPreview(compositeGestureEvent.TotalScale, compositionGestureEvent.TotalRotation);
    break;
case GestureState.Ended:
    image.TransformRealImage(compositeGestureEvent.TotalScale, compositionGestureEvent.TotalRotation);
    break;
default:
    break;
}