agi.foundation.geometry

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

Class SpecifiedNodesEllipsoidSurfaceRegionBuilder

java.lang.Object

agi.foundation.geometry.EllipsoidSurfaceRegionBuilder

agi.foundation.geometry.SpecifiedNodesEllipsoidSurfaceRegionBuilder

All Implemented Interfaces:

IGetEllipsoidSurfaceRegion, IGetEllipsoidSurfaceRegionHole

public class SpecifiedNodesEllipsoidSurfaceRegionBuilder
extends EllipsoidSurfaceRegionBuilder

An EllipsoidSurfaceRegionBuilder that builds a region based upon input boundary nodes (vertices) and a node connection type.

Constructor Summary

Constructors

Constructor and Description
SpecifiedNodesEllipsoidSurfaceRegionBuilder() Initializes a builder with the ConnectionType (get / set) set to geodesic.
SpecifiedNodesEllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface, double granularity, Iterable<Cartographic> nodes) Initializes a builder with the ConnectionType (get / set) set to geodesic.
SpecifiedNodesEllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface, double granularity, Iterable<Cartographic> nodes, Cartographic referencePoint, boolean referencePointInsideRegion) Initializes a builder with the ConnectionType (get / set) set to geodesic.
SpecifiedNodesEllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface, Iterable<Cartographic> nodes) Initializes a builder with the ConnectionType (get / set) set to geodesic.
SpecifiedNodesEllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface, Iterable<Cartographic> nodes, EllipsoidSurfaceRegionCurveConnectionType connectionType) Initializes a builder with the ConnectionType (get / set) set to geodesic.

Method Summary

Modifier and Type	Method and Description
protected EllipsoidSurfaceRegionHole	buildHole() A method that constructs an EllipsoidSurfaceRegionHole based upon the builder's configuration.
protected EllipsoidSurfaceRegion	buildRegion(List<EllipsoidSurfaceRegionHole> holes) A method that constructs an EllipsoidSurfaceRegion based upon the builder's configuration.
ArrayList<Cartographic>	getBoundaryNodes() Gets the boundary nodes for the surface region.
EllipsoidSurfaceRegionCurveConnectionType	getConnectionType() Gets the EllipsoidSurfaceRegionCurveConnectionType for the surface region.
Cartographic	getReferencePoint() Gets a reference point to manually specify as inside or outside the region, to allow for cases like regions larger than half the globe since the default behavior always selects the smaller portion of the ellipsoid as the region.
Boolean	getReferencePointInsideRegion() Gets the specification for whether the ReferencePoint (get / set) is inside or outside the region.
void	setConnectionType(EllipsoidSurfaceRegionCurveConnectionType value) Sets the EllipsoidSurfaceRegionCurveConnectionType for the surface region.
void	setReferencePoint(Cartographic value) Sets a reference point to manually specify as inside or outside the region, to allow for cases like regions larger than half the globe since the default behavior always selects the smaller portion of the ellipsoid as the region.
void	setReferencePointInsideRegion(Boolean value) Sets the specification for whether the ReferencePoint (get / set) is inside or outside the region.

Methods inherited from class agi.foundation.geometry.EllipsoidSurfaceRegionBuilder

getCentroid, getClosedPoints, getEllipsoidSurfaceRegion, getEllipsoidSurfaceRegionHole, getGranularity, getHoles, getReferenceSurface, setGranularity, setReferenceSurface

Methods inherited from class java.lang.Object

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

Constructor Detail

SpecifiedNodesEllipsoidSurfaceRegionBuilder

public SpecifiedNodesEllipsoidSurfaceRegionBuilder()

Initializes a builder with the ConnectionType (get / set) set to geodesic. The default granularity, π / 360.0, is used.

SpecifiedNodesEllipsoidSurfaceRegionBuilder

public SpecifiedNodesEllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface,
                                                   @Nonnull
                                                   Iterable<Cartographic> nodes)

Initializes a builder with the ConnectionType (get / set) set to geodesic. The default granularity, π / 360.0, is used.

Parameters:

referenceSurface - The ellipsoid on which this surface is defined.

nodes - The boundary nodes for the surface region.

Throws:

ArgumentNullException - Thrown when nodes is null.

SpecifiedNodesEllipsoidSurfaceRegionBuilder

public SpecifiedNodesEllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface,
                                                   @Nonnull
                                                   Iterable<Cartographic> nodes,
                                                   @Nonnull
                                                   EllipsoidSurfaceRegionCurveConnectionType connectionType)

Initializes a builder with the ConnectionType (get / set) set to geodesic. The default granularity, π / 360.0, is used.

Parameters:

referenceSurface - The ellipsoid on which this surface is defined.

nodes - The boundary nodes for the surface region.

connectionType - The type of connection between each node.

Throws:

ArgumentNullException - Thrown when nodes is null.

SpecifiedNodesEllipsoidSurfaceRegionBuilder

public SpecifiedNodesEllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface,
                                                   double granularity,
                                                   @Nonnull
                                                   Iterable<Cartographic> nodes)

Initializes a builder with the ConnectionType (get / set) set to geodesic.

Parameters:

referenceSurface - The ellipsoid on which this surface is defined.

granularity - The separation between points on the border.

nodes - The boundary nodes for the surface region.

Throws:

ArgumentNullException - Thrown when nodes is null.

SpecifiedNodesEllipsoidSurfaceRegionBuilder

public SpecifiedNodesEllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface,
                                                   double granularity,
                                                   @Nonnull
                                                   Iterable<Cartographic> nodes,
                                                   @Nonnull
                                                   Cartographic referencePoint,
                                                   boolean referencePointInsideRegion)

Initializes a builder with the ConnectionType (get / set) set to geodesic.

Parameters:

referenceSurface - The ellipsoid on which this surface is defined.

granularity - The separation between points on the border.

nodes - The boundary nodes for the surface region.

referencePoint - A reference point to manually specify as inside or outside the region, to allow for cases like regions larger than half the globe since the default behavior always selects the smaller portion of the ellipsoid as the region.

referencePointInsideRegion - The specification for whether the referencePoint is inside or outside the region.

Throws:

ArgumentNullException - Thrown when nodes is null.

Method Detail

getBoundaryNodes

@Nonnull
public final ArrayList<Cartographic> getBoundaryNodes()

Gets the boundary nodes for the surface region.

getConnectionType

@Nonnull
public final EllipsoidSurfaceRegionCurveConnectionType getConnectionType()

Gets the EllipsoidSurfaceRegionCurveConnectionType for the surface region.

setConnectionType

public final void setConnectionType(@Nonnull
                                    EllipsoidSurfaceRegionCurveConnectionType value)

Sets the EllipsoidSurfaceRegionCurveConnectionType for the surface region.

getReferencePointInsideRegion

@Nullable
public final Boolean getReferencePointInsideRegion()

Gets the specification for whether the ReferencePoint (get / set) is inside or outside the region.

setReferencePointInsideRegion

public final void setReferencePointInsideRegion(@Nullable
                                                Boolean value)

Sets the specification for whether the ReferencePoint (get / set) is inside or outside the region.

getReferencePoint

@Nonnull
public final Cartographic getReferencePoint()

Gets a reference point to manually specify as inside or outside the region, to allow for cases like regions larger than half the globe since the default behavior always selects the smaller portion of the ellipsoid as the region.

This reference point should not lie exactly on the boundary.

setReferencePoint

public final void setReferencePoint(@Nonnull
                                    Cartographic value)

Sets a reference point to manually specify as inside or outside the region, to allow for cases like regions larger than half the globe since the default behavior always selects the smaller portion of the ellipsoid as the region.

This reference point should not lie exactly on the boundary.

buildHole

protected EllipsoidSurfaceRegionHole buildHole()

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

Specified by:

buildHole in class EllipsoidSurfaceRegionBuilder

Returns:

An EllipsoidSurfaceRegionHole.

buildRegion

protected EllipsoidSurfaceRegion buildRegion(List<EllipsoidSurfaceRegionHole> holes)

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

Specified by:

buildRegion in class EllipsoidSurfaceRegionBuilder

Parameters:

holes - The holes to add to the surface definition.

Returns:

An EllipsoidSurfaceRegion.