agi.foundation.geometry.shapes

(agi.foundation.core-2024r3.jar)

Enum EnclosureFunctionType

java.lang.Object

java.lang.Enum<EnclosureFunctionType>

agi.foundation.geometry.shapes.EnclosureFunctionType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<EnclosureFunctionType>

public enum EnclosureFunctionType
extends Enum<EnclosureFunctionType>
implements Enumeration

Describes the nature of an enclosure function returned by Solid.getEnclosureDescriptions().

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOCK_ANGLE The enclosure function acts like a clock angle.
CONE_ANGLE The enclosure function acts like a cone angle.
OTHER The enclosure function is of some other type.
RADIAL_LIMIT The enclosure function acts like a radial limit.

Method Summary

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

OTHER

public static final EnclosureFunctionType OTHER

The enclosure function is of some other type.

CONE_ANGLE

public static final EnclosureFunctionType CONE_ANGLE

The enclosure function acts like a cone angle.

CLOCK_ANGLE

public static final EnclosureFunctionType CLOCK_ANGLE

The enclosure function acts like a clock angle.

RADIAL_LIMIT

public static final EnclosureFunctionType RADIAL_LIMIT

The enclosure function acts like a radial limit.

Method Detail

values

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

Returns:

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

valueOf

public static EnclosureFunctionType 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 EnclosureFunctionType 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 EnclosureFunctionType getDefault()

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

Returns:

The default enum constant.