1 /*
2  * Copyright (C) 2024 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 com.android.settings.biometrics.fingerprint2.data.model
18 
19 /**
20  * A view model that describes the various stages of UDFPS Enrollment. This stages typically update
21  * the enrollment UI in a major way, such as changing the lottie animation or changing the location
22  * of the where the user should press their fingerprint
23  */
24 sealed class EnrollStageModel {
25   /** Unknown stage */
26   data object Unknown : EnrollStageModel()
27 
28   /** This is the stage that moves the fingerprint icon around during enrollment. */
29   data object Guided : EnrollStageModel()
30 
31   /** The center stage is the initial stage of enrollment. */
32   data object Center : EnrollStageModel()
33 
34   /**
35    * Fingerprint stage of enrollment. Typically there is some sort of indication that a user should
36    * be using their finger tip to enroll.
37    */
38   data object Fingertip : EnrollStageModel()
39 
40   /**
41    * Left edge stage of enrollment. Typically there is an indication that a user should be using the
42    * left edge of their fingerprint.
43    */
44   data object LeftEdge : EnrollStageModel()
45 
46   /**
47    * Right edge stage of enrollment. Typically there is an indication that a user should be using
48    * the right edge of their fingerprint.
49    */
50   data object RightEdge : EnrollStageModel()
51 }
52