Package loci.common
Class Region
java.lang.Object
loci.common.Region
public class Region
extends java.lang.Object
A class for representing a rectangular region.
This class is very similar to
Rectangle
;
it mainly exists to avoid problems with AWT, JNI and headless operation.-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and Type Method Description boolean
containsPoint(int xc, int yc)
Returns true if the point specified by the given X and Y coordinates is contained within this region.boolean
equals(java.lang.Object o)
int
hashCode()
Region
intersection(Region r)
Returns a Region representing the intersection of this Region with the given Region.boolean
intersects(Region r)
java.lang.String
toString()
-
Field Details
-
Constructor Details
-
Method Details
-
intersects
- Parameters:
r
- the region to check for intersection- Returns:
- true if this region intersects the given region
- See Also:
Rectangle.intersects(java.awt.Rectangle)
-
intersection
Returns a Region representing the intersection of this Region with the given Region. If the two Regions do not intersect, the result is an empty Region.- Parameters:
r
- the region for which to calculate an intersection (or overlap)- Returns:
- a Region representing the intersection (overlap) of the two Regions. If the two Regions have no common area, then the width and/or height of the returned Region will be 0. null is never returned.
-
containsPoint
public boolean containsPoint(int xc, int yc)Returns true if the point specified by the given X and Y coordinates is contained within this region.- Parameters:
xc
- the integer X coordinate of a pointyc
- the integer Y coordinate of a point- Returns:
- true if this Region encloses the given point
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-