Release 4.0.0-preview1-00051
[platform/core/csapi/tizenfx.git] / src / Tizen.Multimedia.Vision / MediaVision / FaceTrackingResult.cs
1 /*
2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
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 namespace Tizen.Multimedia
18 {
19     /// <summary>
20     /// Represents result of face tracking operation.
21     /// </summary>
22     /// <since_tizen> 3</since_tizen>
23     public class FaceTrackingResult
24     {
25         internal FaceTrackingResult(bool success, double confidence, Quadrangle region)
26         {
27             Success = success;
28             Confidence = confidence;
29             Region = region;
30         }
31
32         /// <summary>
33         /// Gets the value indicating the recognition is successful.
34         /// </summary>
35         /// <since_tizen> 3</since_tizen>
36         public bool Success { get; }
37
38         /// <summary>
39         /// Gets the region which determines new position of the tracked face on the source.
40         /// </summary>
41         /// <since_tizen> 3</since_tizen>
42         public Quadrangle Region { get; }
43
44         /// <summary>
45         /// The confidence of the tracking model that new location of the face was determined correctly
46         /// (value from 0.0 to 1.0). If no location was determined during last track iteration, then value is 0.0.
47         /// </summary>
48         /// <since_tizen> 3</since_tizen>
49         public double Confidence { get; }
50     }
51 }