Package com.vuzix.ultralite

Enum Class Icon

java.lang.Object

java.lang.Enum<Icon>

com.vuzix.ultralite.Icon

All Implemented Interfaces:

Serializable, Comparable<Icon>, Constable

public enum Icon
extends Enum<Icon>

Supported icons. Only used with navigation layout.

Since:

1.0.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARRIVE	Icon: Indication you are arriving at the destination
CUSTOM	Request a custom icon image be shown.
KEEP_LEFT	Icon: Arrow indicating to stay left at a merge point
KEEP_RIGHT	Icon: Arrow indicating to stay right at a merge point
LEFT	Icon: Left turn arrow
NONE	Do not show any icon
RIGHT	Icon: Right turn arrow
START	Icon: Indication you are at the beginning of a route
STRAIGHT	Icon: Arrow indicating to continue straight ahead
UTURN	Icon: Arrow indicating to make a U-Turn

Method Summary

Modifier and Type	Method	Description
int	getId()	Get the enumerated value
static Icon	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Icon[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final Icon NONE

Do not show any icon

Since:

1.0.0

LEFT

public static final Icon LEFT

Icon: Left turn arrow

Since:

1.0.0

RIGHT

public static final Icon RIGHT

Icon: Right turn arrow

Since:

1.0.0

STRAIGHT

public static final Icon STRAIGHT

Icon: Arrow indicating to continue straight ahead

Since:

1.0.0

UTURN

public static final Icon UTURN

Icon: Arrow indicating to make a U-Turn

Since:

1.0.0

KEEP_LEFT

public static final Icon KEEP_LEFT

Icon: Arrow indicating to stay left at a merge point

Since:

1.0.0

KEEP_RIGHT

public static final Icon KEEP_RIGHT

Icon: Arrow indicating to stay right at a merge point

Since:

1.0.0

ARRIVE

public static final Icon ARRIVE

Icon: Indication you are arriving at the destination

Since:

1.0.0

START

public static final Icon START

Icon: Indication you are at the beginning of a route

Since:

1.0.0

CUSTOM

public static final Icon CUSTOM

Request a custom icon image be shown. You must first send the image to the glasses with UltraliteSDK.sendIcon(LVGLImage).

Since:

1.0.0

Method Details

values

public static Icon[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Icon valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getId

public int getId()

Get the enumerated value

Returns:

numeric ID

Since:

1.0.0