Package hec.map

Class WorldRegion

java.lang.Object
hec.map.WorldRegion
All Implemented Interfaces:
Shape, Serializable, Cloneable
public class WorldRegion extends Object implements Serializable, Cloneable, Shape
Represents points in world coordinate space.
See Also:

  • Field Details

  • Constructor Details

    • WorldRegion

      public WorldRegion()

  • Method Details

    • getOutline

      public WorldLine getOutline()
      Returns a line that is the perimeter of the polygon.
      Returns:

    • getOutline

      public WorldLine getOutline(WorldLine line)
      Returns a line the is the perimeter of the polygon. Takes as input a worldline that will be filled with the points.
      Parameters:
      line -
      Returns:

    • getArea

      public double getArea()
      compute the area of this region
      Returns:
      the area in world coord^2

    • clone

      public Object clone()
      Creates a new object of the same class as this object.
      It then initializes each of the new object's fields by assigning it the same value as the corresponding field in this object. No
      constructor is called.
      Overrides:
      clone in class Object

    • getWorldRectBounds

      public WorldRect getWorldRectBounds()

    • getCentroid

      public WorldPt getCentroid()
      Computes the centoird of the polygon where the Cx and Cy points are defined by Cx = SUM[(Xi + Xi+1) * (Xi * Yi+1 - Xi+1 * Yi)] / 6 / A Cy = SUM[(Yi + Yi+1) * (Xi * Yi+1 - Xi+1 * Yi)] / 6 / A The value A is the area of the polygon
      Returns:
      a world point that contains the centroid

    • getCenterPt

      public WorldPt getCenterPt()
      Returns a reference point that is the average of all of the X values and all of the y values. It is stated by the following formula Cx = (X1+X2+....+Xn)/ num_points Cy = (Y1+Y2+....+Yn)/ num_points.
      Returns:

    • contains

      public boolean contains(WorldPt wpt)

    • insertPt

      public boolean insertPt(WorldPt wpt)
      Insert a point into the region between the two points where the distace between the point to insert and the line segment made between the existing two points is the shortest.
      Parameters:
      wpt -
      Returns:
      true if successful

    • insertPt

      public boolean insertPt(WorldPt wpt, double tol)

    • removePt

      public boolean removePt(WorldPt wpt, double tol)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • parseString

      public void parseString(String str)

    • invalidate

      public void invalidate()

    • isClockwise

      public boolean isClockwise()

    • reversePts

      public void reversePts()

    • isSelfIntersecting

      public boolean isSelfIntersecting()

    • intersect

      public boolean intersect(WorldLine line)
      check to see if this WorldRegion intersect the WorldLine line
      Parameters:
      line - the WorldLine to check
      Returns:
      true if they intersect

    • intersection

      public WorldPt intersection(WorldLine line)

    • contains

      public boolean contains(double x, double y)
      Tests if the specified coordinates are inside the boundary of the Shape.
      Specified by:
      contains in interface Shape
      Parameters:
      x - the specified x coordinate
      y - the specified y coordinate
      Returns:
      true if the specified coordinates are inside the Shape boundary; false otherwise.

    • contains

      public boolean contains(double x, double y, double w, double h)
      Tests if the interior of the Shape entirely contains the specified rectangular area. All coordinates that lie inside the rectangular area must lie within the Shape for the entire rectanglar area to be considered contained within the Shape.

      This method might conservatively return false when:

      • the intersect method returns true and
      • the calculations to determine whether or not the Shape entirely contains the rectangular area are prohibitively expensive.
      This means that this method might return false even though the Shape contains the rectangular area. The Area class can be used to perform more accurate computations of geometric intersection for any Shape object if a more precise answer is required.
      Specified by:
      contains in interface Shape
      Parameters:
      x - the x coordinate of the specified rectangular area
      y - the y coordinate of the specified rectangular area
      w - the width of the specified rectangular area
      h - the height of the specified rectangular area
      Returns:
      true if the interior of the Shape entirely contains the specified rectangular area; false otherwise or, if the Shape contains the rectangular area and the intersects method returns true and the containment calculations would be too expensive to perform.
      See Also:

    • contains

      public boolean contains(WorldRegion wRegion)
      Test for containment. This method tests to see if the WorldRegion parameter is contained within this WorldRegion. The test is as follows, 1) all points of the WorldRegion must be contained within this WorldRegion. 2) No edge lines can interset any part of the border of this WorldRegion
      Parameters:
      wRegion - WorldRegion
      Returns:
      boolean true if the wRegion parameter is contained within this Region, otherwise false.

    • contains

      public boolean contains(Rectangle2D r)
      Tests if the interior of the Shape entirely contains the specified Rectangle2D. This method might conservatively return false when:
      • the intersect method returns true and
      • the calculations to determine whether or not the Shape entirely contains the Rectangle2D are prohibitively expensive.
      This means that this method might return false even though the Shape contains the Rectangle2D. The Area class can be used to perform more accurate computations of geometric intersection for any Shape object if a more precise answer is required.
      Specified by:
      contains in interface Shape
      Parameters:
      r - The specified Rectangle2D
      Returns:
      true if the interior of the Shape entirely contains the Rectangle2D; false otherwise or, if the Shape contains the Rectangle2D and the intersects method returns true and the containment calculations would be too expensive to perform.
      See Also:

    • getPathIterator

      public PathIterator getPathIterator(AffineTransform at)
      Returns an iterator object that iterates along the Shape boundary and provides access to the geometry of the Shape outline. If an optional AffineTransform is specified, the coordinates returned in the iteration are transformed accordingly.

      Each call to this method returns a fresh PathIterator object that traverses the geometry of the Shape object independently from any other PathIterator objects in use at the same time.

      It is recommended, but not guaranteed, that objects implementing the Shape interface isolate iterations that are in process from any changes that might occur to the original object's geometry during such iterations.

      Before using a particular implementation of the Shape interface in more than one thread simultaneously, refer to its documentation to verify that it guarantees that iterations are isolated from modifications.

      Specified by:
      getPathIterator in interface Shape
      Parameters:
      at - an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if untransformed coordinates are desired
      Returns:
      a new PathIterator object, which independently traverses the geometry of the Shape.

    • getPathIterator

      public PathIterator getPathIterator(AffineTransform at, double flatness)
      Returns an iterator object that iterates along the Shape boundary and provides access to a flattened view of the Shape outline geometry.

      Only SEG_MOVETO, SEG_LINETO, and SEG_CLOSE point types are returned by the iterator.

      If an optional AffineTransform is specified, the coordinates returned in the iteration are transformed accordingly.

      The amount of subdivision of the curved segments is controlled by the flatness parameter, which specifies the maximum distance that any point on the unflattened transformed curve can deviate from the returned flattened path segments. Note that a limit on the accuracy of the flattened path might be silently imposed, causing very small flattening parameters to be treated as larger values. This limit, if there is one, is defined by the particular implementation that is used.

      Each call to this method returns a fresh PathIterator object that traverses the Shape object geometry independently from any other PathIterator objects in use at the same time.

      It is recommended, but not guaranteed, that objects implementing the Shape interface isolate iterations that are in process from any changes that might occur to the original object's geometry during such iterations.

      Before using a particular implementation of this interface in more than one thread simultaneously, refer to its documentation to verify that it guarantees that iterations are isolated from modifications.

      Specified by:
      getPathIterator in interface Shape
      Parameters:
      at - an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if untransformed coordinates are desired
      flatness - the maximum distance that the line segments used to approximate the curved segments are allowed to deviate from any point on the original curve
      Returns:
      a new PathIterator that independently traverses the Shape geometry.

    • intersects

      public boolean intersects(double x, double y, double w, double h)
      Tests if the interior of the Shape intersects the interior of a specified rectangular area. The rectangular area is considered to intersect the Shape if any point is contained in both the interior of the Shape and the specified rectangular area.

      This method might conservatively return true when:

      • there is a high probability that the rectangular area and the Shape intersect, but
      • the calculations to accurately determine this intersection are prohibitively expensive.
      This means that this method might return true even though the rectangular area does not intersect the Shape. The Area class can be used to perform more accurate computations of geometric intersection for any Shape object if a more precise answer is required.
      Specified by:
      intersects in interface Shape
      Parameters:
      x - the x coordinate of the specified rectangular area
      y - the y coordinate of the specified rectangular area
      w - the width of the specified rectangular area
      h - the height of the specified rectangular area
      Returns:
      true if the interior of the Shape and the interior of the rectangular area intersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform; false otherwise.
      See Also:

    • intersects

      public boolean intersects(Rectangle2D r)
      Tests if the interior of the Shape intersects the interior of a specified Rectangle2D. This method might conservatively return true when:
      • there is a high probability that the Rectangle2D and the Shape intersect, but
      • the calculations to accurately determine this intersection are prohibitively expensive.
      This means that this method might return true even though the Rectangle2D does not intersect the Shape.
      Specified by:
      intersects in interface Shape
      Parameters:
      r - the specified Rectangle2D
      Returns:
      true if the interior of the Shape and the interior of the specified Rectangle2D intersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform; false otherwise.
      See Also:

    • getBounds

      public Rectangle getBounds()
      Returns an integer Rectangle that completely encloses the Shape. Note that there is no guarantee that the returned Rectangle is the smallest bounding box that encloses the Shape, only that the Shape lies entirely within the indicated Rectangle. The returned Rectangle might also fail to completely enclose the Shape if the Shape overflows the limited range of the integer data type. The getBounds2D method generally returns a tighter bounding box due to its greater flexibility in representation.
      Specified by:
      getBounds in interface Shape
      Returns:
      an integer Rectangle that completely encloses the Shape.
      See Also:

    • getBounds2D

      public Rectangle2D getBounds2D()
      Returns a high precision and more accurate bounding box of the Shape than the getBounds method. Note that there is no guarantee that the returned Rectangle2D is the smallest bounding box that encloses the Shape, only that the Shape lies entirely within the indicated Rectangle2D. The bounding box returned by this method is usually tighter than that returned by the getBounds method and never fails due to overflow problems since the return value can be an instance of the Rectangle2D that uses double precision values to store the dimensions.
      Specified by:
      getBounds2D in interface Shape
      Returns:
      an instance of Rectangle2D that is a high-precision bounding box of the Shape.
      See Also:

    • contains

      public boolean contains(Point2D p)
      Tests if a specified Point2D is inside the boundary of the Shape.
      Specified by:
      contains in interface Shape
      Parameters:
      p - a specified Point2D
      Returns:
      true if the specified Point2D is inside the boundary of the Shape; false otherwise.

    • init

      public void init(WorldRegion region)
      make a copy of the region's points into this WorldRegion.
      Parameters:
      region - the region to copy the points from

    • getArea2D

      public Area getArea2D()
      Builds and closes Path2D from the WorldPt objects of this WorldRegion, then constructs an Area from the path.
      Returns:
      Area containing all of the pts of this region.

    • getArea

      public static double getArea(Area area)