程序包 ohos.agp.render

类 Region

java.lang.Object

ohos.agp.render.Region

public class Region
extends Object

Represents a region composed of multiple rectangles.

从以下版本开始:

3

嵌套类概要

嵌套类

限定符和类型	类	说明
static class	Region.Op	Enumerates operation types.

构造器概要

构造器

构造器	说明
Region()	Default constructor used to create a Region instance.
Region(Region srcRegion)	A constructor used to create a Region instance by using an existing Region object.
Region(Rect rect)	A constructor used to create a Region instance by using a specified rectangle.

方法概要

限定符和类型	方法	说明
void	clear()	Clears this Region.
boolean	contains(int x, int y)	Checks whether the current region contains the specified point.
Path	getBoundaryPath()	Obtains the boundary path of this Region.
boolean	getBoundaryPath(Path path)	Obtains the boundary path of this Region and sets it to a specified Path object.
Rect	getBounds()	Obtains the boundary rectangle of this Region.
boolean	getBounds(Rect rect)	Obtains the boundary rectangle of this Region and sets it to a specified Rect object.
boolean	isComplex()	Checks whether this region contains multiple rectangles.
boolean	isEmpty()	Checks whether the current region is empty.
boolean	isRect()	Checks whether this region contains a rectangle.
boolean	op(int left, int top, int right, int bottom, Region.Op op)	Performs the specified operation on the current region and a rectangle specified by coordinates.
boolean	op(Region region, Region.Op op)	Performs the specified operation on the current region and the specified region.
boolean	op(Region regionA, Region regionB, Region.Op op)	Performs the specified operation on two specified regions.
boolean	op(Rect rect, Region.Op op)	Performs the specified operation on the current region and the specified rectangle.
boolean	op(Rect rect, Region region, Region.Op op)	Performs the specified operation on the specified rectangle and region.
boolean	quickContains(Rect r)	Checks whether this region contains a specified rectangle.
boolean	quickReject(int left, int top, int right, int bottom)	Checks whether the current region is empty or does not intersect the rectangle specified by coordinates.
boolean	quickReject(Region region)	Checks whether the current region is empty or does not intersect the specified region.
boolean	quickReject(Rect rect)	Checks whether the current region is empty or does not intersect the specified rectangle.
boolean	setPath(Path path, Region clip)	Obtains the intersection formed by a specified path and clip region.
boolean	setRect(Rect r)	Sets this region to a specified rectangle.
boolean	setRegion(Region region)	Sets this region to a specified region.
String	toString()	Obtains a string representation of this Region object.
void	translate(int dx, int dy, Region dst)	Translates this region by a specified distance.
boolean	union(Rect rect)	Merges a specified rectangle into this Region.

从类继承的方法 java.lang.Object

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

构造器详细资料

Region

public Region()

Default constructor used to create a Region instance.

从以下版本开始:

4

Region

public Region(Region srcRegion)

A constructor used to create a Region instance by using an existing Region object.

参数:

srcRegion - Indicates the existing Region object to use.

从以下版本开始:

4

Region

public Region(Rect rect)

A constructor used to create a Region instance by using a specified rectangle.

参数:

rect - Indicates the specified rectangle.

从以下版本开始:

4

方法详细资料

union

public final boolean union(Rect rect)

Merges a specified rectangle into this Region.

参数:

rect - Indicates the specified rectangle.

返回:

Returns true if the operation is successful; returns false otherwise.

从以下版本开始:

4

clear

public void clear()

Clears this Region.

从以下版本开始:

4

getBounds

public Rect getBounds()

Obtains the boundary rectangle of this Region.

返回:

Returns the boundary rectangle.

从以下版本开始:

4

getBounds

public boolean getBounds(Rect rect)

Obtains the boundary rectangle of this Region and sets it to a specified Rect object.

参数:

rect - Indicates the Rect object to hold the boundary rectangle.

返回:

Returns true if the operation is successful; returns false otherwise.

从以下版本开始:

4

getBoundaryPath

public Path getBoundaryPath()

Obtains the boundary path of this Region.

返回:

Returns the boundary path.

从以下版本开始:

4

getBoundaryPath

public boolean getBoundaryPath(Path path)

Obtains the boundary path of this Region and sets it to a specified Path object.

参数:

path - Indicates the Path object to hold the boundary path.

返回:

Returns true if the operation is successful; returns false otherwise.

从以下版本开始:

4

op

public boolean op(Region regionA,
                  Region regionB,
                  Region.Op op)

Performs the specified operation on two specified regions.

If successful, the operation will take effect on the current Region.

参数:

regionA - Indicates the first region.

regionB - Indicates the second region.

op - Indicates the operation to be performed.

返回:

Returns true if the operation is successful; returns false otherwise.

从以下版本开始:

5

op

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

Performs the specified operation on the specified rectangle and region.

If successful, the operation will take effect on the current Region.

参数:

rect - Indicates the specified rectangle.

region - Indicates the specified region.

op - Indicates the operation to be performed.

返回:

Returns true if the operation is successful; returns false otherwise.

从以下版本开始:

5

op

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

Performs the specified operation on the current region and the specified region.

参数:

region - Indicates the specified region.

op - Indicates the operation to be performed.

返回:

Returns true if the operation is successful; returns false otherwise.

从以下版本开始:

5

op

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

Performs the specified operation on the current region and a rectangle specified by coordinates.

参数:

left - Indicates the X coordinate of the upper left corner of the specified rectangle.

top - Indicates the Y coordinate of the upper left corner of the specified rectangle.

right - Indicates the X coordinate of the lower right corner of the specified rectangle.

bottom - Indicates the Y coordinate of the lower right corner of the specified rectangle.

op - Indicates the operation to be performed.

返回:

Returns true if the operation is successful; returns false otherwise.

从以下版本开始:

5

op

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

Performs the specified operation on the current region and the specified rectangle.

参数:

rect - Indicates the specified rectangle.

op - Indicates the operation to be performed.

返回:

Returns true if the operation is successful; returns false otherwise.

从以下版本开始:

5

contains

public boolean contains(int x,
                        int y)

Checks whether the current region contains the specified point.

参数:

x - Indicates the X coordinate of the specified point.

y - Indicates the Y coordinate of the specified point.

返回:

Returns true if the current region contains the specified point; returns false otherwise.

从以下版本开始:

5

toString

public String toString()

Obtains a string representation of this Region object.

覆盖:

toString 在类中 Object

返回:

Returns a string representation.

从以下版本开始:

5

quickReject

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

Checks whether the current region is empty or does not intersect the rectangle specified by coordinates.

参数:

left - Indicates the X coordinate of the upper left corner of the specified rectangle.

top - Indicates the Y coordinate of the upper left corner of the specified rectangle.

right - Indicates the X coordinate of the lower right corner of the specified rectangle.

bottom - Indicates the Y coordinate of the lower right corner of the specified rectangle.

返回:

Returns true if the current region is empty or does not intersect the rectangle specified by coordinates; returns false otherwise.

从以下版本开始:

5

quickReject

public boolean quickReject(Rect rect)

Checks whether the current region is empty or does not intersect the specified rectangle.

参数:

rect - Indicates the specified rectangle.

返回:

Returns true if the current region is empty or does not intersect the specified rectangle; returns false otherwise.

从以下版本开始:

5

quickReject

public boolean quickReject(Region region)

Checks whether the current region is empty or does not intersect the specified region.

参数:

region - Indicates the specified region.

返回:

Returns true if the current region is empty or does not intersect the specified region; returns false otherwise.

从以下版本开始:

5

isEmpty

public boolean isEmpty()

Checks whether the current region is empty.

返回:

Returns true if the current region is empty; returns false otherwise.

从以下版本开始:

5

setRect

public boolean setRect(Rect r)

Sets this region to a specified rectangle.

参数:

r - Indicates the specified rectangle.

返回:

Returns true if the rectangle is not empty; returns false otherwise.

从以下版本开始:

5

setRegion

public boolean setRegion(Region region)

Sets this region to a specified region.

参数:

region - Indicates the specified region.

返回:

Returns true if the region is not empty; returns false otherwise.

从以下版本开始:

5

isRect

public boolean isRect()

Checks whether this region contains a rectangle.

返回:

Returns true if this region contains a rectangle; returns false otherwise.

从以下版本开始:

5

isComplex

public boolean isComplex()

Checks whether this region contains multiple rectangles.

返回:

Returns true if this region contains multiple rectangles; returns false otherwise.

从以下版本开始:

5

setPath

public boolean setPath(Path path,
                       Region clip)

Obtains the intersection formed by a specified path and clip region.

参数:

path - Indicates the specified path.

clip - Indicates the clip region.

返回:

Returns true if the resulting region is not empty; returns false otherwise.

从以下版本开始:

5

quickContains

public boolean quickContains(Rect r)

Checks whether this region contains a specified rectangle.

参数:

r - Indicates the specified rectangle.

返回:

Returns true if this region contains the specified rectangle; returns false otherwise.

从以下版本开始:

5

translate

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

Translates this region by a specified distance. If this region is empty, nothing will be done.

参数:

dx - Indicates the offset of the region on the x-axis.

dy - Indicates the offset of the region on the y-axis.

dst - Indicates the destination region after translation.

从以下版本开始:

5