agi.foundation.geometry.shapes

(agi.foundation.core-2026r3.jar)

Class SensorFieldOfView

java.lang.Object

agi.foundation.geometry.shapes.Figure

agi.foundation.geometry.shapes.Solid

agi.foundation.geometry.shapes.SensorFieldOfView

All Implemented Interfaces:

IServiceProvider

Direct Known Subclasses:

ComplexConic, CustomSensorPattern, RectangularPyramid, SyntheticApertureRadarVolume

public abstract class SensorFieldOfView
extends Solid
implements IServiceProvider

A sensor field of view volume.

Constructor Summary

Constructors

Constructor and Description
SensorFieldOfView()

Method Summary

Modifier and Type	Method and Description
double	getMaximumRadius() Gets the maximum radial limit.
double	getMinimumRadius() Gets the minimum radial limit.
SensorProjection	getProjection(Ellipsoid ellipsoid, KinematicTransformation ellipsoidToSensorTransformation) Gets the projection of the sensor onto the front surface of a specified ellipsoid and into space.
abstract SensorProjection	getProjection(Ellipsoid ellipsoid, KinematicTransformation ellipsoidToSensorTransformation, SensorProjectionOptions projectionOptions) Gets the projection of the sensor onto the front surface of a specified ellipsoid and onto a plane at a specified distance in space.
double	getRadius() Deprecated. Use MinimumRadius, MaximumRadius, or SetRadialLimits instead.
Object	getService(Class<?> serviceType) Gets the service object of the specified type.
protected void	onRadialLimitsChanged() Called after the radial limits of the sensor volume are changed.
protected void	onRadiusChanged() Deprecated. Use OnRadialLimitsChanged instead.
void	setRadialLimits(double minimum, double maximum) Sets the radial limits of the sensor volume, which restrict the volume to a spherical shell.
void	setRadius(double value) Deprecated. Use MinimumRadius, MaximumRadius, or SetRadialLimits instead.

Methods inherited from class agi.foundation.geometry.shapes.Solid

encloses, getEnclosureDescriptions

Methods inherited from class agi.foundation.geometry.shapes.Figure

getIsConnected

Methods inherited from class java.lang.Object

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

Constructor Detail

SensorFieldOfView

public SensorFieldOfView()

Method Detail

getRadius

@Deprecated
public final double getRadius()

Deprecated. Use MinimumRadius, MaximumRadius, or SetRadialLimits instead.

Gets the radial limit of the volume. This is the maximum range at which the sensor can detect a target.

Throws:

ArgumentOutOfRangeException - Thrown when the radius is less than or equal to zero.

setRadius

@Deprecated
public final void setRadius(double value)

Deprecated. Use MinimumRadius, MaximumRadius, or SetRadialLimits instead.

Sets the radial limit of the volume. This is the maximum range at which the sensor can detect a target.

Throws:

ArgumentOutOfRangeException - Thrown when the radius is less than or equal to zero.

getMinimumRadius

public final double getMinimumRadius()

Gets the minimum radial limit. In conjunction with MaximumRadius (get), this restricts the volume to a spherical shell. By default, this property has the value 0.0.

getMaximumRadius

public final double getMaximumRadius()

Gets the maximum radial limit. In conjunction with MinimumRadius (get), this restricts the volume to a spherical shell. By default, this property has the value Double.POSITIVE_INFINITY.

setRadialLimits

public final void setRadialLimits(double minimum,
                                  double maximum)

Sets the radial limits of the sensor volume, which restrict the volume to a spherical shell.

Parameters:

minimum - The radial distance to the spherical surface defining the minimum range of the sensor volume.

maximum - The radial distance to the spherical surface defining the maximum range of the sensor volume.

Throws:

ArgumentOutOfRangeException - The minimum and maximum radial limits must be in the range from 0.0 to Double.POSITIVE_INFINITY.

ArgumentException - The minimum radial limit must be less the maximum radial limit.

getProjection

@Nonnull
public final SensorProjection getProjection(@Nonnull
                                                      Ellipsoid ellipsoid,
                                                      @Nonnull
                                                      KinematicTransformation ellipsoidToSensorTransformation)

Gets the projection of the sensor onto the front surface of a specified ellipsoid and into space.

Parameters:

ellipsoid - The ellipsoid on which the sensor is to be projected.

ellipsoidToSensorTransformation - The transformation from the reference frame of the ellipsoid to the reference frame of the sensor.

Returns:

The sensor projection.

getProjection

@Nonnull
public abstract SensorProjection getProjection(@Nonnull
                                                         Ellipsoid ellipsoid,
                                                         @Nonnull
                                                         KinematicTransformation ellipsoidToSensorTransformation,
                                                         @Nullable
                                                         SensorProjectionOptions projectionOptions)

Gets the projection of the sensor onto the front surface of a specified ellipsoid and onto a plane at a specified distance in space.

Parameters:

ellipsoid - The ellipsoid on which the sensor is to be projected.

ellipsoidToSensorTransformation - The transformation from the reference frame of the ellipsoid to the reference frame of the sensor.

projectionOptions - The options controlling how the sensor is projected, or null to use defaults.

Returns:

The sensor projection.

onRadiusChanged

@Deprecated
protected void onRadiusChanged()

Deprecated. Use OnRadialLimitsChanged instead.

Called after the Radius (get / set) property changes.

onRadialLimitsChanged

protected void onRadialLimitsChanged()

Called after the radial limits of the sensor volume are changed.

getService

@Nullable
public Object getService(@Nonnull
                                    Class<?> serviceType)

Gets the service object of the specified type.

Specified by:

getService in interface IServiceProvider

Parameters:

serviceType - An object that specifies the type of service object to get.

Returns:

The found service, or null if the service does not exist.

Throws:

ArgumentNullException - Thrown when serviceType is null.