org.andengine.input.touch.detector

Class HoldDetector

java.lang.Object

org.andengine.input.touch.detector.BaseDetector

org.andengine.input.touch.detector.HoldDetector

All Implemented Interfaces:

IOnSceneTouchListener

Direct Known Subclasses:

ContinuousHoldDetector

public class HoldDetector
extends BaseDetector

(c) 2010 Nicolas Gramlich (c) 2011 Zynga Inc.

Since:

20:49:25 - 23.08.2010

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HoldDetector.IHoldDetectorListener

Field Summary

Fields

Modifier and Type	Field and Description
protected long	mDownTimeMilliseconds
protected float	mDownX
protected float	mDownY
protected HoldDetector.IHoldDetectorListener	mHoldDetectorListener
protected float	mHoldX
protected float	mHoldY
protected boolean	mMaximumDistanceExceeded
protected int	mPointerID
protected float	mTriggerHoldMaximumDistance
protected long	mTriggerHoldMinimumMilliseconds
protected boolean	mTriggering
protected static float	TRIGGER_HOLD_MAXIMUM_DISTANCE_DEFAULT
protected static long	TRIGGER_HOLD_MINIMUM_MILLISECONDS_DEFAULT

Constructor Summary

Constructors

Constructor and Description
HoldDetector(HoldDetector.IHoldDetectorListener pHoldDetectorListener)
HoldDetector(long pTriggerHoldMinimumMilliseconds, float pTriggerHoldMaximumDistance, HoldDetector.IHoldDetectorListener pHoldDetectorListener)

Method Summary

Modifier and Type	Method and Description
float	getTriggerHoldMaximumDistance()
long	getTriggerHoldMinimumMilliseconds()
boolean	isHolding()
boolean	onManagedTouchEvent(TouchEvent pSceneTouchEvent)
protected void	prepareHold(TouchEvent pSceneTouchEvent)
void	reset() When isHolding() this method will call through to {@link IHoldDetectorListener#onHoldFinished(HoldDetector, long, int, float, float).
void	setTriggerHoldMaximumDistance(float pTriggerHoldMaximumDistance)
void	setTriggerHoldMinimumMilliseconds(long pTriggerHoldMinimumMilliseconds)
protected void	triggerOnHold(long pHoldTimeMilliseconds)
protected void	triggerOnHoldFinished(long pHoldTimeMilliseconds)
protected void	triggerOnHoldStarted()

Methods inherited from class org.andengine.input.touch.detector.BaseDetector

isEnabled, onSceneTouchEvent, onTouchEvent, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

TRIGGER_HOLD_MINIMUM_MILLISECONDS_DEFAULT

protected static final long TRIGGER_HOLD_MINIMUM_MILLISECONDS_DEFAULT

See Also:

Constant Field Values

TRIGGER_HOLD_MAXIMUM_DISTANCE_DEFAULT

protected static final float TRIGGER_HOLD_MAXIMUM_DISTANCE_DEFAULT

See Also:

Constant Field Values

mTriggerHoldMinimumMilliseconds

protected long mTriggerHoldMinimumMilliseconds

mTriggerHoldMaximumDistance

protected float mTriggerHoldMaximumDistance

mHoldDetectorListener

protected final HoldDetector.IHoldDetectorListener mHoldDetectorListener

mPointerID

protected int mPointerID

mDownTimeMilliseconds

protected long mDownTimeMilliseconds

mDownX

protected float mDownX

mDownY

protected float mDownY

mHoldX

protected float mHoldX

mHoldY

protected float mHoldY

mMaximumDistanceExceeded

protected boolean mMaximumDistanceExceeded

mTriggering

protected boolean mTriggering

Constructor Detail

HoldDetector

public HoldDetector(HoldDetector.IHoldDetectorListener pHoldDetectorListener)

HoldDetector

public HoldDetector(long pTriggerHoldMinimumMilliseconds,
                    float pTriggerHoldMaximumDistance,
                    HoldDetector.IHoldDetectorListener pHoldDetectorListener)

Method Detail

getTriggerHoldMinimumMilliseconds

public long getTriggerHoldMinimumMilliseconds()

setTriggerHoldMinimumMilliseconds

public void setTriggerHoldMinimumMilliseconds(long pTriggerHoldMinimumMilliseconds)

getTriggerHoldMaximumDistance

public float getTriggerHoldMaximumDistance()

setTriggerHoldMaximumDistance

public void setTriggerHoldMaximumDistance(float pTriggerHoldMaximumDistance)

isHolding

public boolean isHolding()

reset

public void reset()

When isHolding() this method will call through to {@link IHoldDetectorListener#onHoldFinished(HoldDetector, long, int, float, float).

Specified by:

reset in class BaseDetector

onManagedTouchEvent

public boolean onManagedTouchEvent(TouchEvent pSceneTouchEvent)

Specified by:

onManagedTouchEvent in class BaseDetector

prepareHold

protected void prepareHold(TouchEvent pSceneTouchEvent)

triggerOnHoldStarted

protected void triggerOnHoldStarted()

triggerOnHold

protected void triggerOnHold(long pHoldTimeMilliseconds)

triggerOnHoldFinished

protected void triggerOnHoldFinished(long pHoldTimeMilliseconds)