agi.foundation.geometry.discrete

(agi.foundation.spatial-2024r1.jar)

Class IntersectionWithSurfaceRegionsCoverageGrid

java.lang.Object

agi.foundation.geometry.discrete.CentralBodyCoverageGrid

agi.foundation.geometry.discrete.IntersectionWithSurfaceRegionsCoverageGrid

All Implemented Interfaces:

ICoverageGrid

public class IntersectionWithSurfaceRegionsCoverageGrid
extends CentralBodyCoverageGrid

Represents a set of grid points created by a given CentralBodyCoverageGrid and lying inside a set of EllipsoidSurfaceRegions.

The weight and grid cell settings are carried over from the underlying grid.

Constructor Summary

Constructors

Constructor and Description
IntersectionWithSurfaceRegionsCoverageGrid(CentralBodyCoverageGrid gridPointProvider, EllipsoidSurfaceRegion... intersectingRegions) Construct a new instance based on the generator and down selector passed in.
IntersectionWithSurfaceRegionsCoverageGrid(TerrainProvider terrainProvider, CentralBodyCoverageGrid gridPointProvider, EllipsoidSurfaceRegion... intersectingRegions) Construct a new instance based on the generator and down selector passed in.

Method Summary

Modifier and Type	Method and Description
List<CoverageGridPoint>	generateGridPoints() Calls GeometricPrimitiveCoverageGrid.generateGridPoints() on the GridPointProvider (get), and then selects a subset of the points using the EllipsoidSurfaceRegion.isPointInsideRegion(agi.foundation.coordinates.Cartographic) method.
CentralBodyCoverageGrid	getGridPointProvider() Gets the CentralBodyCoverageGrid that is used to generate the set of GridPoints that this grid will be a subset of.
List<EllipsoidSurfaceRegion>	getSurfaceRegions() Gets a read-only collection of EllipsoidSurfaceRegions that are used to constrain the set of points generated by GridPointProvider (get) to create the subset that will be this grid's points.

Methods inherited from class agi.foundation.geometry.discrete.CentralBodyCoverageGrid

getCentralBody, getGridCellBoundaries, getGridCellBoundary, getHeightRelativeToSurface, getReferenceFrame, getReferenceTerrain, setCentralBody, setReferenceTerrain

Methods inherited from class java.lang.Object

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

Constructor Detail

IntersectionWithSurfaceRegionsCoverageGrid

public IntersectionWithSurfaceRegionsCoverageGrid(@Nonnull
                                                  CentralBodyCoverageGrid gridPointProvider,
                                                  EllipsoidSurfaceRegion... intersectingRegions)

Construct a new instance based on the generator and down selector passed in.

The resolution is set to the resolution of the generator. The fixed frame is set to be the fixed frame of the generator. The gridPointProvider's ReferenceTerrain is not passed along to the new instance. The CentralBody (get / set) used is from the generator.

Parameters:

gridPointProvider - The CentralBodyCoverageGrid used to generate the points, normally the less restrictive of the two.

intersectingRegions - The set of regions to use to select grid points from gridPointProvider.

Throws:

ArgumentNullException - Thrown if gridPointProvider is null, or if null is passed in as an intersectingRegion.

IllegalStateException - Thrown if there is a conflict between the CentralBody (get / set) shape and the shape used in the CentralBodyCoverageGrid and one of the EllipsoidSurfaceRegion objects.

IntersectionWithSurfaceRegionsCoverageGrid

public IntersectionWithSurfaceRegionsCoverageGrid(@Nonnull
                                                  TerrainProvider terrainProvider,
                                                  @Nonnull
                                                  CentralBodyCoverageGrid gridPointProvider,
                                                  EllipsoidSurfaceRegion... intersectingRegions)

Construct a new instance based on the generator and down selector passed in.

Resolution is set to the resolution of the generator. FixedFrame is set to be the FixedFrame of the generator. If terrainProvider is a different ReferenceTerrain than the one found in gridPointProvider the instance will adopt the new terrainProvider without modifying gridPointProvider. The reference frame when using this constructor is set to the terrain provider's fixed frame.

Parameters:

terrainProvider - The TerrainProvider used to generate the height of the grid points.

gridPointProvider - The CentralBodyCoverageGrid used to generate the points, normally the less restrictive of the two.

intersectingRegions - The set of regions to use to select grid points from gridPointProvider.

Throws:

ArgumentNullException - Thrown if terrainProvider or gridPointProvider is null, or if null is passed in as an intersecting region.

IllegalStateException - Thrown if there is a conflict between the ReferenceSurface of the given gridPointProvider and one of the intersectingRegions.

Method Detail

getGridPointProvider

public final CentralBodyCoverageGrid getGridPointProvider()

Gets the CentralBodyCoverageGrid that is used to generate the set of GridPoints that this grid will be a subset of.

getSurfaceRegions

@Nonnull
public final List<EllipsoidSurfaceRegion> getSurfaceRegions()

Gets a read-only collection of EllipsoidSurfaceRegions that are used to constrain the set of points generated by GridPointProvider (get) to create the subset that will be this grid's points. If a point is inside any of the surface regions, it is included in this grid. However, if one of the surface regions is small enough, the GridPointProvider (get) may not have any grid points inside that region.

generateGridPoints

public List<CoverageGridPoint> generateGridPoints()

Calls GeometricPrimitiveCoverageGrid.generateGridPoints() on the GridPointProvider (get), and then selects a subset of the points using the EllipsoidSurfaceRegion.isPointInsideRegion(agi.foundation.coordinates.Cartographic) method.

If ReferenceTerrain (get / set) is configured, the heights of the grid points are determined by that TerrainProvider. Note that the type of Point used for the location in the returned GridPoints are PointCartographic.

Specified by:

generateGridPoints in interface ICoverageGrid

Specified by:

generateGridPoints in class CentralBodyCoverageGrid

Returns:

The grid points.

Throws:

IllegalStateException - Thrown if ReferenceTerrain (get / set) is configured and its shape doesn't match CentralBody (get / set) shape. Thrown if the points do not have overlapping availability.

PropertyInvalidException - Thrown if ReferenceFrame (get) or CentralBody (get / set) is null.