agi.foundation.geometry

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

Class SpecifiedCurveEllipsoidSurfaceRegionBuilder

java.lang.Object

agi.foundation.geometry.EllipsoidSurfaceRegionBuilder

agi.foundation.geometry.SpecifiedCurveEllipsoidSurfaceRegionBuilder

All Implemented Interfaces:

IGetEllipsoidSurfaceRegion, IGetEllipsoidSurfaceRegionHole

public class SpecifiedCurveEllipsoidSurfaceRegionBuilder
extends EllipsoidSurfaceRegionBuilder

An EllipsoidSurfaceRegionBuilder that builds a region based upon an input BoundaryCurve (get / set).

Constructor Summary

Constructors

Constructor and Description
SpecifiedCurveEllipsoidSurfaceRegionBuilder() Initializes an instance of the surface region builder.
SpecifiedCurveEllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface, double granularity, EllipsoidSurfaceCurve curve) Initializes an instance of the surface region builder.
SpecifiedCurveEllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface, EllipsoidSurfaceCurve curve) Initializes an instance of the surface region builder.
SpecifiedCurveEllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface, EllipsoidSurfaceCurve curve, Cartographic referencePoint, boolean referencePointInsideRegion) Initializes an instance of the surface region 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.
EllipsoidSurfaceCurve	getBoundaryCurve() Gets the EllipsoidSurfaceCurve that defines 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	setBoundaryCurve(EllipsoidSurfaceCurve value) Sets the EllipsoidSurfaceCurve that defines 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

SpecifiedCurveEllipsoidSurfaceRegionBuilder

public SpecifiedCurveEllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface,
                                                   double granularity,
                                                   EllipsoidSurfaceCurve curve)

Initializes an instance of the surface region builder.

Parameters:

referenceSurface - The reference ellipsoid.

granularity - The maximum angular distance between the discrete points with respect to the center of the Ellipsoid (get). A small granularity will yield a more precise representation of the boundary.

curve - A closed curve representing the boundary of the surface region.

SpecifiedCurveEllipsoidSurfaceRegionBuilder

public SpecifiedCurveEllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface,
                                                   EllipsoidSurfaceCurve curve,
                                                   @Nonnull
                                                   Cartographic referencePoint,
                                                   boolean referencePointInsideRegion)

Initializes an instance of the surface region builder. The default granularity, π / 360.0, is used.

Parameters:

referenceSurface - The reference ellipsoid.

curve - A closed curve representing the boundary of 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.

SpecifiedCurveEllipsoidSurfaceRegionBuilder

public SpecifiedCurveEllipsoidSurfaceRegionBuilder(Ellipsoid referenceSurface,
                                                   EllipsoidSurfaceCurve curve)

Initializes an instance of the surface region builder. The default granularity, π / 360.0, is used.

Parameters:

referenceSurface - The reference ellipsoid.

curve - A closed curve representing the boundary of the surface region.

SpecifiedCurveEllipsoidSurfaceRegionBuilder

public SpecifiedCurveEllipsoidSurfaceRegionBuilder()

Initializes an instance of the surface region builder. The default granularity, π / 360.0, is used.

Method Detail

getBoundaryCurve

public final EllipsoidSurfaceCurve getBoundaryCurve()

Gets the EllipsoidSurfaceCurve that defines the surface region.

setBoundaryCurve

public final void setBoundaryCurve(EllipsoidSurfaceCurve value)

Sets the EllipsoidSurfaceCurve that defines 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.