org.testfx.robot

Enum Motion

java.lang.Object

java.lang.Enum<Motion>

org.testfx.robot.Motion

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Motion>

public enum Motion
extends java.lang.Enum<Motion>

Enumeration holding the three simplest types of motion between two 2D points a = (x₁, y₁) and b = (x₂, y₂). Given any two points in the plane we can construct a right-angled triangle where the hypotenuse is the straight-line between a and b.

 +-----------------------→ +x
 |    d        b
 |    |        *
 |    |      * *
 |    |    *   *
 |    |  *     *
 |    |*       *
 |    **********
 |    a        c
 |
 v
 +y
 

Traveling in a straight-line between a and b (that is, tracing the hypotenuse) is DIRECT. Traveling first from a to c and then from c to b is HORIZONTAL_FIRST. Traveling first from a to d and then from d to b is VERTICAL_FIRST. DIRECT means that no specific type of motion was explicitly requested.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT
DIRECT
HORIZONTAL_FIRST
VERTICAL_FIRST

Method Summary

Modifier and Type	Method and Description
static Motion	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Motion[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

public static final Motion DEFAULT

DIRECT

public static final Motion DIRECT

HORIZONTAL_FIRST

public static final Motion HORIZONTAL_FIRST

VERTICAL_FIRST

public static final Motion VERTICAL_FIRST

Method Detail

values

public static Motion[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Motion c : Motion.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Motion valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null