Package com.jogamp.newt.event
Class PinchToZoomGesture
- java.lang.Object
-
- com.jogamp.newt.event.PinchToZoomGesture
-
- All Implemented Interfaces:
GestureHandler
public class PinchToZoomGesture extends Object implements GestureHandler
2 pointer zoom, a.k.a. pinch to zoom, gesture handler processingMouseEvent
s while producingPinchToZoomGesture.ZoomEvent
s if gesture is completed.Zoom value lies within [0..2], with 1 as 1:1.
- choosing the smallest surface edge (width/height -> x/y) - tolerating other fingers to be pressed and hence user to add functionality (scale, ..)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PinchToZoomGesture.ZoomEvent
AGestureHandler.GestureEvent
denominating zoom.-
Nested classes/interfaces inherited from interface com.jogamp.newt.event.GestureHandler
GestureHandler.GestureEvent, GestureHandler.GestureListener
-
-
Field Summary
Fields Modifier and Type Field Description static boolean
DEBUG
-
Constructor Summary
Constructors Constructor Description PinchToZoomGesture(NativeSurface surface, boolean allowMorePointer)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear(boolean clearStarted)
Clears state of handler, i.e.InputEvent
getGestureEvent()
Returns the correspondingInputEvent
for the gesture as detected by a previousGestureHandler.process(InputEvent)
, which has not beencleared
.float
getZoom()
Zoom value lies within [0..2], with 1 as 1:1.boolean
hasGesture()
Returns true if a previousGestureHandler.process(InputEvent)
command produced a gesture, which has not beencleared
.boolean
isWithinGesture()
Returns true if within a gesture as detected by a previousGestureHandler.process(InputEvent)
command, which has not beencleared
.boolean
process(InputEvent in)
Process the givenInputEvent
and returns true if it produced the gesture.void
setZoom(float zoom)
Set zoom value within [0..2], with 1 as 1:1.String
toString()
-
-
-
Constructor Detail
-
PinchToZoomGesture
public PinchToZoomGesture(NativeSurface surface, boolean allowMorePointer)
- Parameters:
surface
- theNativeSurface
, which size is used to compute the relative zoom factorallowMorePointer
- if false, allow only 2 pressed pointers (safe and recommended), otherwise accept other pointer to be pressed.
-
-
Method Detail
-
clear
public void clear(boolean clearStarted)
Description copied from interface:GestureHandler
Clears state of handler, i.e. resets all states incl. previous detected gesture.- Specified by:
clear
in interfaceGestureHandler
- 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.
-
isWithinGesture
public boolean isWithinGesture()
Description copied from interface:GestureHandler
Returns true if within a gesture as detected by a previousGestureHandler.process(InputEvent)
command, which has not beencleared
. Otherwise returns false.- Specified by:
isWithinGesture
in interfaceGestureHandler
-
hasGesture
public boolean hasGesture()
Description copied from interface:GestureHandler
Returns true if a previousGestureHandler.process(InputEvent)
command produced a gesture, which has not beencleared
. Otherwise returns false.- Specified by:
hasGesture
in interfaceGestureHandler
-
getGestureEvent
public InputEvent getGestureEvent()
Description copied from interface:GestureHandler
Returns the correspondingInputEvent
for the gesture as detected by a previousGestureHandler.process(InputEvent)
, which has not beencleared
. Otherwise returns null.Only implemented for gestures mapping to
InputEvent
s.- Specified by:
getGestureEvent
in interfaceGestureHandler
-
getZoom
public final float getZoom()
Zoom value lies within [0..2], with 1 as 1:1.
-
setZoom
public final void setZoom(float zoom)
Set zoom value within [0..2], with 1 as 1:1.
-
process
public boolean process(InputEvent in)
Description copied from interface:GestureHandler
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
.- Specified by:
process
in interfaceGestureHandler
-
-