Class GestureOptions

Definition

Namespace:
Tizen.NUI
Assembly:
Tizen.NUI.dll

This is a calss that sets the configuration options of Gestures

C#
Copy
public sealed class GestureOptions : object
Inheritance
GestureOptions

Properties

View Source

Instance

Gets the singleton of the GestureOptions object.

Declaration
C#
Copy
public static GestureOptions Instance { get; }
Property Value
Type Description
GestureOptions

Methods

View Source

SetDoubleTapTimeout(UInt32)

Sets the duration in milliseconds the duration time for recognizing multi-tap gesture. If there are two taps within this time, it is a double tap.

Declaration
C#
Copy
public void SetDoubleTapTimeout(uint ms)
Parameters
Type Name Description
UInt32 ms

The time value in milliseconds

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetLongPressMinimumHoldingTime(UInt32)

Sets the minimum holding time required to be recognized as a long press gesture

Declaration
C#
Copy
public void SetLongPressMinimumHoldingTime(uint time)
Parameters
Type Name Description
UInt32 time

The time value in milliseconds

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureInterpolationTimeRange(Int32)

Sets the interpolation time range (ms) of past points to use (with weights) when interpolating.

Declaration
C#
Copy
public void SetPanGestureInterpolationTimeRange(int range)
Parameters
Type Name Description
Int32 range

Time range in ms

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureMaximumPredictionAmount(UInt32)

Sets the upper bound of the prediction amount for clamping

Declaration
C#
Copy
public void SetPanGestureMaximumPredictionAmount(uint amount)
Parameters
Type Name Description
UInt32 amount

The prediction amount in milliseconds

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureMinimumDistance(Int32)

Sets the minimum distance required to start a pan event

Declaration
C#
Copy
public void SetPanGestureMinimumDistance(int distance)
Parameters
Type Name Description
Int32 distance

Distance in pixels

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureMinimumPanEvents(Int32)

Sets the minimum number of touch events required to start a pan

Declaration
C#
Copy
public void SetPanGestureMinimumPanEvents(int number)
Parameters
Type Name Description
Int32 number

Number of touch events

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureMinimumPredictionAmount(UInt32)

Sets the lower bound of the prediction amount for clamping

Declaration
C#
Copy
public void SetPanGestureMinimumPredictionAmount(uint amount)
Parameters
Type Name Description
UInt32 amount

The prediction amount in milliseconds

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureMultitapSmoothingRange(Int32)

Sets the range of time (ms) of points in the history to perform multitap smoothing with (if enabled).

Declaration
C#
Copy
public void SetPanGestureMultitapSmoothingRange(int range)
Parameters
Type Name Description
Int32 range

Time in past in ms

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGesturePredictionAmount(UInt32)

Sets the prediction amount of the pan gesture

Declaration
C#
Copy
public void SetPanGesturePredictionAmount(uint amount)
Parameters
Type Name Description
UInt32 amount

The prediction amount in milliseconds

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGesturePredictionAmountAdjustment(UInt32)

Sets the amount of prediction interpolation to adjust when the pan velocity is changed

Declaration
C#
Copy
public void SetPanGesturePredictionAmountAdjustment(uint amount)
Parameters
Type Name Description
UInt32 amount

The prediction amount in milliseconds

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGesturePredictionMode(Int32)

Sets the prediction mode for pan gestures

  • 0 - No prediction
  • 1 - Prediction using average acceleration
Declaration
C#
Copy
public void SetPanGesturePredictionMode(int mode)
Parameters
Type Name Description
Int32 mode

The prediction mode

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureScalarOnlyPredictionEnabled(Boolean)

Sets whether to use scalar only prediction, which when enabled, ignores acceleration.

Declaration
C#
Copy
public void SetPanGestureScalarOnlyPredictionEnabled(bool enable)
Parameters
Type Name Description
Boolean enable

True = use scalar prediction only

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureSmoothingAmount(Single)

Sets the smoothing amount of the pan gesture

Declaration
C#
Copy
public void SetPanGestureSmoothingAmount(float amount)
Parameters
Type Name Description
Single amount

The smotthing amount from 0.0f (none) to 1.0f (full)

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureSmoothingMode(Int32)

Called to set the prediction mode for pan gestures

  • Valid modes:
  • 0 - No smoothing
  • 1 - average between last 2 values
Declaration
C#
Copy
public void SetPanGestureSmoothingMode(int mode)
Parameters
Type Name Description
Int32 mode

The prediction mode

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureTwoPointAccelerationBias(Single)

Sets the two point acceleration bias. This is the ratio of first and second points to use for acceleration.

Declaration
C#
Copy
public void SetPanGestureTwoPointAccelerationBias(float acceleration)
Parameters
Type Name Description
Single acceleration

0.0f = 100% first point. 1.0f = 100% of second point.

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureTwoPointInterpolatePastTime(Int32)

Sets the time in the past to interpolate the second point when using two point interpolation.

Declaration
C#
Copy
public void SetPanGestureTwoPointInterpolatePastTime(int time)
Parameters
Type Name Description
Int32 time

Time in past in ms

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureTwoPointPredictionEnabled(Boolean)

Sets whether to use two point prediction. This combines two interpolated points to get more steady acceleration and velocity values.

Declaration
C#
Copy
public void SetPanGestureTwoPointPredictionEnabled(bool enable)
Parameters
Type Name Description
Boolean enable

True = use two point prediction

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureTwoPointVelocityBias(Single)

Sets the two point velocity bias. This is the ratio of first and second points to use for velocity.

Declaration
C#
Copy
public void SetPanGestureTwoPointVelocityBias(float velocity)
Parameters
Type Name Description
Single velocity

0.0f = 100% first point. 1.0f = 100% of second point.

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureUseActualTimes(Boolean)

Sets whether to use actual times of the real gesture and frames or not.

Declaration
C#
Copy
public void SetPanGestureUseActualTimes(bool enable)
Parameters
Type Name Description
Boolean enable

True = use actual times, False = use perfect values

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPinchGestureMinimumDistance(Int32)

Sets the minimum distance required to start a pinch event

Declaration
C#
Copy
public void SetPinchGestureMinimumDistance(int distance)
Parameters
Type Name Description
Int32 distance

Distance in pixels

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPinchGestureMinimumTouchEvents(UInt32)

Sets the minimum touch events required before a pinch can be started

Declaration
C#
Copy
public void SetPinchGestureMinimumTouchEvents(uint number)
Parameters
Type Name Description
UInt32 number

The number of touch events

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPinchGestureMinimumTouchEventsAfterStart(UInt32)

Sets the minimum touch events required after a pinch started

Declaration
C#
Copy
public void SetPinchGestureMinimumTouchEventsAfterStart(uint number)
Parameters
Type Name Description
UInt32 number

The number of touch events

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetRotationGestureMinimumTouchEvents(UInt32)

Sets the minimum touch events required before a rotation can be started

Declaration
C#
Copy
public void SetRotationGestureMinimumTouchEvents(uint number)
Parameters
Type Name Description
UInt32 number

The number of touch events

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetRotationGestureMinimumTouchEventsAfterStart(UInt32)

Sets the minimum touch events required after a rotation started

Declaration
C#
Copy
public void SetRotationGestureMinimumTouchEventsAfterStart(uint number)
Parameters
Type Name Description
UInt32 number

The number of touch events

Remarks

This is a global configuration option. Affects all gestures.

View Source

SetTapRecognizerTime(UInt32)

Sets the recognizer time required to be recognized as a tap gesture, This time is from touch down to touch up to recognize the tap gesture. If the time between touch down and touch up is longer than recognizer time, it is not recognized as a tap gesture.

Declaration
C#
Copy
public void SetTapRecognizerTime(uint ms)
Parameters
Type Name Description
UInt32 ms

The time value in milliseconds

Remarks

This is a global configuration option. Affects all gestures.

Extension Methods