agi.foundation.geometry.shapes

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

Class EllipsoidSurfaceRegion

java.lang.Object

agi.foundation.geometry.shapes.EllipsoidSurfaceRegion

All Implemented Interfaces:

IEquatable<EllipsoidSurfaceRegion>, IGetEllipsoidSurfaceRegion, IGetEllipsoidSurfaceRegionHole

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

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

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

Method Summary

Modifier and Type	Method and Description
ArrayList<EllipsoidSurfaceRegion>	add(EllipsoidSurfaceRegion otherRegion) Adds this region to otherRegion ignoring any holes in either region.
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 (including distance to any hole boundary).
double	checkPointInsideRegionIgnoringHoles(Cartographic point) Checks to see if the given planetodetic point lies inside the boundary, ignoring holes, and returns a heuristic measure of how close the point is to the boundary.
ArrayList<EllipsoidSurfaceRegion>	complement() Complements this region, returning the complement and any holes as regions.
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(EllipsoidSurfaceRegion 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.
List<EllipsoidSurfaceRegionHole>	getHoles() Gets a read only collection of surface regions that denote topological cuts (holes) of this region.
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.
ArrayList<EllipsoidSurfaceRegion>	intersect(EllipsoidSurfaceRegion otherRegion) Intersects this region with otherRegion.
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.
boolean	isPointInsideRegionIgnoringHoles(Cartographic point) Determines whether the given planetodetic point lies inside the region, ignoring any holes.
boolean	isPointInsideRegionIgnoringHolesEpsilon(Cartographic point, double epsilon) Determines whether the given planetodetic point lies inside the region, ignoring any holes.
static ArrayList<EllipsoidSurfaceRegion>	reduce(List<EllipsoidSurfaceRegion> regionsToReduce) Takes a set of input surface regions and reduces them down to the minimum set of regions covering the same surface locations.
static int	rotationDirection(EllipsoidSurfaceRegion region) Computes the rotation sense of the region.
ArrayList<EllipsoidSurfaceRegion>	subtract(EllipsoidSurfaceRegion otherRegion) Subtracts otherRegion from this region.

Methods inherited from class java.lang.Object

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

Method Detail

getHoles

@Nonnull
public final List<EllipsoidSurfaceRegionHole> getHoles()

Gets a read only collection of surface regions that denote topological cuts (holes) of this region. The count of the number of holes is the genus of this surface.

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.

isPointInsideRegionIgnoringHolesEpsilon

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

Determines whether the given planetodetic point lies inside the region, ignoring any holes.

Height above the surface is ignored. The distance from the boundary is approximate.

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.

isPointInsideRegionIgnoringHoles

public final boolean isPointInsideRegionIgnoringHoles(@Nonnull
                                                      Cartographic point)

Determines whether the given planetodetic point lies inside the region, ignoring any holes.

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.

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. The distance from the boundary is approximate.

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.

checkPointInsideRegionIgnoringHoles

public final double checkPointInsideRegionIgnoringHoles(@Nonnull
                                                        Cartographic point)

Checks to see if the given planetodetic point lies inside the boundary, ignoring holes, 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.

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 (including distance to any hole 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.

getEllipsoidSurfaceRegion

public final EllipsoidSurfaceRegion getEllipsoidSurfaceRegion()

Gets the EllipsoidSurfaceRegion.

Specified by:

getEllipsoidSurfaceRegion in interface IGetEllipsoidSurfaceRegion

Returns:

An EllipsoidSurfaceRegion.

getEllipsoidSurfaceRegionHole

public final EllipsoidSurfaceRegionHole getEllipsoidSurfaceRegionHole()

Gets the EllipsoidSurfaceRegionHole.

Creates an EllipsoidSurfaceRegionHole based on this surface region. Any holes in this region will be ignored.

Specified by:

getEllipsoidSurfaceRegionHole in interface IGetEllipsoidSurfaceRegionHole

Returns:

An EllipsoidSurfaceRegionHole.

reduce

@Nonnull
public static ArrayList<EllipsoidSurfaceRegion> reduce(@Nonnull
                                                                 List<EllipsoidSurfaceRegion> regionsToReduce)

Takes a set of input surface regions and reduces them down to the minimum set of regions covering the same surface locations.

Parameters:

regionsToReduce - The list of regions to operate on.

Returns:

The list of reduced regions.

subtract

@Nonnull
public final ArrayList<EllipsoidSurfaceRegion> subtract(@Nullable
                                                                  EllipsoidSurfaceRegion otherRegion)

Subtracts otherRegion from this region.

Parameters:

otherRegion - The region to subtract from this region.

Returns:

Returns the remaining regions. Returns an empty list if there are no intersections or the input is null.

add

@Nonnull
public final ArrayList<EllipsoidSurfaceRegion> add(@Nullable
                                                             EllipsoidSurfaceRegion otherRegion)

Adds this region to otherRegion ignoring any holes in either region.

Parameters:

otherRegion - The region to add to this region.

Returns:

Returns the combined region (union). Returns an empty list if the input is null. Returns this region if this region and otherRegion are disjoint.

intersect

@Nonnull
public final ArrayList<EllipsoidSurfaceRegion> intersect(@Nullable
                                                                   EllipsoidSurfaceRegion otherRegion)

Intersects this region with otherRegion.

Parameters:

otherRegion - The region to intersect with this region.

Returns:

Returns the combined intersection. Returns an empty list if there are no intersections or the input is null.

complement

@Nonnull
public final ArrayList<EllipsoidSurfaceRegion> complement()

Complements this region, returning the complement and any holes as regions.

Returns:

The inverted region.

rotationDirection

public static int rotationDirection(@Nonnull
                                    EllipsoidSurfaceRegion region)

Computes the rotation sense of the region.

Parameters:

region - The input region.

Returns:

The rotation sense. Counter clockwise is 1, clockwise is -1.

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(EllipsoidSurfaceRegion 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<EllipsoidSurfaceRegion>

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)