com.wikitude.tracker

Enum PlaneFilter

java.lang.Object

java.lang.Enum<PlaneFilter>

com.wikitude.tracker.PlaneFilter

All Implemented Interfaces:

Serializable, Comparable<PlaneFilter>

public enum PlaneFilter
extends Enum<PlaneFilter>

Use this enum to determine what types of planes should be detected.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY ANY: All planes will be detected, regardless of their orientation.
ARBITRARY ARBITRARY: Only planes with an arbitrary orientation will be detected.
HORIZONTAL HORIZONTAL: Only horizontal planes will be detected, regardless if they point upward or downward.
HORIZONTAL_DOWNWARD HORIZONTAL_DOWNWARD: Only horizontal planes that point downward (e.g.
HORIZONTAL_UPWARD HORIZONTAL_UPWARD: Only horizontal planes that point upward (e.g.
VERTICAL VERTICAL: Only vertical planes (e.g.

Method Summary

Modifier and Type	Method and Description
static PlaneFilter	valueOf(String name) Returns the enum constant of this type with the specified name.
static PlaneFilter[]	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

HORIZONTAL_UPWARD

public static final PlaneFilter HORIZONTAL_UPWARD

HORIZONTAL_UPWARD: Only horizontal planes that point upward (e.g. floors) will be detected.

HORIZONTAL_DOWNWARD

public static final PlaneFilter HORIZONTAL_DOWNWARD

HORIZONTAL_DOWNWARD: Only horizontal planes that point downward (e.g. ceilings) will be detected.

HORIZONTAL

public static final PlaneFilter HORIZONTAL

HORIZONTAL: Only horizontal planes will be detected, regardless if they point upward or downward.

VERTICAL

public static final PlaneFilter VERTICAL

VERTICAL: Only vertical planes (e.g. walls) will be detected.

ARBITRARY

public static final PlaneFilter ARBITRARY

ARBITRARY: Only planes with an arbitrary orientation will be detected.

ANY

public static final PlaneFilter ANY

ANY: All planes will be detected, regardless of their orientation.

Method Detail

values

public static PlaneFilter[] 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 (PlaneFilter c : PlaneFilter.values())
    System.out.println(c);

Returns:

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

valueOf

public static PlaneFilter valueOf(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:

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

NullPointerException - if the argument is null