agi.foundation.geometry.discrete

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

Class GeometricPrimitiveCoverageGrid

java.lang.Object

agi.foundation.geometry.discrete.GeometricPrimitiveCoverageGrid

All Implemented Interfaces:

ICoverageGrid

Direct Known Subclasses:

ConeCoverageGrid, CuboidCoverageGrid, CylinderCoverageGrid, RectangularPyramidCoverageGrid, SpheroidCoverageGrid, TorusCoverageGrid

public abstract class GeometricPrimitiveCoverageGrid
extends Object
implements ICoverageGrid

The abstract base for simple grids used in the coverage system.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GeometricPrimitiveCoverageGrid() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
abstract List<CoverageGridPoint>	generateGridPoints() Generate the set of grid points.
protected double[]	getGridPointRange(List<Double> grid, int currentIndex) Gets the range in the coordinate that the grid point indicated by currentIndex refers to.
protected double[]	getGridPointRangeWithWrapping(List<Double> grid, int currentIndex) Gets the range in the coordinate that the grid point indicated by currentIndex refers to.
ReferenceFrame	getReferenceFrame() Gets the reference frame in which this grid is defined.
void	setReferenceFrame(ReferenceFrame value) Sets the reference frame in which this grid is defined.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeometricPrimitiveCoverageGrid

protected GeometricPrimitiveCoverageGrid()

Initializes a new instance.

Method Detail

getReferenceFrame

public ReferenceFrame getReferenceFrame()

Gets the reference frame in which this grid is defined.

Specified by:

getReferenceFrame in interface ICoverageGrid

setReferenceFrame

public void setReferenceFrame(ReferenceFrame value)

Sets the reference frame in which this grid is defined.

generateGridPoints

public abstract List<CoverageGridPoint> generateGridPoints()

Generate the set of grid points.

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

Specified by:

generateGridPoints in interface ICoverageGrid

Returns:

The set of grid points.

getGridPointRange

@Nonnull
protected final double[] getGridPointRange(@Nonnull
                                                     List<Double> grid,
                                                     int currentIndex)

Gets the range in the coordinate that the grid point indicated by currentIndex refers to.

Parameters:

grid - The sorted grid of values in a single coordinate.

currentIndex - The index of the current grid point.

Returns:

The lower and upper bound of the indicated grid point's span. On each end of the span the point returned will be halfway to the next grid point, or the point itself in case this point is an endpoint.

getGridPointRangeWithWrapping

@Nonnull
protected final double[] getGridPointRangeWithWrapping(@Nonnull
                                                                 List<Double> grid,
                                                                 int currentIndex)

Gets the range in the coordinate that the grid point indicated by currentIndex refers to. This range wraps from the maximum index to zero and is most useful when extracting the range on an angular coordinate.

Parameters:

grid - The sorted grid of values in a single coordinate.

currentIndex - The index of the current grid point.

Returns:

The lower and upper bound of the indicated grid point's span. On each end of the span the point returned will be halfway to the next grid point, or the point itself in case this point is an endpoint.