Class GestureOptions

Definition

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

This is a calss that sets the configuration options of Gestures

public sealed class GestureOptions
Inheritance
object
GestureOptions

Properties

View Source

Instance

Gets the singleton of the GestureOptions object.

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

Methods

View Source

SetDoubleTapTimeout(uint)

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
public void SetDoubleTapTimeout(uint ms)
Parameters
Type Name Description
uint ms

The time value in milliseconds
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetLongPressMinimumHoldingTime(uint)

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

Declaration
public void SetLongPressMinimumHoldingTime(uint time)
Parameters
Type Name Description
uint time

The time value in milliseconds
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureInterpolationTimeRange(int)

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

Declaration
public void SetPanGestureInterpolationTimeRange(int range)
Parameters
Type Name Description
int range

Time range in ms
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureMaximumPredictionAmount(uint)

Sets the upper bound of the prediction amount for clamping

Declaration
public void SetPanGestureMaximumPredictionAmount(uint amount)
Parameters
Type Name Description
uint amount

The prediction amount in milliseconds
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureMinimumDistance(int)

Sets the minimum distance required to start a pan event

Declaration
public void SetPanGestureMinimumDistance(int distance)
Parameters
Type Name Description
int distance

Distance in pixels
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureMinimumPanEvents(int)

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

Declaration
public void SetPanGestureMinimumPanEvents(int number)
Parameters
Type Name Description
int number

Number of touch events
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureMinimumPredictionAmount(uint)

Sets the lower bound of the prediction amount for clamping

Declaration
public void SetPanGestureMinimumPredictionAmount(uint amount)
Parameters
Type Name Description
uint amount

The prediction amount in milliseconds
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureMultitapSmoothingRange(int)

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

Declaration
public void SetPanGestureMultitapSmoothingRange(int range)
Parameters
Type Name Description
int range

Time in past in ms
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGesturePredictionAmount(uint)

Sets the prediction amount of the pan gesture

Declaration
public void SetPanGesturePredictionAmount(uint amount)
Parameters
Type Name Description
uint amount

The prediction amount in milliseconds
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGesturePredictionAmountAdjustment(uint)

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

Declaration
public void SetPanGesturePredictionAmountAdjustment(uint amount)
Parameters
Type Name Description
uint amount

The prediction amount in milliseconds
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGesturePredictionMode(int)

Sets the prediction mode for pan gestures

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

The prediction mode
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureScalarOnlyPredictionEnabled(bool)

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

Declaration
public void SetPanGestureScalarOnlyPredictionEnabled(bool enable)
Parameters
Type Name Description
bool enable

True = use scalar prediction only
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureSmoothingAmount(float)

Sets the smoothing amount of the pan gesture

Declaration
public void SetPanGestureSmoothingAmount(float amount)
Parameters
Type Name Description
float 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(int)

Called to set the prediction mode for pan gestures

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

The prediction mode
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureTwoPointAccelerationBias(float)

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

Declaration
public void SetPanGestureTwoPointAccelerationBias(float acceleration)
Parameters
Type Name Description
float 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(int)

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

Declaration
public void SetPanGestureTwoPointInterpolatePastTime(int time)
Parameters
Type Name Description
int time

Time in past in ms
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureTwoPointPredictionEnabled(bool)

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

Declaration
public void SetPanGestureTwoPointPredictionEnabled(bool enable)
Parameters
Type Name Description
bool enable

True = use two point prediction
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPanGestureTwoPointVelocityBias(float)

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

Declaration
public void SetPanGestureTwoPointVelocityBias(float velocity)
Parameters
Type Name Description
float 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(bool)

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

Declaration
public void SetPanGestureUseActualTimes(bool enable)
Parameters
Type Name Description
bool enable

True = use actual times, False = use perfect values
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPinchGestureMinimumDistance(int)

Sets the minimum distance required to start a pinch event

Declaration
public void SetPinchGestureMinimumDistance(int distance)
Parameters
Type Name Description
int distance

Distance in pixels
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPinchGestureMinimumTouchEvents(uint)

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

Declaration
public void SetPinchGestureMinimumTouchEvents(uint number)
Parameters
Type Name Description
uint number

The number of touch events
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetPinchGestureMinimumTouchEventsAfterStart(uint)

Sets the minimum touch events required after a pinch started

Declaration
public void SetPinchGestureMinimumTouchEventsAfterStart(uint number)
Parameters
Type Name Description
uint number

The number of touch events
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetRotationGestureMinimumTouchEvents(uint)

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

Declaration
public void SetRotationGestureMinimumTouchEvents(uint number)
Parameters
Type Name Description
uint number

The number of touch events
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetRotationGestureMinimumTouchEventsAfterStart(uint)

Sets the minimum touch events required after a rotation started

Declaration
public void SetRotationGestureMinimumTouchEventsAfterStart(uint number)
Parameters
Type Name Description
uint number

The number of touch events
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetTapMaximumMotionAllowedDistance(float)

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

Declaration
public void SetTapMaximumMotionAllowedDistance(float distance)
Parameters
Type Name Description
float distance

The distance
Remarks

This is a global configuration option. Affects all gestures.

View Source

SetTapRecognizerTime(uint)

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
public void SetTapRecognizerTime(uint ms)
Parameters
Type Name Description
uint ms

The time value in milliseconds
Remarks

This is a global configuration option. Affects all gestures.

Extension Methods