com.mapbox.android.gestures

Class MultiFingerGesture<L>

java.lang.Object

com.mapbox.android.gestures.BaseGesture<L>

com.mapbox.android.gestures.MultiFingerGesture<L>

Type Parameters:

L - listener that will be called with gesture events/updates.

Direct Known Subclasses:

MultiFingerTapGestureDetector, ProgressiveGesture

public abstract class MultiFingerGesture<L>
extends BaseGesture<L>

Base class for all multi finger gesture detectors.

Field Summary

Fields inherited from class com.mapbox.android.gestures.BaseGesture

context, listener, windowManager

Constructor Summary

Constructors

Constructor and Description
MultiFingerGesture(android.content.Context context, AndroidGesturesManager gesturesManager)

Method Summary

Modifier and Type	Method and Description
protected boolean	analyzeEvent(android.view.MotionEvent motionEvent)
protected boolean	analyzeMovement()
protected boolean	canExecute(int invokedGestureType)
float	getCurrentSpan(int firstPointerIndex, int secondPointerIndex) Returns the current distance between the two pointers forming the gesture in progress.
float	getCurrentSpanX(int firstPointerIndex, int secondPointerIndex) Returns current X distance between pointers in pixels.
float	getCurrentSpanY(int firstPointerIndex, int secondPointerIndex) Returns current Y distance between pointers in pixels.
android.graphics.PointF	getFocalPoint() Returns a center point of this gesture.
int	getPointersCount() Returns the number of active pointers.
float	getPreviousSpan(int firstPointerIndex, int secondPointerIndex) Returns the previous distance between the two pointers forming the gesture in progress.
float	getPreviousSpanX(int firstPointerIndex, int secondPointerIndex) Returns previous X distance between pointers in pixels.
float	getPreviousSpanY(int firstPointerIndex, int secondPointerIndex) Returns previous Y distance between pointers in pixels.
protected int	getRequiredPointersCount()
float	getSpanThreshold() Get minimum span between any pair of finger that is required to pass motion events to this detector.
protected boolean	isSloppyGesture() Check if we have a sloppy gesture.
protected void	reset()
void	setSpanThreshold(float spanThreshold) Set minimum span in pixels between any pair of finger that is required to pass motion events to this detector.
void	setSpanThresholdResource(int spanThresholdDimen) Set minimum span in dp between any pair of finger that is required to pass motion events to this detector.

Methods inherited from class com.mapbox.android.gestures.BaseGesture

getCurrentEvent, getGestureDuration, getPreviousEvent, isEnabled, onTouchEvent, removeListener, setEnabled, setListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultiFingerGesture

public MultiFingerGesture(android.content.Context context,
                          AndroidGesturesManager gesturesManager)

Method Detail

analyzeEvent

protected boolean analyzeEvent(android.view.MotionEvent motionEvent)

Specified by:

analyzeEvent in class BaseGesture<L>

getRequiredPointersCount

protected int getRequiredPointersCount()

analyzeMovement

protected boolean analyzeMovement()

isSloppyGesture

protected boolean isSloppyGesture()

Check if we have a sloppy gesture. Sloppy gestures can happen if the edge of the user's hand is touching the screen, for example.

Thanks to Almer Thie (code.almeros.com).

Returns:

true if we detect sloppy gesture, false otherwise

canExecute

protected boolean canExecute(int invokedGestureType)

Overrides:

canExecute in class BaseGesture<L>

reset

protected void reset()

getCurrentSpan

public float getCurrentSpan(int firstPointerIndex,
                            int secondPointerIndex)

Returns the current distance between the two pointers forming the gesture in progress.

Pointers are sorted by the time they were placed on the screen until lifted up. This means that index 0 will reflect the oldest added, still active pointer and index (getPointersCount() - 1) will reflect the latest added, still active pointer.

The order of parameters is irrelevant.

Parameters:

firstPointerIndex - one of pointers indexes

secondPointerIndex - one of pointers indexes

Returns:

Distance between pointers in pixels.

See Also:

pointerIdList

getPreviousSpan

public float getPreviousSpan(int firstPointerIndex,
                             int secondPointerIndex)

Returns the previous distance between the two pointers forming the gesture in progress.

Pointers are sorted by the time they were placed on the screen until lifted up. This means that index 0 will reflect the oldest added, still active pointer and index (getPointersCount() - 1) will reflect the latest added, still active pointer.

The order of parameters is irrelevant.

Parameters:

firstPointerIndex - one of pointers indexes

secondPointerIndex - one of pointers indexes

Returns:

Previous distance between pointers in pixels.

See Also:

pointerIdList

getCurrentSpanX

public float getCurrentSpanX(int firstPointerIndex,
                             int secondPointerIndex)

Returns current X distance between pointers in pixels.

Pointers are sorted by the time they were placed on the screen until lifted up. This means that index 0 will reflect the oldest added, still active pointer and index (getPointersCount() - 1) will reflect the latest added, still active pointer.

The order of parameters is irrelevant.

Parameters:

firstPointerIndex - one of pointers indexes

secondPointerIndex - one of pointers indexes

Returns:

Current X distance between pointers in pixels.

See Also:

pointerIdList

getCurrentSpanY

public float getCurrentSpanY(int firstPointerIndex,
                             int secondPointerIndex)

Returns current Y distance between pointers in pixels.

Pointers are sorted by the time they were placed on the screen until lifted up. This means that index 0 will reflect the oldest added, still active pointer and index (getPointersCount() - 1) will reflect the latest added, still active pointer.

The order of parameters is irrelevant.

Parameters:

firstPointerIndex - one of pointers indexes

secondPointerIndex - one of pointers indexes

Returns:

Current Y distance between pointers in pixels.

See Also:

pointerIdList

getPreviousSpanX

public float getPreviousSpanX(int firstPointerIndex,
                              int secondPointerIndex)

Returns previous X distance between pointers in pixels.

Pointers are sorted by the time they were placed on the screen until lifted up. This means that index 0 will reflect the oldest added, still active pointer and index (getPointersCount() - 1) will reflect the latest added, still active pointer.

The order of parameters is irrelevant.

Parameters:

firstPointerIndex - one of pointers indexes

secondPointerIndex - one of pointers indexes

Returns:

Previous X distance between pointers in pixels.

See Also:

pointerIdList

getPreviousSpanY

public float getPreviousSpanY(int firstPointerIndex,
                              int secondPointerIndex)

Returns previous Y distance between pointers in pixels.

Pointers are sorted by the time they were placed on the screen until lifted up. This means that index 0 will reflect the oldest added, still active pointer and index (getPointersCount() - 1) will reflect the latest added, still active pointer.

The order of parameters is irrelevant.

Parameters:

firstPointerIndex - one of pointers indexes

secondPointerIndex - one of pointers indexes

Returns:

Previous Y distance between pointers in pixels.

See Also:

pointerIdList

getPointersCount

public int getPointersCount()

Returns the number of active pointers.

Returns:

number of active pointers.

getFocalPoint

public android.graphics.PointF getFocalPoint()

Returns a center point of this gesture.

Returns:

center point of this gesture.

getSpanThreshold

public float getSpanThreshold()

Get minimum span between any pair of finger that is required to pass motion events to this detector.

Returns:

minimum span

setSpanThreshold

public void setSpanThreshold(float spanThreshold)

Set minimum span in pixels between any pair of finger that is required to pass motion events to this detector.

We encourage to set those values from dimens to accommodate for various screen sizes.

Parameters:

spanThreshold - minimum span

setSpanThresholdResource

public void setSpanThresholdResource(int spanThresholdDimen)

Set minimum span in dp between any pair of finger that is required to pass motion events to this detector.

Parameters:

spanThresholdDimen - minimum span