agi.foundation.geometry.shapes

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

Enum EllipsoidType

java.lang.Object

java.lang.Enum<EllipsoidType>

agi.foundation.geometry.shapes.EllipsoidType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<EllipsoidType>

public enum EllipsoidType
extends Enum<EllipsoidType>
implements Enumeration

The type of an ellipsoid.

Enum Constant Summary

Enum Constants

Enum Constant and Description
OBLATE_SPHEROID The ellipsoid is an oblate spheroid.
PROLATE_SPHEROID The ellipsoid is a prolate spheroid.
SCALENE The ellipsoid is a scalene ellipsoid.
SPHERE The ellipsoid is a sphere.

Method Summary

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

SPHERE

public static final EllipsoidType SPHERE

The ellipsoid is a sphere. The semiaxis lengths are all equal.

OBLATE_SPHEROID

public static final EllipsoidType OBLATE_SPHEROID

The ellipsoid is an oblate spheroid. The equatorial semiaxis lengths are equal and greater than the polar semiaxis length.

PROLATE_SPHEROID

public static final EllipsoidType PROLATE_SPHEROID

The ellipsoid is a prolate spheroid. The equatorial semiaxis lengths are equal and smaller than the polar semiaxis length.

SCALENE

public static final EllipsoidType SCALENE

The ellipsoid is a scalene ellipsoid. The semiaxis lengths are unequal.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.