org.orekit.geometry.fov

Enum PolygonalFieldOfView.DefiningConeType

java.lang.Object

java.lang.Enum<PolygonalFieldOfView.DefiningConeType>

org.orekit.geometry.fov.PolygonalFieldOfView.DefiningConeType

All Implemented Interfaces:

Serializable, Comparable<PolygonalFieldOfView.DefiningConeType>

Enclosing class:

PolygonalFieldOfView

public static enum PolygonalFieldOfView.DefiningConeType
extends Enum<PolygonalFieldOfView.DefiningConeType>

Enumerate for cone/polygon relative position.

Since:

10.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSIDE_CONE_TOUCHING_POLYGON_AT_EDGES_MIDDLE Constant for cones inside polygons and touching it at polygon edges middle points.
OUTSIDE_CONE_TOUCHING_POLYGON_AT_VERTICES Constant for cones outside polygons and touching it at polygon vertices.

Method Summary

Modifier and Type	Method and Description
protected abstract Vector3D	createVertex(Vector3D center, Vector3D meridian, double verticesRadius, int n) Create a vertex.
static PolygonalFieldOfView.DefiningConeType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PolygonalFieldOfView.DefiningConeType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
protected abstract double	verticesRadius(double radius, int n) Compute radius of cone going through vertices.

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

INSIDE_CONE_TOUCHING_POLYGON_AT_EDGES_MIDDLE

public static final PolygonalFieldOfView.DefiningConeType INSIDE_CONE_TOUCHING_POLYGON_AT_EDGES_MIDDLE

Constant for cones inside polygons and touching it at polygon edges middle points.

OUTSIDE_CONE_TOUCHING_POLYGON_AT_VERTICES

public static final PolygonalFieldOfView.DefiningConeType OUTSIDE_CONE_TOUCHING_POLYGON_AT_VERTICES

Constant for cones outside polygons and touching it at polygon vertices.

Method Detail

values

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

Returns:

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

valueOf

public static PolygonalFieldOfView.DefiningConeType 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

verticesRadius

protected abstract double verticesRadius(double radius,
                                         int n)

Compute radius of cone going through vertices.

Parameters:

radius - defining cone angular radius

n - number of sides of the polygon

Returns:

radius of cone going through vertices

createVertex

protected abstract Vector3D createVertex(Vector3D center,
                                         Vector3D meridian,
                                         double verticesRadius,
                                         int n)

Create a vertex.

Parameters:

center - center of the polygon (the center is in the inside part)

meridian - point defining the reference meridian for one contact point between defining cone and polygon (i.e. either a polygon edge middle point or a polygon vertex)

verticesRadius - defining radius of cone passing through vertices

n - number of sides of the polygon

Returns:

created vertex