agi.foundation.geometry.shapes

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

Class ComplexConic

java.lang.Object

agi.foundation.geometry.shapes.Figure

agi.foundation.geometry.shapes.Solid

agi.foundation.geometry.shapes.SensorFieldOfView

agi.foundation.geometry.shapes.ComplexConic

All Implemented Interfaces:

IServiceProvider

public class ComplexConic
extends SensorFieldOfView

A sensor volume defined by inner and outer half angles, minimum and maximum clock angles, and a radial range limit. The half angles define the outer boundary of the volume, while the clock angles restrict the volume to a sector of the annular cross-section, and the radial range closes the volume.

The vertex of the volume is located at the origin and the sensor principal direction is along the positive z-axis. Half angles measured from the principal direction are used to define the outer boundary of the volume as well as an interior conical volume of exclusion. Minimum and maximum clock angles measured from the x-axis and about the principal direction are used to further restrict the volume to a sector of the annular cross-section. The range limit measured radially from the origin defines the maximum distance at which the sensor can detect a target, and forms the final bound of the sensor volume.

Constructor Summary

Constructors

Constructor and Description
ComplexConic() Constructs a volume with a default definition.
ComplexConic(double innerHalfAngle, double outerHalfAngle, double minimumClockAngle, double maximumClockAngle) Constructs a volume of infinite radius with the provided parameters.
ComplexConic(double innerHalfAngle, double outerHalfAngle, double minimumClockAngle, double maximumClockAngle, double radius) Constructs a volume of limited radius with the provided parameters.

Method Summary

Modifier and Type	Method and Description
boolean	encloses(Cartesian point) Indicates if the provided point is inside the volume.
EnclosureDescriptionCollection	getEnclosureDescriptions() Gets the list of descriptions for the enclosure functions for this solid.
double	getInnerHalfAngle() Gets the inner half angle used to define the interior conical volume of exclusion.
boolean	getIsConnected() Gets a value indicating whether the figure is connected.
double	getMaximumClockAngle() Gets the maximum clock angle.
double	getMinimumClockAngle() Gets the minimum clock angle.
double	getOuterHalfAngle() Gets the outer half angle used to define the exterior conical boundary of the volume.
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.
protected void	onRadiusChanged() Called after the Radius (get / set) property changes.
void	setClockAngles(double minimum, double maximum) Sets the clock angles, which restrict the volume to a wedge-shaped portion of the annular cross-section.
void	setHalfAngles(double inner, double outer) Sets the inner and outer half angles of a sensor volume, which are used to define inner and outer conical volumes.

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

getProjection, getRadius, getService, setRadius

Methods inherited from class java.lang.Object

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

Constructor Detail

ComplexConic

public ComplexConic()

Constructs a volume with a default definition. Default parameters are: the InnerHalfAngle (get) equals 0 radians, the OuterHalfAngle (get) equals π/4 radians, the MinimumClockAngle (get) equals negative π/4 radians, and the MaximumClockAngle (get) equals π/4 radians.

ComplexConic

public ComplexConic(double innerHalfAngle,
                    double outerHalfAngle,
                    double minimumClockAngle,
                    double maximumClockAngle)

Constructs a volume of infinite radius with the provided parameters.

Parameters:

innerHalfAngle - The angle between the principal direction and the boundary of the interior conical volume of exclusion. Defines the interior conical volume of exclusion.

outerHalfAngle - The angle between the principal direction and the external boundary of the volume of the sensor. Defines the conical volume of the sensor.

minimumClockAngle - The angle between the positive x-axis and the opening edge of the restricted annular cross-section. The angle is measured clockwise when looking in the direction of the positive z axis. In conjunction with the maximumClockAngle, restricts sensor volume to a portion of the annular cross-section of a cone.

maximumClockAngle - The angle between the positive x-axis and the closing edge of the restricted annular cross-section. The angle is measured clockwise when looking in the direction of the positive z axis. In conjunction with the minimumClockAngle, restricts the sensor volume to a portion of the annular cross-section of a cone.

ComplexConic

public ComplexConic(double innerHalfAngle,
                    double outerHalfAngle,
                    double minimumClockAngle,
                    double maximumClockAngle,
                    double radius)

Constructs a volume of limited radius with the provided parameters.

Parameters:

innerHalfAngle - The angle between the principal direction and the boundary of the interior conical volume of exclusion. Defines the interior conical volume of exclusion.

outerHalfAngle - The angle between the principal direction and the external boundary of the volume of the sensor. Defines the conical volume of the sensor.

minimumClockAngle - The angle between the positive x-axis and the opening edge of the restricted annular cross-section. The angle is measured clockwise when looking in the direction of the positive z axis. In conjunction with the maximumClockAngle, restricts sensor volume to a portion of the annular cross-section of a cone.

maximumClockAngle - The angle between the positive x-axis and the closing edge of the restricted annular cross-section. The angle is measured clockwise when looking in the direction of the positive z axis. In conjunction with the minimumClockAngle, restricts the sensor volume to a portion of the annular cross-section of a cone.

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

Method Detail

getIsConnected

public boolean getIsConnected()

Gets a value indicating whether the figure is connected.

Specified by:

getIsConnected in class Figure

onRadiusChanged

protected void onRadiusChanged()

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

Overrides:

onRadiusChanged in class SensorFieldOfView

getInnerHalfAngle

public final double getInnerHalfAngle()

Gets the inner half angle used to define the interior conical volume of exclusion.

getOuterHalfAngle

public final double getOuterHalfAngle()

Gets the outer half angle used to define the exterior conical boundary of the volume.

getMinimumClockAngle

public final double getMinimumClockAngle()

Gets the minimum clock angle. In conjunction with MaximumClockAngle (get), this restricts volume to only a wedge-shaped portion of the annular cross-section of the sensor cone. The angle is measured clockwise when looking in the direction of the positive z axis.

getMaximumClockAngle

public final double getMaximumClockAngle()

Gets the maximum clock angle. In conjunction with MinimumClockAngle (get), this restricts volume to only a wedge-shaped portion of the annular cross-section of the sensor cone. The angle is measured clockwise when looking in the direction of the positive z axis.

setHalfAngles

public final void setHalfAngles(double inner,
                                double outer)

Sets the inner and outer half angles of a sensor volume, which are used to define inner and outer conical volumes.

Parameters:

inner - The angle between the principal direction and the boundary of the interior conical volume of exclusion. Defines the interior conical volume of exclusion.

outer - The angle between the principal direction and the external boundary of the volume of the sensor. Defines the conical volume of the sensor.

Throws:

ArgumentOutOfRangeException - The inner and outer half angles must be in the range from 0 to π radians, not inclusive.

ArgumentException - The inner half angle must be less than the outer half angle.

setClockAngles

public final void setClockAngles(double minimum,
                                 double maximum)

Sets the clock angles, which restrict the volume to a wedge-shaped portion of the annular cross-section.

Parameters:

minimum - The angle between the positive x-axis and the opening edge of the restricted annular cross-section. The angle is measured clockwise when looking in the direction of the positive z axis. In conjunction with the maximum, restricts sensor volume to a portion of the annular cross-section of a cone.

maximum - The angle between the positive x-axis and the closing edge of the restricted annular cross-section. The angle is measured clockwise when looking in the direction of the positive z axis. In conjunction with the minimum, restricts the sensor volume to a portion of the annular cross-section of a cone.

Throws:

ArgumentOutOfRangeException - The minimum and maximum clock angles must be in the range from -2π to 2π radians.

ArgumentException - The minimum clock angle must be less than the maximum clock angle.

encloses

public boolean encloses(@Nonnull
                        Cartesian point)

Indicates if the provided point is inside the volume.

The point parameter must be expressed in the same coordinate frame that the volume is defined in.

Specified by:

encloses in class Solid

Parameters:

point - The point to evaluate.

Returns:

true if the point is inside the volume and false if the point lies on the boundary or outside of the volume.

getEnclosureDescriptions

public EnclosureDescriptionCollection getEnclosureDescriptions()

Gets the list of descriptions for the enclosure functions for this solid.

Specified by:

getEnclosureDescriptions in class Solid

Returns:

The list of enclosure descriptions.

getProjection

public SensorProjection getProjection(Ellipsoid ellipsoid,
                                      @Nonnull
                                      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.

Specified by:

getProjection in class SensorFieldOfView

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.