Region (Aspose.Drawing for Java 25.10 API Documentation)

java.lang.Object
- com.aspose.drawing.Region

All Implemented Interfaces:

com.aspose.ms.System.IDisposable
```
public final class Region
extends Object
implements com.aspose.ms.System.IDisposable
```
Describes the interior of a graphics shape composed of rectangles and paths. This class cannot be inherited.

Constructor Summary

Constructors
Constructor and Description
`Region()` Initializes a new instance of the `Region` class.
`Region(GraphicsPath path)` Initializes a new instance of the `Region` class with the specified `GraphicsPath`.
`Region(Rectangle rect)` Initializes a new instance of the `Region` class from the specified `Rectangle` structure.
`Region(RectangleF rect)` Initializes a new instance of the `Region` class from the specified `RectangleF` structure.
`Region(RegionData rgnData)` Initializes a new instance of the `Region` class from the specified data.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`complement(GraphicsPath path)` Updates this `Region` to contain the portion of the specified `GraphicsPath` that does not intersect with this `Region`.
`void`	`complement(Rectangle rect)` Updates this `Region` to contain the portion of the specified `Rectangle` structure that does not intersect with this `Region`.
`void`	`complement(RectangleF rect)` Updates this `Region` to contain the portion of the specified `RectangleF` structure that does not intersect with this `Region`.
`void`	`complement(Region region)` Updates this `Region` to contain the portion of the specified `Region` that does not intersect with this `Region`.
`Region`	`deepClone()` Creates an exact copy of this `Region`.
`void`	`dispose()` Releases all resources used by this `Region`.
`boolean`	`equals(Region region, Graphics g)` Tests whether the specified `Region` is identical to this `Region` on the specified drawing surface.
`void`	`exclude(GraphicsPath path)` Updates this `Region` to contain only the portion of its interior that does not intersect with the specified `GraphicsPath`.
`void`	`exclude(Rectangle rect)` Updates this `Region` to contain only the portion of its interior that does not intersect with the specified `Rectangle` structure.
`void`	`exclude(RectangleF rect)` Updates this `Region` to contain only the portion of its interior that does not intersect with the specified `RectangleF` structure.
`void`	`exclude(Region region)` Updates this `Region` to contain only the portion of its interior that does not intersect with the specified `Region`.
`RectangleF`	`getBounds(Graphics g)` Gets a `RectangleF` structure that represents a rectangle that bounds this `Region` on the drawing surface of a `Graphics` object.
`RegionData`	`getRegionData()` Returns a `RegionData` that represents the information that describes this `Region`.
`RectangleF[]`	`getRegionScans(Matrix matrix)` Returns an array of `RectangleF` structures that approximate this `Region` after the specified matrix transformation is applied.
`void`	`intersect(GraphicsPath path)` Updates this `Region` to the intersection of itself with the specified `GraphicsPath`.
`void`	`intersect(Rectangle rect)` Updates this `Region` to the intersection of itself with the specified `Rectangle` structure.
`void`	`intersect(RectangleF rect)` Updates this `Region` to the intersection of itself with the specified `RectangleF` structure.
`void`	`intersect(Region region)` Updates this `Region` to the intersection of itself with the specified `Region`.
`boolean`	`isEmpty(Graphics g)` Tests whether this `Region` has an empty interior on the specified drawing surface.
`boolean`	`isInfinite(Graphics g)` Tests whether this `Region` has an infinite interior on the specified drawing surface.
`boolean`	`isVisible(float x, float y)` Tests whether the specified point is contained within this `Region`.
`boolean`	`isVisible(float x, float y, float width, float height)` Tests whether any portion of the specified rectangle is contained within this `Region`.
`boolean`	`isVisible(float x, float y, float width, float height, Graphics g)` Tests whether any portion of the specified rectangle is contained within this `Region` when drawn using the specified `Graphics`.
`boolean`	`isVisible(float x, float y, Graphics g)` Tests whether the specified point is contained within this `Region` when drawn using the specified `Graphics`.
`boolean`	`isVisible(int x, int y, Graphics g)` Tests whether the specified point is contained within this `Region` object when drawn using the specified `Graphics` object.
`boolean`	`isVisible(int x, int y, int width, int height)` Tests whether any portion of the specified rectangle is contained within this `Region`.
`boolean`	`isVisible(int x, int y, int width, int height, Graphics g)` Tests whether any portion of the specified rectangle is contained within this `Region` when drawn using the specified `Graphics`.
`boolean`	`isVisible(Point point)` Tests whether the specified `Point` structure is contained within this `Region`.
`boolean`	`isVisible(PointF point)` Tests whether the specified `PointF` structure is contained within this `Region`.
`boolean`	`isVisible(PointF point, Graphics g)` Tests whether the specified `PointF` structure is contained within this `Region` when drawn using the specified `Graphics`.
`boolean`	`isVisible(Point point, Graphics g)` Tests whether the specified `Point` structure is contained within this `Region` when drawn using the specified `Graphics`.
`boolean`	`isVisible(Rectangle rect)` Tests whether any portion of the specified `Rectangle` structure is contained within this `Region`.
`boolean`	`isVisible(RectangleF rect)` Tests whether any portion of the specified `RectangleF` structure is contained within this `Region`.
`boolean`	`isVisible(RectangleF rect, Graphics g)` Tests whether any portion of the specified `RectangleF` structure is contained within this `Region` when drawn using the specified `Graphics`.
`boolean`	`isVisible(Rectangle rect, Graphics g)` Tests whether any portion of the specified `Rectangle` structure is contained within this `Region` when drawn using the specified `Graphics`.
`void`	`makeEmpty()` Initializes this `Region` to an empty interior.
`void`	`makeInfinite()` Initializes this `Region` object to an infinite interior.
`void`	`transform(Matrix matrix)` Transforms this `Region` by the specified `Matrix`.
`void`	`translate(float dx, float dy)` Offsets the coordinates of this `Region` by the specified amount.
`void`	`translate(int dx, int dy)` Offsets the coordinates of this `Region` by the specified amount.
`void`	`union(GraphicsPath path)` Updates this `Region` to the union of itself and the specified `GraphicsPath`.
`void`	`union(Rectangle rect)` Updates this `Region` to the union of itself and the specified `Rectangle` structure.
`void`	`union(RectangleF rect)` Updates this `Region` to the union of itself and the specified `RectangleF` structure.
`void`	`union(Region region)` Updates this `Region` to the union of itself and the specified `Region`.
`void`	`xor(GraphicsPath path)` Updates this `Region` to the union minus the intersection of itself with the specified `GraphicsPath`.
`void`	`xor(Rectangle rect)` Updates this `Region` to the union minus the intersection of itself with the specified `Rectangle` structure.
`void`	`xor(RectangleF rect)` Updates this `Region` to the union minus the intersection of itself with the specified `RectangleF` structure.
`void`	`xor(Region region)` Updates this `Region` to the union minus the intersection of itself with the specified `Region`.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Region
```
public Region()
```
    Initializes a new instance of the Region class.
  - Region
```
public Region(RectangleF rect)
```
    Initializes a new instance of the Region class from the specified RectangleF structure.
    
    Parameters:
    
    rect - A RectangleF structure that defines the interior of the new Region.
  - Region
```
public Region(Rectangle rect)
```
    Initializes a new instance of the Region class from the specified Rectangle structure.
    
    Parameters:
    
    rect - A Rectangle structure that defines the interior of the new Region.
  - Region
```
public Region(GraphicsPath path)
```
    Initializes a new instance of the Region class with the specified GraphicsPath.
    
    Parameters:
    
    path - A GraphicsPath that defines the new Region.
  - Region
```
public Region(RegionData rgnData)
```
    Initializes a new instance of the Region class from the specified data.
    
    Parameters:
    
    rgnData - A RegionData that defines the interior of the new Region.
- Method Detail
  - dispose
```
public void dispose()
```
    Releases all resources used by this Region.
    
    Specified by:
    
    dispose in interface com.aspose.ms.System.IDisposable
  - equals
```
public boolean equals(Region region,
                      Graphics g)
```
    Tests whether the specified Region is identical to this Region on the specified drawing surface.
    
    Parameters:
    
    region - The Region to test.
    
    g - A Graphics that represents a drawing surface.
    
    Returns:
    
    true if the interior of region is identical to the interior of this region when the transformation associated with the g parameter is applied; otherwise, false.
  - deepClone
```
public Region deepClone()
```
    Creates an exact copy of this Region.
    
    Returns:
    
    The Region that this method creates.
  - makeInfinite
```
public void makeInfinite()
```
    Initializes this Region object to an infinite interior.
  - makeEmpty
```
public void makeEmpty()
```
    Initializes this Region to an empty interior.
  - intersect
```
public void intersect(RectangleF rect)
```
    Updates this Region to the intersection of itself with the specified RectangleF structure.
    
    Parameters:
    
    rect - The RectangleF structure to intersect with this Region.
  - intersect
```
public void intersect(Rectangle rect)
```
    Updates this Region to the intersection of itself with the specified Rectangle structure.
    
    Parameters:
    
    rect - The Rectangle structure to intersect with this Region.
  - intersect
```
public void intersect(GraphicsPath path)
```
    Updates this Region to the intersection of itself with the specified GraphicsPath.
    
    Parameters:
    
    path - The GraphicsPath to intersect with this Region.
  - intersect
```
public void intersect(Region region)
```
    Updates this Region to the intersection of itself with the specified Region.
    
    Parameters:
    
    region - The Region to intersect with this Region.
  - union
```
public void union(RectangleF rect)
```
    Updates this Region to the union of itself and the specified RectangleF structure.
    
    Parameters:
    
    rect - The RectangleF structure to unite with this Region.
    Union leaves infinite region as infinite.
  - union
```
public void union(Rectangle rect)
```
    Updates this Region to the union of itself and the specified Rectangle structure.
    
    Parameters:
    
    rect - The Rectangle structure to unite with this Region.
    Union leaves infinite region as infinite.
  - union
```
public void union(GraphicsPath path)
```
    Updates this Region to the union of itself and the specified GraphicsPath.
    
    Parameters:
    
    path - The GraphicsPath to unite with this Region.
    Union leaves infinite region as infinite.
  - union
```
public void union(Region region)
```
    Updates this Region to the union of itself and the specified Region.
    
    Parameters:
    
    region - The Region to unite with this Region.
    Union leaves infinite region as infinite.
  - getRegionData
```
public RegionData getRegionData()
```
    Returns a RegionData that represents the information that describes this Region.
    
    Returns:
    
    A RegionData that represents the information that describes this Region.
  - xor
```
public void xor(RectangleF rect)
```
    Updates this Region to the union minus the intersection of itself with the specified RectangleF structure.
    
    Parameters:
    
    rect - The RectangleF structure to M:Region.Xor(drawing2d.GraphicsPath) with this Region.
  - xor
```
public void xor(Rectangle rect)
```
    Updates this Region to the union minus the intersection of itself with the specified Rectangle structure.
    
    Parameters:
    
    rect - The Rectangle structure to M:Region.Xor(Rectangle) with this Region.
  - xor
```
public void xor(GraphicsPath path)
```
    Updates this Region to the union minus the intersection of itself with the specified GraphicsPath.
    
    Parameters:
    
    path - The GraphicsPath to M:Region.Xor(GraphicsPath) with this Region.
  - xor
```
public void xor(Region region)
```
    Updates this Region to the union minus the intersection of itself with the specified Region.
    
    Parameters:
    
    region - The Region to M:Region.Xor(Region) with this Region.
  - exclude
```
public void exclude(RectangleF rect)
```
    Updates this Region to contain only the portion of its interior that does not intersect with the specified RectangleF structure.
    
    Parameters:
    
    rect - The RectangleF structure to exclude from this Region.
  - exclude
```
public void exclude(Rectangle rect)
```
    Updates this Region to contain only the portion of its interior that does not intersect with the specified Rectangle structure.
    
    Parameters:
    
    rect - The Rectangle structure to exclude from this Region.
  - exclude
```
public void exclude(GraphicsPath path)
```
    Updates this Region to contain only the portion of its interior that does not intersect with the specified GraphicsPath.
    
    Parameters:
    
    path - The GraphicsPath to exclude from this Region.
  - exclude
```
public void exclude(Region region)
```
    Updates this Region to contain only the portion of its interior that does not intersect with the specified Region.
    
    Parameters:
    
    region - The Region to exclude from this Region.
  - complement
```
public void complement(RectangleF rect)
```
    Updates this Region to contain the portion of the specified RectangleF structure that does not intersect with this Region.
    
    Parameters:
    
    rect - The RectangleF structure to complement this Region.
  - complement
```
public void complement(Rectangle rect)
```
    Updates this Region to contain the portion of the specified Rectangle structure that does not intersect with this Region.
    
    Parameters:
    
    rect - The Rectangle structure to complement this Region.
  - complement
```
public void complement(GraphicsPath path)
```
    Updates this Region to contain the portion of the specified GraphicsPath that does not intersect with this Region.
    
    Parameters:
    
    path - The GraphicsPath to complement this Region.
  - complement
```
public void complement(Region region)
```
    Updates this Region to contain the portion of the specified Region that does not intersect with this Region.
    
    Parameters:
    
    region - The Region object to complement this Region object.
  - translate
```
public void translate(float dx,
                      float dy)
```
    Offsets the coordinates of this Region by the specified amount.
    
    Parameters:
    
    dx - The amount to offset this Region horizontally.
    
    dy - The amount to offset this Region vertically.
  - translate
```
public void translate(int dx,
                      int dy)
```
    Offsets the coordinates of this Region by the specified amount.
    
    Parameters:
    
    dx - The amount to offset this Region horizontally
    
    dy - The amount to offset this Region vertically.
  - transform
```
public void transform(Matrix matrix)
```
    Transforms this Region by the specified Matrix.
    
    Parameters:
    
    matrix - The Matrix by which to transform this Region.
  - getBounds
```
public RectangleF getBounds(Graphics g)
```
    Gets a RectangleF structure that represents a rectangle that bounds this Region on the drawing surface of a Graphics object.
    
    Parameters:
    
    g - The Graphics on which this Region is drawn.
    
    Returns:
    
    A RectangleF structure that represents the bounding rectangle for this Region on the specified drawing surface.
  - getRegionScans
```
public RectangleF[] getRegionScans(Matrix matrix)
```
    Returns an array of RectangleF structures that approximate this Region after the specified matrix transformation is applied.
    
    Parameters:
    
    matrix - A Matrix that represents a geometric transformation to apply to the region.
    
    Returns:
    
    An array of RectangleF structures that approximate this Region after the specified matrix transformation is applied.
  - isEmpty
```
public boolean isEmpty(Graphics g)
```
    Tests whether this Region has an empty interior on the specified drawing surface.
    
    Parameters:
    
    g - A Graphics that represents a drawing surface.
    
    Returns:
    
    true if the interior of this Region is empty when the transformation associated with g is applied; otherwise, false.
  - isInfinite
```
public boolean isInfinite(Graphics g)
```
    Tests whether this Region has an infinite interior on the specified drawing surface.
    
    Parameters:
    
    g - A Graphics that represents a drawing surface.
    
    Returns:
    
    true if the interior of this Region is infinite when the transformation associated with g is applied; otherwise, false.
  - isVisible
```
public boolean isVisible(float x,
                         float y)
```
    Tests whether the specified point is contained within this Region.
    
    Parameters:
    
    x - The x-coordinate of the point to test.
    
    y - The y-coordinate of the point to test.
    
    Returns:
    
    true when the specified point is contained within this Region; otherwise, false.
  - isVisible
```
public boolean isVisible(PointF point)
```
    Tests whether the specified PointF structure is contained within this Region.
    
    Parameters:
    
    point - The PointF structure to test.
    
    Returns:
    
    true when point is contained within this Region; otherwise, false.
  - isVisible
```
public boolean isVisible(float x,
                         float y,
                         Graphics g)
```
    Tests whether the specified point is contained within this Region when drawn using the specified Graphics.
    
    Parameters:
    
    x - The x-coordinate of the point to test.
    
    y - The y-coordinate of the point to test.
    
    g - A Graphics that represents a graphics context.
    
    Returns:
    
    true when the specified point is contained within this Region; otherwise, false.
  - isVisible
```
public boolean isVisible(PointF point,
                         Graphics g)
```
    Tests whether the specified PointF structure is contained within this Region when drawn using the specified Graphics.
    
    Parameters:
    
    point - The PointF structure to test.
    
    g - A Graphics that represents a graphics context.
    
    Returns:
    
    true when point is contained within this Region; otherwise, false.
  - isVisible
```
public boolean isVisible(float x,
                         float y,
                         float width,
                         float height)
```
    Tests whether any portion of the specified rectangle is contained within this Region.
    
    Parameters:
    
    x - The x-coordinate of the upper-left corner of the rectangle to test.
    
    y - The y-coordinate of the upper-left corner of the rectangle to test.
    
    width - The width of the rectangle to test.
    
    height - The height of the rectangle to test.
    
    Returns:
    
    true when any portion of the specified rectangle is contained within this Region object; otherwise, false.
  - isVisible
```
public boolean isVisible(RectangleF rect)
```
    Tests whether any portion of the specified RectangleF structure is contained within this Region.
    
    Parameters:
    
    rect - The RectangleF structure to test.
    
    Returns:
    
    true when any portion of rect is contained within this Region; otherwise, false.
  - isVisible
```
public boolean isVisible(float x,
                         float y,
                         float width,
                         float height,
                         Graphics g)
```
    Tests whether any portion of the specified rectangle is contained within this Region when drawn using the specified Graphics.
    
    Parameters:
    
    x - The x-coordinate of the upper-left corner of the rectangle to test.
    
    y - The y-coordinate of the upper-left corner of the rectangle to test.
    
    width - The width of the rectangle to test.
    
    height - The height of the rectangle to test.
    
    g - A Graphics that represents a graphics context.
    
    Returns:
    
    true when any portion of the specified rectangle is contained within this Region; otherwise, false.
  - isVisible
```
public boolean isVisible(RectangleF rect,
                         Graphics g)
```
    Tests whether any portion of the specified RectangleF structure is contained within this Region when drawn using the specified Graphics.
    
    Parameters:
    
    rect - The RectangleF structure to test.
    
    g - A Graphics that represents a graphics context.
    
    Returns:
    
    true when rect is contained within this Region; otherwise, false.
  - isVisible
```
public boolean isVisible(int x,
                         int y,
                         Graphics g)
```
    Tests whether the specified point is contained within this Region object when drawn using the specified Graphics object.
    
    Parameters:
    
    x - The x-coordinate of the point to test.
    
    y - The y-coordinate of the point to test.
    
    g - A Graphics that represents a graphics context.
    
    Returns:
    
    true when the specified point is contained within this Region; otherwise, false.
  - isVisible
```
public boolean isVisible(Point point)
```
    Tests whether the specified Point structure is contained within this Region.
    
    Parameters:
    
    point - The Point structure to test.
    
    Returns:
    
    true when point is contained within this Region; otherwise, false.
  - isVisible
```
public boolean isVisible(Point point,
                         Graphics g)
```
    Tests whether the specified Point structure is contained within this Region when drawn using the specified Graphics.
    
    Parameters:
    
    point - The Point structure to test.
    
    g - A Graphics that represents a graphics context.
    
    Returns:
    
    true when point is contained within this Region; otherwise, false.
  - isVisible
```
public boolean isVisible(int x,
                         int y,
                         int width,
                         int height)
```
    Tests whether any portion of the specified rectangle is contained within this Region.
    
    Parameters:
    
    x - The x-coordinate of the upper-left corner of the rectangle to test.
    
    y - The y-coordinate of the upper-left corner of the rectangle to test.
    
    width - The width of the rectangle to test.
    
    height - The height of the rectangle to test.
    
    Returns:
    
    true when any portion of the specified rectangle is contained within this Region; otherwise, false.
  - isVisible
```
public boolean isVisible(Rectangle rect)
```
    Tests whether any portion of the specified Rectangle structure is contained within this Region.
    
    Parameters:
    
    rect - The Rectangle structure to test.
    
    Returns:
    
    This method returns true when any portion of rect is contained within this Region; otherwise, false.
  - isVisible
```
public boolean isVisible(int x,
                         int y,
                         int width,
                         int height,
                         Graphics g)
```
    Tests whether any portion of the specified rectangle is contained within this Region when drawn using the specified Graphics.
    
    Parameters:
    
    x - The x-coordinate of the upper-left corner of the rectangle to test.
    
    y - The y-coordinate of the upper-left corner of the rectangle to test.
    
    width - The width of the rectangle to test.
    
    height - The height of the rectangle to test.
    
    g - A Graphics that represents a graphics context.
    
    Returns:
    
    true when any portion of the specified rectangle is contained within this Region; otherwise, false.
  - isVisible
```
public boolean isVisible(Rectangle rect,
                         Graphics g)
```
    Tests whether any portion of the specified Rectangle structure is contained within this Region when drawn using the specified Graphics.
    
    Parameters:
    
    rect - The Rectangle structure to test.
    
    g - A Graphics that represents a graphics context.
    
    Returns:
    
    true when any portion of the rect is contained within this Region; otherwise, false.

Class Region

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Region

Region

Region

Region

Region

Method Detail

dispose

equals

deepClone

makeInfinite

makeEmpty

intersect

intersect

intersect

intersect

union

union

union

union

getRegionData

xor

xor

xor

xor

exclude

exclude

exclude

exclude

complement

complement

complement

complement

translate

translate

transform

getBounds

getRegionScans

isEmpty

isInfinite

isVisible

isVisible

isVisible

isVisible

isVisible

isVisible

isVisible

isVisible

isVisible

isVisible

isVisible

isVisible

isVisible

isVisible

isVisible