Package org.orekit.propagation.events

Enum VisibilityTrigger

java.lang.Object

java.lang.Enum<VisibilityTrigger>

org.orekit.propagation.events.VisibilityTrigger

All Implemented Interfaces:

Serializable, Comparable<VisibilityTrigger>

public enum VisibilityTrigger
extends Enum<VisibilityTrigger>

Enumerate for triggering visibility of spherical bodies.

Since:

10.0

Author:

Luc Maisonobe

See Also:

FieldOfViewDetector

Enum Constant Summary

Enum Constants

Enum Constant	Description
VISIBLE_AS_SOON_AS_PARTIALLY_IN_FOV	Trigger for bodies that are considered visible as soon as a part touches Field Of View.
VISIBLE_ONLY_WHEN_FULLY_IN_FOV	Trigger for bodies that are considered visible only when fully inside Field Of View.

Method Summary

Modifier and Type	Method	Description
double	radiusCorrection(double angularRadius)	Apply radius correction.
static VisibilityTrigger	valueOf(String name)	Returns the enum constant of this type with the specified name.
static VisibilityTrigger[]	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

VISIBLE_ONLY_WHEN_FULLY_IN_FOV

public static final VisibilityTrigger VISIBLE_ONLY_WHEN_FULLY_IN_FOV

Trigger for bodies that are considered visible only when fully inside Field Of View.

VISIBLE_AS_SOON_AS_PARTIALLY_IN_FOV

public static final VisibilityTrigger VISIBLE_AS_SOON_AS_PARTIALLY_IN_FOV

Trigger for bodies that are considered visible as soon as a part touches Field Of View.

Method Detail

values

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

Returns:

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

valueOf

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

radiusCorrection

public double radiusCorrection(double angularRadius)

Apply radius correction.

Parameters:

angularRadius - target body angular radius

Returns:

corrected radius

Since:

10.1