RoundedRectBlurRegion
class RoundedRectBlurRegion : BlurRegion
| kotlin.Any | ||
| ↳ | android.view.BlurRegion | |
| ↳ | android.view.RoundedRectBlurRegion | |
Defines a rounded rectangular blur region on the SurfaceView.
Summary
| Public constructors | |
|---|---|
|
Constructs a new |
|
RoundedRectBlurRegion(rect: RectF, cornerRadii: FloatArray, alpha: Float, blurRadius: Float)Constructs a new |
|
| Public methods | |
|---|---|
| RoundedRectBlurRegion |
copy()Returns a deep copy of this blur region. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| RectF |
Returns the bounds of the blur region. |
| FloatArray |
Returns the corner radii for the blur region. |
| Int |
hashCode()Returns a hash code value for the object. |
| Unit |
Sets the bounds of the blur region. |
| Unit |
setCornerRadii(cornerRadius: Float)Sets the corner radius for all corners of the blur region. |
| Unit |
setCornerRadii(cornerRadii: FloatArray)Sets the corner radii for the blur region. |
| Inherited functions | |
|---|---|
Public constructors
RoundedRectBlurRegion
RoundedRectBlurRegion()
Constructs a new RoundedRectBlurRegion with the default parameters.
The default bounds and all corner radii are 0.0f.
The default alpha is 1.0f and the default blur radius is 0.0f.
RoundedRectBlurRegion
RoundedRectBlurRegion(
rect: RectF,
cornerRadii: FloatArray,
alpha: Float,
blurRadius: Float)
Constructs a new RoundedRectBlurRegion with the specified rounded rectangle coordinates and corner radii.
The cornerRadii values are ordered [topLeftX, topLeftY, topRightX, topRightY, bottomLeftX, bottomLeftY, bottomRightX, bottomRightY].
| Parameters | |
|---|---|
rect |
RectF: bounds of the blur region. This value cannot be null. |
cornerRadii |
FloatArray: array of 8 floats representing the corner radii. This value cannot be null. |
alpha |
Float: alpha value of the region [0.0 - 1.0]. Value is between 0.0f and 1.0f inclusive |
blurRadius |
Float: the blur radius in pixels |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if cornerRadii is null or its length is not 8 or rect is null |
Public methods
copy
fun copy(): RoundedRectBlurRegion
Returns a deep copy of this blur region.
| Return | |
|---|---|
RoundedRectBlurRegion |
This value cannot be null. |
equals
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getBounds
fun getBounds(): RectF
Returns the bounds of the blur region.
| Return | |
|---|---|
RectF |
RectF containing the bounds. This value cannot be null. |
getCornerRadii
fun getCornerRadii(): FloatArray
Returns the corner radii for the blur region.
| Return | |
|---|---|
FloatArray |
array of 8 floats representing the corner radii. This value cannot be null. |
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
| Return | |
|---|---|
Int |
a hash code value for this object. |
setBounds
fun setBounds(rect: RectF): Unit
Sets the bounds of the blur region.
The default value is an empty rectangle.
| Parameters | |
|---|---|
rect |
RectF: the bounds of the blur region. This value cannot be null. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if rect is null |
setCornerRadii
fun setCornerRadii(cornerRadius: Float): Unit
Sets the corner radius for all corners of the blur region.
| Parameters | |
|---|---|
cornerRadius |
Float: radius in pixels. |
setCornerRadii
fun setCornerRadii(cornerRadii: FloatArray): Unit
Sets the corner radii for the blur region.
The cornerRadii values are ordered [topLeftX, topLeftY, topRightX, topRightY, bottomLeftX, bottomLeftY, bottomRightX, bottomRightY].
The default value is all zeros.
| Parameters | |
|---|---|
cornerRadii |
FloatArray: array of 8 floats representing the corner radii. This value cannot be null. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if cornerRadii is null or its length is not 8 |