Summary: Methods | Inherited Methods

MeteringPointFactory

Kotlin |Java

public abstract class MeteringPointFactory
extends Object

java.lang.Object
↳	androidx.camera.core.MeteringPointFactory

Known direct subclasses

DisplayOrientedMeteringPointFactory, SurfaceOrientedMeteringPointFactory, TextureViewMeteringPointFactory

DisplayOrientedMeteringPointFactory	A `MeteringPointFactory` that can convert a `View` (x, y) into a `MeteringPoint` which can then be used to construct a `FocusMeteringAction` to start a focus and metering action.
SurfaceOrientedMeteringPointFactory	A `MeteringPointFactory` that can create `MeteringPoint` by surface oriented x, y on a area defined by (0, 0) - (width, height).
TextureViewMeteringPointFactory	A `MeteringPointFactory` for creating a `MeteringPoint` by `TextureView` and (x,y).

A factory to create a MeteringPoint.

Users can call createPoint(float, float) to create a MeteringPoint with x, y, default size. There are also another variant, createPoint(float, float, float) for apps that want to also specify size.

See also:

Summary

Public methods
`final MeteringPoint`	`createPoint(float x, float y)` Creates a `MeteringPoint` by x, y.
`final MeteringPoint`	`createPoint(float x, float y, float size)` Creates a `MeteringPoint` by x, y, size.
`static float`	`getDefaultPointSize()` Returns default point size.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public methods

createPoint

public final MeteringPoint createPoint (float x, 
                float y)

Creates a MeteringPoint by x, y.

The (x, y) is a position from the area defined by the specific MeteringPointFactory implementation, such as DisplayOrientedMeteringPointFactory or SurfaceOrientedMeteringPointFactory.

Parameters
`x`	`float`: x to be converted.
`y`	`float`: y to be converted.

Returns
`MeteringPoint`	A `MeteringPoint` that is converted into normalized surface (x, y).

See also:

createPoint

public final MeteringPoint createPoint (float x, 
                float y, 
                float size)

Creates a MeteringPoint by x, y, size.

The (x, y) is a position from the area defined by the specific MeteringPointFactory implementation, such as DisplayOrientedMeteringPointFactory or SurfaceOrientedMeteringPointFactory.

Parameters
`x`	`float`: x to be converted.
`y`	`float`: y to be converted.
`size`	`float`: size of the MeteringPoint width and height(ranging from 0 to 1). It is the (normalized) percentage of the sensor width/height (or crop region width/height if crop region is set).

Returns
`MeteringPoint`	A `MeteringPoint` that is converted into normalized surface (x, y).

See also:

getDefaultPointSize

public static float getDefaultPointSize ()

Returns default point size. It is the default size of the MeteringPoint width and height (ranging from 0 to 1) which is a (noramlized) percentage of the sensor width/height (or crop region width/height if crop region is set).

Returns
`float`

See also:

MeteringPoint.getSize()