agi.foundation.geometry

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

Class ConvexBoundaryEllipsoidSurfaceRegionBuilder

java.lang.Object

agi.foundation.geometry.EllipsoidSurfaceRegionBuilder

agi.foundation.geometry.ConvexBoundaryEllipsoidSurfaceRegionBuilder

All Implemented Interfaces:

IGetEllipsoidSurfaceRegion, IGetEllipsoidSurfaceRegionHole

public class ConvexBoundaryEllipsoidSurfaceRegionBuilder
extends EllipsoidSurfaceRegionBuilder

An EllipsoidSurfaceRegionBuilder builder that takes unorganized input points and forms a convex hull that wraps them into a region. This hull is created by projecting the input points onto a plane centered at the centroid of the input points and connecting boundary nodes via geodesics.

This region's centroid will be with respect to all input points, not the final boundary. For large regions, the technique used will be subject to distortions.

Constructor Summary

Constructors

Constructor and Description
ConvexBoundaryEllipsoidSurfaceRegionBuilder() Initializes a new builder.
ConvexBoundaryEllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface, Iterable<Cartographic> unorganizedNodes) Initializes a new builder.
ConvexBoundaryEllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface, Iterable<Cartographic> unorganizedNodes, Cartographic referencePoint, boolean referencePointInsideRegion) Initializes a new builder.

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.
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.
ArrayList<Cartographic>	getUnorganizedNodes() Gets the unorganized nodes that will form the surface boundary.
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.
void	setUnorganizedNodes(ArrayList<Cartographic> value) Sets the unorganized nodes that will form the surface boundary.

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

ConvexBoundaryEllipsoidSurfaceRegionBuilder

public ConvexBoundaryEllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface,
                                                   @Nonnull
                                                   Iterable<Cartographic> unorganizedNodes,
                                                   @Nonnull
                                                   Cartographic referencePoint,
                                                   boolean referencePointInsideRegion)

Initializes a new builder. The default granularity, π / 360.0, is used.

Parameters:

referenceSurface - The ellipsoid on which this surface is defined.

unorganizedNodes - A list of unorganized points that compose the desired 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.

ConvexBoundaryEllipsoidSurfaceRegionBuilder

public ConvexBoundaryEllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface,
                                                   @Nonnull
                                                   Iterable<Cartographic> unorganizedNodes)

Initializes a new builder. The default granularity, π / 360.0, is used.

Parameters:

referenceSurface - The ellipsoid on which this surface is defined.

unorganizedNodes - A list of unorganized points that compose the desired region.

ConvexBoundaryEllipsoidSurfaceRegionBuilder

public ConvexBoundaryEllipsoidSurfaceRegionBuilder()

Initializes a new builder. The default granularity, π / 360.0, is used.

Method Detail

getUnorganizedNodes

public final ArrayList<Cartographic> getUnorganizedNodes()

Gets the unorganized nodes that will form the surface boundary.

setUnorganizedNodes

public final void setUnorganizedNodes(ArrayList<Cartographic> value)

Sets the unorganized nodes that will form the surface boundary.

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.