agi.foundation.geometry

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

Class EllipsoidSurfaceRegionBuilder

java.lang.Object

agi.foundation.geometry.EllipsoidSurfaceRegionBuilder

All Implemented Interfaces:

IGetEllipsoidSurfaceRegion, IGetEllipsoidSurfaceRegionHole

Direct Known Subclasses:

ConvexBoundaryEllipsoidSurfaceRegionBuilder, SpecifiedCurveEllipsoidSurfaceRegionBuilder, SpecifiedExtentEllipsoidSurfaceRegionBuilder, SpecifiedNodesEllipsoidSurfaceRegionBuilder

public abstract class EllipsoidSurfaceRegionBuilder
extends Object
implements IGetEllipsoidSurfaceRegion, IGetEllipsoidSurfaceRegionHole

Creates an EllipsoidSurfaceRegion or EllipsoidSurfaceRegionHole based upon the set properties.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EllipsoidSurfaceRegionBuilder() Initializes a new instance.
protected	EllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface) Initializes a new instance with the specified ellipsoid.
protected	EllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface, double granularity) Initializes a new instance with the specified ellipsoid and border granularity.

Method Summary

Modifier and Type	Method and Description
protected abstract EllipsoidSurfaceRegionHole	buildHole() A method that constructs an EllipsoidSurfaceRegionHole based upon the builder's configuration.
protected abstract EllipsoidSurfaceRegion	buildRegion(List<EllipsoidSurfaceRegionHole> holes) A method that constructs an EllipsoidSurfaceRegion based upon the builder's configuration.
protected Cartesian	getCentroid(ArrayList<Cartographic> nodes) Computes the centroid of the input points.
protected static ArrayList<Cartographic>	getClosedPoints(ArrayList<Cartographic> points) Closes a set of input points by checking the final point.
EllipsoidSurfaceRegion	getEllipsoidSurfaceRegion() Gets the EllipsoidSurfaceRegion.
EllipsoidSurfaceRegionHole	getEllipsoidSurfaceRegionHole() Gets the EllipsoidSurfaceRegionHole.
double	getGranularity() Gets the granularity of the EllipsoidSurfaceRegion's borders.
ArrayList<IGetEllipsoidSurfaceRegionHole>	getHoles() Gets EllipsoidSurfaceRegionBuilders that describe the holes in the produced surface region.
Ellipsoid	getReferenceSurface() Gets the Ellipsoid upon which the surface region will be defined.
void	setGranularity(double value) Sets the granularity of the EllipsoidSurfaceRegion's borders.
void	setReferenceSurface(Ellipsoid value) Sets the Ellipsoid upon which the surface region will be defined.

Methods inherited from class java.lang.Object

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

Constructor Detail

EllipsoidSurfaceRegionBuilder

protected EllipsoidSurfaceRegionBuilder()

Initializes a new instance.

EllipsoidSurfaceRegionBuilder

protected EllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface)

Initializes a new instance with the specified ellipsoid.

Parameters:

referenceSurface - The ellipsoid on which this region is defined.

EllipsoidSurfaceRegionBuilder

protected EllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface,
                                        double granularity)

Initializes a new instance with the specified ellipsoid and border granularity.

Parameters:

referenceSurface - The ellipsoid on which this surface is defined.

granularity - The separation between points on the border.

Method Detail

getReferenceSurface

public final Ellipsoid getReferenceSurface()

Gets the Ellipsoid upon which the surface region will be defined.

setReferenceSurface

public final void setReferenceSurface(Ellipsoid value)

Sets the Ellipsoid upon which the surface region will be defined.

getGranularity

public final double getGranularity()

Gets the granularity of the EllipsoidSurfaceRegion's borders. By default this is π / 360.0.

setGranularity

public final void setGranularity(double value)

Sets the granularity of the EllipsoidSurfaceRegion's borders. By default this is π / 360.0.

getHoles

@Nonnull
public final ArrayList<IGetEllipsoidSurfaceRegionHole> getHoles()

Gets EllipsoidSurfaceRegionBuilders that describe the holes in the produced surface region.

buildHole

@Nonnull
protected abstract EllipsoidSurfaceRegionHole buildHole()

A method that constructs an EllipsoidSurfaceRegionHole based upon the builder's configuration.

Returns:

An EllipsoidSurfaceRegionHole.

buildRegion

@Nonnull
protected abstract EllipsoidSurfaceRegion buildRegion(@Nullable
                                                                List<EllipsoidSurfaceRegionHole> holes)

A method that constructs an EllipsoidSurfaceRegion based upon the builder's configuration.

Parameters:

holes - The holes to add to the surface definition.

Returns:

An EllipsoidSurfaceRegion.

getClosedPoints

@Nonnull
protected static ArrayList<Cartographic> getClosedPoints(@Nonnull
                                                                   ArrayList<Cartographic> points)

Closes a set of input points by checking the final point. If the final point is equal to the initial point, the set of points is returned. If not, then the initial point is added to the end of the list of points.

Parameters:

points - The list of points to close.

Returns:

The points where point[0] == point[n] where n = final point.

getCentroid

@Nonnull
protected final Cartesian getCentroid(@Nonnull
                                                ArrayList<Cartographic> nodes)

Computes the centroid of the input points.

Parameters:

nodes - The nodes, of which the centroid is sought.

Returns:

The centroid.

getEllipsoidSurfaceRegion

public EllipsoidSurfaceRegion getEllipsoidSurfaceRegion()

Gets the EllipsoidSurfaceRegion.

This method calls EllipsoidSurfaceRegionBuilder.buildRegion(java.util.List<agi.foundation.geometry.shapes.EllipsoidSurfaceRegionHole>).

Specified by:

getEllipsoidSurfaceRegion in interface IGetEllipsoidSurfaceRegion

Returns:

An EllipsoidSurfaceRegion.

getEllipsoidSurfaceRegionHole

public EllipsoidSurfaceRegionHole getEllipsoidSurfaceRegionHole()

Gets the EllipsoidSurfaceRegionHole.

This methods calls EllipsoidSurfaceRegionBuilder.buildHole().

Specified by:

getEllipsoidSurfaceRegionHole in interface IGetEllipsoidSurfaceRegionHole

Returns:

An EllipsoidSurfaceRegionHole.