fr.cnes.sirius.patrius.fieldsofview

Interface IFieldOfView

All Superinterfaces:

Serializable

All Known Subinterfaces:

IGeometricFieldOfView

All Known Implementing Classes:

AzimuthElevationField, BooleanField, CircularField, EllipticField, InvertField, OmnidirectionalField, PyramidalField, RectangleField, SectorField

public interface IFieldOfView
extends Serializable

This is the interface for all the field of view (circular, elliptic...). All of them can compute the angular distance to a given direction (Vector3D).

Since:

1.2

Version:

$Id$

Author:

Thomas Trapier

Method Summary

Modifier and Type	Method and Description
double	getAngularDistance(Vector3D direction) Computes the angular distance between a vector and the border of the field.
String	getName()
boolean	isInTheField(Vector3D direction)

Method Detail

getAngularDistance

double getAngularDistance(Vector3D direction)

Computes the angular distance between a vector and the border of the field. The result is positive if the direction is in the field, negative otherwise. For some of the fields (ComplexField), that value can be approximative : see particular javadoc of each class.

Parameters:

direction - the direction vector (expressed in the topocentric coordinate system of the object)

Returns:

the angular distance

isInTheField

boolean isInTheField(Vector3D direction)

Parameters:

direction - a direction vector (expressed in the topocentric coordinate system of the object)

Returns:

true if the direction is in the field

getName

String getName()

Returns:

the name of the field