Region

Region

Region()

Create an empty region

Region

Region(r: Rect)

Return a region set to the specified rectangle

Region

Region(region: Region)

Return a copy of the specified region

Region

Region(
    left: Int, 
    top: Int, 
    right: Int, 
    bottom: Int)

Return a region set to the specified rectangle

contains

open fun contains(
    x: Int, 
    y: Int
): Boolean

Return true if the region contains the specified point

describeContents

open fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

equals

open fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getBoundaryPath

open fun getBoundaryPath(): Path

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

getBoundaryPath

open fun getBoundaryPath(path: Path): Boolean

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

getBounds

open fun getBounds(): Rect

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

open fun getBounds(r: Rect): Boolean

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

isComplex

open fun isComplex(): Boolean

Return true if the region contains more than one rectangle

isEmpty

open fun isEmpty(): Boolean

Return true if this region is empty

isRect

open fun isRect(): Boolean

Return true if the region contains a single rectangle

op

open fun op(
    rect: Rect, 
    region: Region, 
    op: Region.Op
): Boolean

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

open fun op(
    r: Rect, 
    op: Region.Op
): Boolean

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

op

open fun op(
    region1: Region, 
    region2: Region, 
    op: Region.Op
): Boolean

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

op

open fun op(
    region: Region, 
    op: Region.Op
): Boolean

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

op

open fun op(
    left: Int, 
    top: Int, 
    right: Int, 
    bottom: Int, 
    op: Region.Op
): Boolean

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

quickContains

open fun quickContains(r: Rect): Boolean

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

open fun quickContains(
    left: Int, 
    top: Int, 
    right: Int, 
    bottom: Int
): Boolean

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

open fun quickReject(r: Rect): Boolean

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

open fun quickReject(rgn: Region!): Boolean

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.

quickReject

open fun quickReject(
    left: Int, 
    top: Int, 
    right: Int, 
    bottom: Int
): Boolean

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.

set

open fun set(r: Rect): Boolean

Set the region to the specified rectangle

set

open fun set(region: Region): Boolean

Set the region to the specified region.

set

open fun set(
    left: Int, 
    top: Int, 
    right: Int, 
    bottom: Int
): Boolean

Set the region to the specified rectangle

setEmpty

open fun setEmpty(): Unit

Set the region to the empty region

setPath

open fun setPath(
    path: Path, 
    clip: Region
): Boolean

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).

toString

open fun toString(): String

Returns a string representation of the object.

translate

open fun translate(
    dx: Int, 
    dy: Int
): Unit

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

translate

open fun translate(
    dx: Int, 
    dy: Int, 
    dst: Region!
): Unit

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

fun union(r: Rect): Boolean

writeToParcel

open fun writeToParcel(
    p: Parcel, 
    flags: Int
): Unit

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

finalize

protected open fun finalize(): Unit

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

CREATOR

static val CREATOR: Parcelable.Creator<Region!>