agi.foundation.access.constraints

(agi.foundation.platforms-2025r1.jar)

Enum PlaneIndicator

java.lang.Object

java.lang.Enum<PlaneIndicator>

agi.foundation.access.constraints.PlaneIndicator

All Implemented Interfaces:

Enumeration, Serializable, Comparable<PlaneIndicator>

public enum PlaneIndicator
extends Enum<PlaneIndicator>
implements Enumeration

Indicates which plane to use with a AngleInPlaneConstraint or a AngleOutOfPlaneConstraint

Enum Constant Summary

Enum Constants

Enum Constant and Description
XY Indicates the use of the XY plane for a AngleInPlaneConstraint or a AngleOutOfPlaneConstraint
XZ Indicates the use of the XZ plane for a AngleInPlaneConstraint or a AngleOutOfPlaneConstraint
YZ Indicates the use of the XZ plane for a AngleInPlaneConstraint or a AngleOutOfPlaneConstraint

Method Summary

Modifier and Type	Method and Description
static PlaneIndicator	getDefault() Get the enum constant that is considered to be the default.
static PlaneIndicator	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static PlaneIndicator	valueOf(String name) Returns the enum constant of this type with the specified name.
static PlaneIndicator[]	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

XY

public static final PlaneIndicator XY

Indicates the use of the XY plane for a AngleInPlaneConstraint or a AngleOutOfPlaneConstraint

XZ

public static final PlaneIndicator XZ

Indicates the use of the XZ plane for a AngleInPlaneConstraint or a AngleOutOfPlaneConstraint

YZ

public static final PlaneIndicator YZ

Indicates the use of the XZ plane for a AngleInPlaneConstraint or a AngleOutOfPlaneConstraint

Method Detail

values

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

Returns:

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

valueOf

public static PlaneIndicator 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

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static PlaneIndicator getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static PlaneIndicator getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.