MeteringRectangle
class MeteringRectangle
| kotlin.Any | |
| ↳ | android.hardware.camera2.params.MeteringRectangle |
An immutable class to represent a rectangle (x, y, width, height) with an additional weight component.
The rectangle is defined to be inclusive of the specified coordinates.
When used with a CaptureRequest, the coordinate system is based on the active pixel array, with (0,0) being the top-left pixel in the active pixel array, and (android.sensor.info.activeArraySize.width - 1, android.sensor.info.activeArraySize.height - 1) being the bottom-right pixel in the active pixel array.
The weight must range from {@value #METERING_WEIGHT_MIN} to {@value #METERING_WEIGHT_MAX} inclusively, and represents a weight for every pixel in the area. This means that a large metering area with the same weight as a smaller area will have more effect in the metering result. Metering areas can partially overlap and the camera device will add the weights in the overlap rectangle.
If all rectangles have 0 weight, then no specific metering area needs to be used by the camera device. If the metering rectangle is outside the used android.scaler.cropRegion returned in capture result metadata, the camera device will ignore the sections outside the rectangle and output the used sections in the result metadata.
Summary
| Constants | |
|---|---|
| static Int |
Weights set to this value will cause the camera device to ignore this rectangle. |
| static Int |
The maximum value of valid metering weight. |
| static Int |
The minimum value of valid metering weight. |
| Public constructors | |
|---|---|
|
Create a new metering rectangle. |
|
MeteringRectangle(xy: Point!, dimensions: Size!, meteringWeight: Int)Create a new metering rectangle. |
|
MeteringRectangle(rect: Rect!, meteringWeight: Int)Create a new metering rectangle. |
|
| Public methods | |
|---|---|
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Boolean |
equals(other: MeteringRectangle!)Compare two metering rectangles to see if they are equal. |
| Int |
Return the height of the rectangle. |
| Int |
Return the metering weight of the rectangle. |
| Rect! |
getRect()Convenience method to create a |
| Size! |
getSize()Convenience method to create the size from this metering rectangle. |
| Point! |
Convenience method to create the upper-left (X,Y) coordinate as a |
| Int |
getWidth()Return the width of the rectangle. |
| Int |
getX()Return the X coordinate of the left side of the rectangle. |
| Int |
getY()Return the Y coordinate of the upper side of the rectangle. |
| Int |
hashCode()Returns a hash code value for the object. |
| String |
toString()Return the metering rectangle as a string representation |
Constants
METERING_WEIGHT_DONT_CARE
static val METERING_WEIGHT_DONT_CARE: Int
Weights set to this value will cause the camera device to ignore this rectangle. If all metering rectangles are weighed with 0, the camera device will choose its own metering rectangles.
Value: 0
METERING_WEIGHT_MAX
static val METERING_WEIGHT_MAX: Int
The maximum value of valid metering weight.
Value: 1000
METERING_WEIGHT_MIN
static val METERING_WEIGHT_MIN: Int
The minimum value of valid metering weight.
Value: 0
Public constructors
MeteringRectangle
MeteringRectangle(
x: Int,
y: Int,
width: Int,
height: Int,
meteringWeight: Int)
Create a new metering rectangle.
| Parameters | |
|---|---|
x |
Int: coordinate >= 0 |
y |
Int: coordinate >= 0 |
width |
Int: width >= 0 |
height |
Int: height >= 0 |
meteringWeight |
Int: weight between {@value #METERING_WEIGHT_MIN} and {@value #METERING_WEIGHT_MAX} inclusively |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if any of the parameters were negative |
MeteringRectangle
MeteringRectangle(
xy: Point!,
dimensions: Size!,
meteringWeight: Int)
Create a new metering rectangle.
The point xy's data is copied; the reference is not retained.
| Parameters | |
|---|---|
xy |
Point!: a non-null Point with both x,y >= 0 |
dimensions |
Size!: a non-null Size with width, height >= 0 |
meteringWeight |
Int: weight >= 0 |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if any of the parameters were negative |
java.lang.NullPointerException |
if any of the arguments were null |
MeteringRectangle
MeteringRectangle(
rect: Rect!,
meteringWeight: Int)
Create a new metering rectangle.
The rectangle data is copied; the reference is not retained.
| Parameters | |
|---|---|
rect |
Rect!: a non-null rectangle with all x,y,w,h dimensions >= 0 |
meteringWeight |
Int: weight >= 0 |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if any of the parameters were negative |
java.lang.NullPointerException |
if any of the arguments were null |
Public methods
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. |
equals
fun equals(other: MeteringRectangle!): Boolean
Compare two metering rectangles to see if they are equal. Two weighted rectangles are only considered equal if each of their components (x, y, width, height, weight) is respectively equal.
| Parameters | |
|---|---|
other |
MeteringRectangle!: Another MeteringRectangle |
| Return | |
|---|---|
Boolean |
true if the metering rectangles are equal, false otherwise |
getHeight
fun getHeight(): Int
Return the height of the rectangle.
| Return | |
|---|---|
Int |
height >= 0 |
getMeteringWeight
fun getMeteringWeight(): Int
Return the metering weight of the rectangle.
| Return | |
|---|---|
Int |
weight >= 0 |
getRect
fun getRect(): Rect!
Convenience method to create a Rect from this metering rectangle.
This strips away the weight from the rectangle.
| Return | |
|---|---|
Rect! |
a new Rect with non-negative x1, y1, x2, y2 |
getSize
fun getSize(): Size!
Convenience method to create the size from this metering rectangle.
This strips away the X,Y,weight from the rectangle.
| Return | |
|---|---|
Size! |
a new Size with non-negative width and height |
getUpperLeftPoint
fun getUpperLeftPoint(): Point!
Convenience method to create the upper-left (X,Y) coordinate as a Point.
| Return | |
|---|---|
Point! |
a new (x,y) Point with both x,y >= 0 |
getWidth
fun getWidth(): Int
Return the width of the rectangle.
| Return | |
|---|---|
Int |
width >= 0 |
getX
fun getX(): Int
Return the X coordinate of the left side of the rectangle.
| Return | |
|---|---|
Int |
x coordinate >= 0 |
getY
fun getY(): Int
Return the Y coordinate of the upper side of the rectangle.
| Return | |
|---|---|
Int |
y coordinate >= 0 |
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. |
toString
fun toString(): String
Return the metering rectangle as a string representation "(x:%d, y:%d, w:%d, h:%d, wt:%d)" where each %d respectively represents the x, y, width, height, and weight points.
| Return | |
|---|---|
String |
string representation of the metering rectangle |