1 /*
2  * Copyright 2025 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package androidx.camera.view
18 
19 import android.graphics.PointF
20 import androidx.camera.core.CameraControl
21 
22 /**
23  * Describes the focus state and tap location that [CameraController] uses for tap-to-focus feature
24  * corresponding to the [PreviewView] touch events.
25  *
26  * @property focusState The focus state of the camera.
27  * @property tapPoint The `PreviewView` co-ordinates of user's touch event corresponding to this
28  *   focusing event. This can be null when a focusing event is not due to the user's touch event.
29  *   For example, `FocusOnTap(TAP_TO_FOCUS_NOT_STARTED, null)` is used when there is no focusing
30  *   event ongoing e.g. during initialization or after a focus event has been completed.
31  * @see CameraController
32  * @see CameraController.getTapToFocusInfoState
33  * @see CameraControl.startFocusAndMetering
34  */
35 public class TapToFocusInfo(public val focusState: Int, public val tapPoint: PointF?)
36