com.tplan.robot.util

Class GesturePlanner

java.lang.Object

com.tplan.robot.util.GesturePlanner

public class GesturePlanner
extends Object

Helper class to plan points along the touch screen gesture trajectory.

Since:

6.2

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GesturePlanner.GesturePlannerListener Gesture event consumer.

Constructor Summary

Constructors

Constructor and Description
GesturePlanner(int finger) Create a new gesture planner for a specific finger and a press location.

Method Summary

Modifier and Type	Method and Description
boolean	containsDrags() Find out if the gesture is a tap or long press (false) or if it contains at least one drag.
Point2D	getEnd() Get the end (release) point.
int	getFinger() Get the finger Id.
double	getLength() Calculate length of the gesture from the start point to the last move position (release point).
List<Point2D>	getMoves() Get the list of move points.
Point2D	getStart() Get the start (press) point.
int	getWait()
static Map<Integer,GesturePlanner>	initWithGestureCapable(List<Map> params, Dimension screenSize, int maxFingers, int duration, int wait) Prepare a map of gesture planners from the list of parameters created by the automation framework for use with a GestureCapable.
boolean	isLongPress() Find out if the start press is a long one.
void	moveTo(int x, int y) Add a location to drag to from the last position.
void	moveTo(Point p) Add a location to drag to from the last position.
Point	next()
void	plan(GesturePlanner.GesturePlannerListener consumer) Send the gesture events to the specified consumer.
void	setStart(int x, int y, boolean longPress) Set the gesture start (press) point.
void	setTiming(int duration, int wait) Set the gesture duration and individual step delays.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GesturePlanner

public GesturePlanner(int finger)

Create a new gesture planner for a specific finger and a press location.

Parameters:

finger - a finger Id.

Method Detail

setStart

public void setStart(int x,
                     int y,
                     boolean longPress)

Set the gesture start (press) point.

Parameters:

x - the press (start) X-coordinate.

y - the press (start) Y-coordinate.

longPress - true/false for a long/short press.

getStart

public Point2D getStart()

Get the start (press) point.

Returns:

the start point.

containsDrags

public boolean containsDrags()

Find out if the gesture is a tap or long press (false) or if it contains at least one drag.

Returns:

true if the gesture contains one or more drags.

getEnd

public Point2D getEnd()

Get the end (release) point.

Returns:

the end point.

getFinger

public int getFinger()

Get the finger Id.

Returns:

the finger Id.

getMoves

public List<Point2D> getMoves()

Get the list of move points.

Returns:

the list of move points.

isLongPress

public boolean isLongPress()

Find out if the start press is a long one.

Returns:

true for a long press or false for the regular one.

moveTo

public void moveTo(Point p)

Add a location to drag to from the last position.

Parameters:

p - a location to drag to.

moveTo

public void moveTo(int x,
                   int y)

Add a location to drag to from the last position.

Parameters:

x - the X-coord to drag to.

y - the Y-coord to drag to.

setTiming

public void setTiming(int duration,
                      int wait)

Set the gesture duration and individual step delays. This will trigger calculation of how many points will be visited along the gesture trajectory.

Parameters:

duration - total gesture duration in milliseconds.

wait - delay between two subsequent steps in milliseconds.

getWait

public int getWait()

getLength

public double getLength()

Calculate length of the gesture from the start point to the last move position (release point).

Returns:

the trajectory length.

next

public Point next()

plan

public void plan(GesturePlanner.GesturePlannerListener consumer)

Send the gesture events to the specified consumer. The setTiming(int, int) method must be called before this method to set the time parameters.

Parameters:

consumer - the consumer.

toString

public String toString()

Overrides:

toString in class Object

initWithGestureCapable

public static Map<Integer,GesturePlanner> initWithGestureCapable(List<Map> params,
                                                                 Dimension screenSize,
                                                                 int maxFingers,
                                                                 int duration,
                                                                 int wait)

Prepare a map of gesture planners from the list of parameters created by the automation framework for use with a GestureCapable.

Parameters:

params - the list of parameters.

screenSize - the screen size.

maxFingers - maximum number of fingers supported by the device.

duration - gesture duration in milliseconds.

wait - time to wait between two subsequent steps in milliseconds.

Returns:

a map of [fingerId, gesturePlanner] pairs.