agi.foundation.geometry.discrete

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

Class ExtrudedCentralBodyCoverageGrid

java.lang.Object

agi.foundation.geometry.discrete.CentralBodyCoverageGrid

agi.foundation.geometry.discrete.ExtrudedCentralBodyCoverageGrid

All Implemented Interfaces:

ICoverageGrid

public final class ExtrudedCentralBodyCoverageGrid
extends CentralBodyCoverageGrid

A CentralBodyCoverageGrid that takes as input an existing CentralBodyCoverageGrid type and extrudes it in the specified manner to become a three dimensional grid.

Constructor Summary

Constructors

Constructor and Description
ExtrudedCentralBodyCoverageGrid(CentralBodyCoverageGrid centralBodyCoverageGridToExtrude) Initializes an extruded grid with the input underlying grid.
ExtrudedCentralBodyCoverageGrid(CentralBodyCoverageGrid centralBodyCoverageGridToExtrude, Bounds heightBounds, ICoverageGriddingTechnique heightGriddingTechnique) Initializes an extruded grid with the input underlying grid.

Method Summary

Modifier and Type	Method and Description
List<CoverageGridPoint>	generateGridPoints() Generate the set of grid points.
CentralBody	getCentralBody() Gets the central body associated with this grid.
Bounds	getHeightBounds() Gets the height bounds relative to the reference surface of the UnderlyingGrid (get).
ICoverageGriddingTechnique	getHeightGriddingTechnique() Gets the gridding technique used to extrude the UnderlyingGrid (get).
TerrainProvider	getReferenceTerrain() Gets the reference terrain with which the grid points are defined.
boolean	getSaveGridCell() Gets a value indicating whether the grid is to save grid cell information.
CentralBodyCoverageGrid	getUnderlyingGrid() Gets the underlying grid that is extruded.
boolean	getUseCellAreaForWeight() Gets a value indicating whether the grid cell's surface area should be used as the weight.
void	setHeightBounds(Bounds value) Sets the height bounds relative to the reference surface of the UnderlyingGrid (get).
void	setHeightGriddingTechnique(ICoverageGriddingTechnique value) Sets the gridding technique used to extrude the UnderlyingGrid (get).
void	setSaveGridCell(boolean value) Sets a value indicating whether the grid is to save grid cell information.
void	setUseCellAreaForWeight(boolean value) Sets a value indicating whether the grid cell's surface area should be used as the weight.

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

getGridCellBoundaries, getGridCellBoundary, getHeightRelativeToSurface, getReferenceFrame, setCentralBody, setReferenceTerrain

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtrudedCentralBodyCoverageGrid

public ExtrudedCentralBodyCoverageGrid(@Nonnull
                                       CentralBodyCoverageGrid centralBodyCoverageGridToExtrude)

Initializes an extruded grid with the input underlying grid.

Parameters:

centralBodyCoverageGridToExtrude - The existing grid that will be extruded.

Throws:

ArgumentNullException - Thrown if the grid to extrude is null.

ExtrudedCentralBodyCoverageGrid

public ExtrudedCentralBodyCoverageGrid(@Nonnull
                                       CentralBodyCoverageGrid centralBodyCoverageGridToExtrude,
                                       @Nonnull
                                       Bounds heightBounds,
                                       @Nonnull
                                       ICoverageGriddingTechnique heightGriddingTechnique)

Initializes an extruded grid with the input underlying grid.

Parameters:

centralBodyCoverageGridToExtrude - The existing grid that will be extruded.

heightBounds - The bounds for the height coordinate, relative to the surface the UnderlyingGrid (get) was generated on.

heightGriddingTechnique - The technique to use to grid the height coordinate.

Throws:

ArgumentNullException - Thrown if either centralBodyCoverageGridToExtrude or heightGriddingTechnique is null.

Method Detail

getUnderlyingGrid

public final CentralBodyCoverageGrid getUnderlyingGrid()

Gets the underlying grid that is extruded.

getCentralBody

public CentralBody getCentralBody()

Description copied from class: CentralBodyCoverageGrid

Gets the central body associated with this grid.

When GeometricPrimitiveCoverageGrid.generateGridPoints() or CentralBodyCoverageGrid.getHeightRelativeToSurface(double, double) is called, the shape of ReferenceTerrain (get / set) must match CentralBody (get / set).

Overrides:

getCentralBody in class CentralBodyCoverageGrid

getReferenceTerrain

public TerrainProvider getReferenceTerrain()

Gets the reference terrain with which the grid points are defined.

When GeometricPrimitiveCoverageGrid.generateGridPoints() or CentralBodyCoverageGrid.getHeightRelativeToSurface(double, double) is called, the shape of ReferenceTerrain (get / set) must match CentralBody (get / set).

Overrides:

getReferenceTerrain in class CentralBodyCoverageGrid

getUseCellAreaForWeight

public final boolean getUseCellAreaForWeight()

Gets a value indicating whether the grid cell's surface area should be used as the weight.

The input grid must have a grid cell. If this is false then the existing grid point's weight is used.

setUseCellAreaForWeight

public final void setUseCellAreaForWeight(boolean value)

Sets a value indicating whether the grid cell's surface area should be used as the weight.

The input grid must have a grid cell. If this is false then the existing grid point's weight is used.

getSaveGridCell

public final boolean getSaveGridCell()

Gets a value indicating whether the grid is to save grid cell information.

Note that the grid to extrude must have grid cells for this to work.

setSaveGridCell

public final void setSaveGridCell(boolean value)

Sets a value indicating whether the grid is to save grid cell information.

Note that the grid to extrude must have grid cells for this to work.

getHeightBounds

@Nonnull
public final Bounds getHeightBounds()

Gets the height bounds relative to the reference surface of the UnderlyingGrid (get).

setHeightBounds

public final void setHeightBounds(@Nonnull
                                  Bounds value)

Sets the height bounds relative to the reference surface of the UnderlyingGrid (get).

getHeightGriddingTechnique

public final ICoverageGriddingTechnique getHeightGriddingTechnique()

Gets the gridding technique used to extrude the UnderlyingGrid (get).

setHeightGriddingTechnique

public final void setHeightGriddingTechnique(ICoverageGriddingTechnique value)

Sets the gridding technique used to extrude the UnderlyingGrid (get).

generateGridPoints

public List<CoverageGridPoint> generateGridPoints()

Generate the set of grid points.

Note that the type of Point used for the location in the returned GridPoints are either PointFixedOffset or PointCartographic depending upon the underlying grid.

When implementing, note that the space represented by each grid point should not overlap.

Specified by:

generateGridPoints in interface ICoverageGrid

Specified by:

generateGridPoints in class CentralBodyCoverageGrid

Returns:

The set of grid points.

Throws:

IllegalStateException - Thrown if the points do not have overlapping availability.

PropertyInvalidException - Thrown if HeightGriddingTechnique (get / set) is null.