agi.foundation.geometry.shapes

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

Class EllipsoidSurfaceRegionHole

java.lang.Object

agi.foundation.geometry.shapes.EllipsoidSurfaceRegionHole

All Implemented Interfaces:

IEquatable<EllipsoidSurfaceRegionHole>, IGetEllipsoidSurfaceRegion, IGetEllipsoidSurfaceRegionHole

public class EllipsoidSurfaceRegionHole
extends Object
implements IEquatable<EllipsoidSurfaceRegionHole>, IGetEllipsoidSurfaceRegionHole, IGetEllipsoidSurfaceRegion

This class represents a hole in a region of the surface of an Ellipsoid bounded by a closed surface curve.

Various techniques exist to create ellipsoid surface region holes. See ConvexBoundaryEllipsoidSurfaceRegionBuilder, SpecifiedNodesEllipsoidSurfaceRegionBuilder, SpecifiedExtentEllipsoidSurfaceRegionBuilder, and SpecifiedCurveEllipsoidSurfaceRegionBuilder.

Method Summary

Modifier and Type	Method and Description
double	checkPointInsideRegion(Cartographic point) Checks to see if the given planetodetic point lies inside the boundary and returns a heuristic measure of how close the point is to the boundary.
CartographicExtent	computeCartographicExtent() Computes the cartographic bounding box which completely contains the surface region.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsType(EllipsoidSurfaceRegionHole other) Indicates whether the current object is equal to another object of the same type.
EllipsoidSurfaceCurve	getBoundaryCurve() Gets the closed curve defining the boundary of the surface region.
Cartographic	getCentroid() Gets the point which represents a single planetodetic location for the overall area of the region.
EllipsoidSurfaceRegion	getEllipsoidSurfaceRegion() Gets the EllipsoidSurfaceRegion.
EllipsoidSurfaceRegionHole	getEllipsoidSurfaceRegionHole() Gets the EllipsoidSurfaceRegionHole.
Ellipsoid	getReferenceSurface() Gets the reference surface on which the region is represented by a closed boundary curve.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
boolean	isPointInsideRegion(Cartographic point) Determines whether the given planetodetic point lies inside the region.
boolean	isPointInsideRegionEpsilon(Cartographic point, double epsilon) Determines whether the given planetodetic point lies inside the region.

Methods inherited from class java.lang.Object

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

Method Detail

getCentroid

@Nonnull
public Cartographic getCentroid()

Gets the point which represents a single planetodetic location for the overall area of the region.

getReferenceSurface

@Nonnull
public final Ellipsoid getReferenceSurface()

Gets the reference surface on which the region is represented by a closed boundary curve.

getBoundaryCurve

@Nonnull
public final EllipsoidSurfaceCurve getBoundaryCurve()

Gets the closed curve defining the boundary of the surface region.

isPointInsideRegionEpsilon

public final boolean isPointInsideRegionEpsilon(@Nonnull
                                                Cartographic point,
                                                double epsilon)

Determines whether the given planetodetic point lies inside the region.

Height above the surface is ignored. A negative epsilon effectively shrinks the region, a positive value effectively inflates the region.

Parameters:

point - The planetodetic point to test.

epsilon - The distance from the boundary that is still considered within the region.

Returns:

true if the point lies inside the boundary; otherwise false.

isPointInsideRegion

public final boolean isPointInsideRegion(@Nonnull
                                         Cartographic point)

Determines whether the given planetodetic point lies inside the region.

Height above the surface is ignored. The results may not be as expected when exactly on a boundary.

Parameters:

point - The planetodetic point to test.

Returns:

true if the point lies inside the boundary; otherwise false.

checkPointInsideRegion

public final double checkPointInsideRegion(@Nonnull
                                           Cartographic point)

Checks to see if the given planetodetic point lies inside the boundary and returns a heuristic measure of how close the point is to the boundary.

Parameters:

point - The planetodetic point to check.

Returns:

Returns a positive value if the point lies inside the boundary and negative if it is outside. The value represents the distance between the point and the nearest point on the boundary directly in between the given point and the Centroid (get). This can be used as a heuristic measure of how close the point is to the boundary.

computeCartographicExtent

@Nonnull
public final CartographicExtent computeCartographicExtent()

Computes the cartographic bounding box which completely contains the surface region. If the region contains either pole, the extent will reflect that in the north and south latitude values.

Returns:

An object representing the bounding box containing the region.

getEllipsoidSurfaceRegionHole

public final EllipsoidSurfaceRegionHole getEllipsoidSurfaceRegionHole()

Gets the EllipsoidSurfaceRegionHole.

Specified by:

getEllipsoidSurfaceRegionHole in interface IGetEllipsoidSurfaceRegionHole

Returns:

An EllipsoidSurfaceRegionHole.

getEllipsoidSurfaceRegion

public final EllipsoidSurfaceRegion getEllipsoidSurfaceRegion()

Gets the EllipsoidSurfaceRegion.

Creates an EllipsoidSurfaceRegion based on this hole.

Specified by:

getEllipsoidSurfaceRegion in interface IGetEllipsoidSurfaceRegion

Returns:

An EllipsoidSurfaceRegion.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

equalsType

public final boolean equalsType(EllipsoidSurfaceRegionHole other)

Description copied from interface: IEquatable

Indicates whether the current object is equal to another object of the same type.

Specified by:

equalsType in interface IEquatable<EllipsoidSurfaceRegionHole>

Parameters:

other - An object to compare with this object.

Returns:

true if the current object is equal to the other parameter; otherwise, false.

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)