fr.cnes.sirius.patrius.fieldsofview

Class CircularField

java.lang.Object

fr.cnes.sirius.patrius.fieldsofview.CircularField

All Implemented Interfaces:

IFieldOfView, Serializable

public final class CircularField
extends Object
implements IFieldOfView

This class describes a right circular field of view to be used in "instruments" part properties. It implements the IFieldOfView interface and so provides the associated services.

Since:

1.2

Version:

$Id$

Author:

Thomas Trapier

See Also:

IFieldOfView, Serialized Form

Concurrency :

immutable

Constructor Summary

Constructors

Constructor and Description
CircularField(String name, double halfAngularAperture, Vector3D mainDirection) Constructor for a circular field of view.

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.
double	getHalfAngularAperture() Returns the half-aperture.
String	getName()
boolean	isInTheField(Vector3D direction)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CircularField

public CircularField(String name,
                     double halfAngularAperture,
                     Vector3D mainDirection)

Constructor for a circular field of view.

Parameters:

name - the name of the field

halfAngularAperture - the half angular aperture : must be strictly between 0 and PI

mainDirection - the direction defining the center of the field

Method Detail

getAngularDistance

public 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.

Specified by:

getAngularDistance in interface IFieldOfView

Parameters:

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

Returns:

the angular distance

isInTheField

public boolean isInTheField(Vector3D direction)

Specified by:

isInTheField in interface IFieldOfView

Parameters:

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

Returns:

true if the direction is in the field

getName

public String getName()

Specified by:

getName in interface IFieldOfView

Returns:

the name of the field

getHalfAngularAperture

public double getHalfAngularAperture()

Returns the half-aperture.

Returns:

the half-aperture