Package com.jogamp.newt.event
Interface GestureHandler
- All Known Implementing Classes:
DoubleTapScrollGesture
,PinchToZoomGesture
public interface GestureHandler
Generic gesture handler interface designed to allow pass-through
filtering of
InputEvent
s.
To avoid negative impact on event processing, implementation shall restrict computation as much as possible and only within it's appropriate gesture states.
To allow custom user events, other than the normal InputEvent
s,
a user may return a GestureHandler.GestureEvent
in it's implementation.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic class
A custom gesture eventstatic interface
Listener forGestureHandler.GestureEvent
s. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear
(boolean clearStarted) Clears state of handler, i.e.Returns the correspondingInputEvent
for the gesture as detected by a previousprocess(InputEvent)
, which has not beencleared
.boolean
Returns true if a previousprocess(InputEvent)
command produced a gesture, which has not beencleared
.boolean
Returns true if within a gesture as detected by a previousprocess(InputEvent)
command, which has not beencleared
.boolean
Process the givenInputEvent
and returns true if it produced the gesture.
-
Field Details
-
DEBUG
static final boolean DEBUG
-
-
Method Details
-
clear
void clear(boolean clearStarted) Clears state of handler, i.e. resets all states incl. previous detected gesture.- Parameters:
clearStarted
- if true, also clearsstarted
state, otherwise stay within gesture - if appropriate. Staying within a gesture allows fluent continuous gesture sequence, e.g. for scrolling.
-
hasGesture
boolean hasGesture()Returns true if a previousprocess(InputEvent)
command produced a gesture, which has not beencleared
. Otherwise returns false. -
getGestureEvent
InputEvent getGestureEvent()Returns the correspondingInputEvent
for the gesture as detected by a previousprocess(InputEvent)
, which has not beencleared
. Otherwise returns null.Only implemented for gestures mapping to
InputEvent
s. -
isWithinGesture
boolean isWithinGesture()Returns true if within a gesture as detected by a previousprocess(InputEvent)
command, which has not beencleared
. Otherwise returns false. -
process
Process the givenInputEvent
and returns true if it produced the gesture. Otherwise returns false.If a gesture was already detected previously and has not been cleared, method does not process the event and returns true.
Besides validation of the event's details, the handler may also validate the
InputEvent.InputClass
and/orInputEvent.InputType
.
-