File	Doc	Category	Size	Date	Package
MeteringRectangle.java	API Doc	Android 5.1 API	9405	Thu Mar 12 22:22:10 GMT 2015	android.hardware.camera2.params

MeteringRectangle

• java.lang.Object

Fields Summary
public static final int	METERING_WEIGHT_MIN The minimum value of valid metering weight.
public static final int	METERING_WEIGHT_MAX The maximum value of valid metering weight.
public static final int	METERING_WEIGHT_DONT_CARE 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.
private final int	mX
private final int	mY
private final int	mWidth
private final int	mHeight
private final int	mWeight

Constructors Summary
public MeteringRectangle(int x, int y, int width, int height, int meteringWeight) Create a new metering rectangle. param x coordinate >= 0 param y coordinate >= 0 param width width >= 0 param height height >= 0 param meteringWeight weight between {@value #METERING_WEIGHT_MIN} and {@value #METERING_WEIGHT_MAX} inclusively throws IllegalArgumentException if any of the parameters were negative mX = checkArgumentNonnegative(x, "x must be nonnegative"); mY = checkArgumentNonnegative(y, "y must be nonnegative"); mWidth = checkArgumentNonnegative(width, "width must be nonnegative"); mHeight = checkArgumentNonnegative(height, "height must be nonnegative"); mWeight = checkArgumentInRange( meteringWeight, METERING_WEIGHT_MIN, METERING_WEIGHT_MAX, "meteringWeight");
public MeteringRectangle(android.graphics.Point xy, android.util.Size dimensions, int meteringWeight) Create a new metering rectangle. The point {@code xy}'s data is copied; the reference is not retained. param xy a non-{@code null} {@link Point} with both x,y >= 0 param dimensions a non-{@code null} {@link android.util.Size Size} with width, height >= 0 param meteringWeight weight >= 0 throws IllegalArgumentException if any of the parameters were negative throws NullPointerException if any of the arguments were null checkNotNull(xy, "xy must not be null"); checkNotNull(dimensions, "dimensions must not be null"); mX = checkArgumentNonnegative(xy.x, "x must be nonnegative"); mY = checkArgumentNonnegative(xy.y, "y must be nonnegative"); mWidth = checkArgumentNonnegative(dimensions.getWidth(), "width must be nonnegative"); mHeight = checkArgumentNonnegative(dimensions.getHeight(), "height must be nonnegative"); mWeight = checkArgumentNonnegative(meteringWeight, "meteringWeight must be nonnegative");
public MeteringRectangle(android.graphics.Rect rect, int meteringWeight) Create a new metering rectangle. The rectangle data is copied; the reference is not retained. param rect a non-{@code null} rectangle with all x,y,w,h dimensions >= 0 param meteringWeight weight >= 0 throws IllegalArgumentException if any of the parameters were negative throws NullPointerException if any of the arguments were null checkNotNull(rect, "rect must not be null"); mX = checkArgumentNonnegative(rect.left, "rect.left must be nonnegative"); mY = checkArgumentNonnegative(rect.top, "rect.top must be nonnegative"); mWidth = checkArgumentNonnegative(rect.width(), "rect.width must be nonnegative"); mHeight = checkArgumentNonnegative(rect.height(), "rect.height must be nonnegative"); mWeight = checkArgumentNonnegative(meteringWeight, "meteringWeight must be nonnegative");

Methods Summary
public boolean	equals(java.lang.Object other) {@inheritDoc} return other instanceof MeteringRectangle && equals((MeteringRectangle)other);
public boolean	equals(android.hardware.camera2.params.MeteringRectangle other) 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. param other Another MeteringRectangle return {@code true} if the metering rectangles are equal, {@code false} otherwise if (other == null) { return false; } return (mX == other.mX && mY == other.mY && mWidth == other.mWidth && mHeight == other.mHeight && mWeight == other.mWeight);
public int	getHeight() Return the height of the rectangle. return height >= 0 return mHeight;
public int	getMeteringWeight() Return the metering weight of the rectangle. return weight >= 0 return mWeight;
public android.graphics.Rect	getRect() Convenience method to create a {@link Rect} from this metering rectangle. This strips away the weight from the rectangle. return a new {@link Rect} with non-negative x1, y1, x2, y2 return new Rect(mX, mY, mX + mWidth, mY + mHeight);
public android.util.Size	getSize() Convenience method to create the size from this metering rectangle. This strips away the X,Y,weight from the rectangle. return a new {@link Size} with non-negative width and height return new Size(mWidth, mHeight);
public android.graphics.Point	getUpperLeftPoint() Convenience method to create the upper-left (X,Y) coordinate as a {@link Point}. return a new {@code (x,y)} {@link Point} with both x,y >= 0 return new Point(mX, mY);
public int	getWidth() Return the width of the rectangle. return width >= 0 return mWidth;
public int	getX() Return the X coordinate of the left side of the rectangle. return x coordinate >= 0 return mX;
public int	getY() Return the Y coordinate of the upper side of the rectangle. return y coordinate >= 0 return mY;
public int	hashCode() {@inheritDoc} return HashCodeHelpers.hashCode(mX, mY, mWidth, mHeight, mWeight);
public java.lang.String	toString() Return the metering rectangle as a string representation {@code "(x:%d, y:%d, w:%d, h:%d, wt:%d)"} where each {@code %d} respectively represents the x, y, width, height, and weight points. return string representation of the metering rectangle return String.format("(x:%d, y:%d, w:%d, h:%d, wt:%d)", mX, mY, mWidth, mHeight, mWeight);