fr.cnes.sirius.patrius.fieldsofview

Enum AngularDistanceType

java.lang.Object

java.lang.Enum<AngularDistanceType>

fr.cnes.sirius.patrius.fieldsofview.AngularDistanceType

All Implemented Interfaces:

Serializable, Comparable<AngularDistanceType>

public enum AngularDistanceType
extends Enum<AngularDistanceType>

This enum defines different methods to compute the angular distance between a given direction in space and the border of the FOV.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIRECTIONAL Directional distance.
MINIMAL Minimal distance between the input direction and all the borders of the FOV

Method Summary

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

MINIMAL

public static final AngularDistanceType MINIMAL

Minimal distance between the input direction and all the borders of the FOV

DIRECTIONAL

public static final AngularDistanceType DIRECTIONAL

Directional distance. It defined as the angle between the current direction d and the FOV border intersection with the half-plane containing both d and the FOV's main direction.

Method Detail

values

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

Returns:

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

valueOf

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