android.graphics
Class Region

java.lang.Object
  android.graphics.Region

All Implemented Interfaces:

Parcelable

public class Region
extends Object
implements Parcelable

Nested Class Summary

static class

Region.Op

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.Creator<T>

Field Summary

static Parcelable.Creator<Region>

CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Region()
Create an empty region

Region(int ni)

Region(int left, int top, int right, int bottom)
Return a region set to the specified rectangle

Region(Rect r)
Return a region set to the specified rectangle

Region(Region region)
Return a copy of the specified region

Method Summary

boolean	contains(int x, int y) Return true if the region contains the specified point
int	describeContents() Describe the kinds of special objects contained in this Parcelable's marshalled representation.
protected void	finalize() Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
Path	getBoundaryPath() Return the boundary of the region as a new Path.
boolean	getBoundaryPath(Path path) Set the path to the boundary of the region.
Rect	getBounds() Return a new Rect set to the bounds of the region.
boolean	getBounds(Rect r) Set the Rect to the bounds of the region.
boolean	isComplex() Return true if the region contains more than one rectangle
boolean	isEmpty() Return true if this region is empty
boolean	isRect() Return true if the region contains a single rectangle
(package private) int	ni()
boolean	op(int left, int top, int right, int bottom, Region.Op op) Perform the specified Op on this region and the specified rect.
boolean	op(Rect r, Region.Op op) Perform the specified Op on this region and the specified rect.
boolean	op(Rect rect, Region region, Region.Op op) Set this region to the result of performing the Op on the specified rect and region.
boolean	op(Region region, Region.Op op) Perform the specified Op on this region and the specified region.
boolean	op(Region region1, Region region2, Region.Op op) Set this region to the result of performing the Op on the specified regions.
boolean	quickContains(int left, int top, int right, int bottom) Return true if the region is a single rectangle (not complex) and it contains the specified rectangle.
boolean	quickContains(Rect r) Return true if the region is a single rectangle (not complex) and it contains the specified rectangle.
boolean	quickReject(int left, int top, int right, int bottom) Return true if the region is empty, or if the specified rectangle does not intersect the region.
boolean	quickReject(Rect r) Return true if the region is empty, or if the specified rectangle does not intersect the region.
boolean	quickReject(Region rgn) Return true if the region is empty, or if the specified region does not intersect the region.
boolean	set(int left, int top, int right, int bottom) Set the region to the specified rectangle
boolean	set(Rect r) Set the region to the specified rectangle
boolean	set(Region region) Set the region to the specified region.
void	setEmpty() Set the region to the empty region
boolean	setPath(Path path, Region clip) Set the region to the area described by the path and clip.
void	translate(int dx, int dy) Translate the region by [dx, dy].
void	translate(int dx, int dy, Region dst) Set the dst region to the result of translating this region by [dx, dy].
boolean	union(Rect r)
void	writeToParcel(Parcel p, int flags) Write the region and its pixels to the parcel.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CREATOR

public static final Parcelable.Creator<Region> CREATOR

Constructor Detail

Region

public Region()

Create an empty region

Region

public Region(Region region)

Return a copy of the specified region

Region

public Region(Rect r)

Return a region set to the specified rectangle

Region

public Region(int left,
              int top,
              int right,
              int bottom)

Return a region set to the specified rectangle

Region

Region(int ni)

Method Detail

setEmpty

public void setEmpty()

Set the region to the empty region

set

public boolean set(Region region)

Set the region to the specified region.

set

public boolean set(Rect r)

Set the region to the specified rectangle

set

public boolean set(int left,
                   int top,
                   int right,
                   int bottom)

Set the region to the specified rectangle

setPath

public boolean setPath(Path path,
                       Region clip)

Set the region to the area described by the path and clip. Return true if the resulting region is non-empty. This produces a region that is identical to the pixels that would be drawn by the path (with no antialiasing).

isEmpty

public boolean isEmpty()

Return true if this region is empty

isRect

public boolean isRect()

Return true if the region contains a single rectangle

isComplex

public boolean isComplex()

Return true if the region contains more than one rectangle

getBounds

public Rect getBounds()

Return a new Rect set to the bounds of the region. If the region is empty, the Rect will be set to [0, 0, 0, 0]

getBounds

public boolean getBounds(Rect r)

Set the Rect to the bounds of the region. If the region is empty, the Rect will be set to [0, 0, 0, 0]

getBoundaryPath

public Path getBoundaryPath()

Return the boundary of the region as a new Path. If the region is empty, the path will also be empty.

getBoundaryPath

public boolean getBoundaryPath(Path path)

Set the path to the boundary of the region. If the region is empty, the path will also be empty.

contains

public boolean contains(int x,
                        int y)

Return true if the region contains the specified point

quickContains

public boolean quickContains(Rect r)

Return true if the region is a single rectangle (not complex) and it contains the specified rectangle. Returning false is not a guarantee that the rectangle is not contained by this region, but return true is a guarantee that the rectangle is contained by this region.

quickContains

public boolean quickContains(int left,
                             int top,
                             int right,
                             int bottom)

Return true if the region is a single rectangle (not complex) and it contains the specified rectangle. Returning false is not a guarantee that the rectangle is not contained by this region, but return true is a guarantee that the rectangle is contained by this region.

quickReject

public boolean quickReject(Rect r)

Return true if the region is empty, or if the specified rectangle does not intersect the region. Returning false is not a guarantee that they intersect, but returning true is a guarantee that they do not.

quickReject

public boolean quickReject(int left,
                           int top,
                           int right,
                           int bottom)

Return true if the region is empty, or if the specified rectangle does not intersect the region. Returning false is not a guarantee that they intersect, but returning true is a guarantee that they do not.

quickReject

public boolean quickReject(Region rgn)

Return true if the region is empty, or if the specified region does not intersect the region. Returning false is not a guarantee that they intersect, but returning true is a guarantee that they do not.

translate

public void translate(int dx,
                      int dy)

Translate the region by [dx, dy]. If the region is empty, do nothing.

translate

public void translate(int dx,
                      int dy,
                      Region dst)

Set the dst region to the result of translating this region by [dx, dy]. If this region is empty, then dst will be set to empty.

union

public final boolean union(Rect r)

op

public boolean op(Rect r,
                  Region.Op op)

Perform the specified Op on this region and the specified rect. Return true if the result of the op is not empty.

op

public boolean op(int left,
                  int top,
                  int right,
                  int bottom,
                  Region.Op op)

Perform the specified Op on this region and the specified rect. Return true if the result of the op is not empty.

op

public boolean op(Region region,
                  Region.Op op)

Perform the specified Op on this region and the specified region. Return true if the result of the op is not empty.

op

public boolean op(Rect rect,
                  Region region,
                  Region.Op op)

Set this region to the result of performing the Op on the specified rect and region. Return true if the result is not empty.

op

public boolean op(Region region1,
                  Region region2,
                  Region.Op op)

Set this region to the result of performing the Op on the specified regions. Return true if the result is not empty.

describeContents

public int describeContents()

Description copied from interface: Parcelable

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Specified by:

describeContents in interface Parcelable

Returns:

a bitmask indicating the set of special object types marshalled by the Parcelable.

writeToParcel

public void writeToParcel(Parcel p,
                          int flags)

Write the region and its pixels to the parcel. The region can be rebuilt from the parcel by calling CREATOR.createFromParcel().

Specified by:

writeToParcel in interface Parcelable

Parameters:

p - Parcel object to write the region data into

flags - Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.

finalize

protected void finalize()
                 throws Throwable

Description copied from class: Object

Called by the virtual machine when there are no longer any (non-weak) references to the receiver. Subclasses can use this facility to guarantee that any associated resources are cleaned up before the receiver is garbage collected. Uncaught exceptions which are thrown during the running of the method cause it to terminate immediately, but are otherwise ignored.

Note: The virtual machine assumes that the implementation in class Object is empty.

Overrides:

finalize in class Object

Throws:

Throwable - The virtual machine ignores any exceptions which are thrown during finalization.

ni

final int ni()