src/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.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 using System;
  18
  19 namespace Tizen.Sensor
  20 {
  21     /// <summary>
  22     /// The FaceDownGestureDetector class is used for registering callbacks for the face down gesture detector and getting the face down state.
  23     /// </summary>
  24     /// <since_tizen> 3 </since_tizen>
  25     public sealed class FaceDownGestureDetector : Sensor
  26     {
  27         private static string GestureDetectorKey = "http://tizen.org/feature/sensor.gesture_recognition";
  28
  29         /// <summary>
  30         /// Gets the state of the face down gesture.
  31         /// </summary>
  32         /// <since_tizen> 3 </since_tizen>
  33         /// <value> The face down state. </value>
  34         public DetectorState FaceDown { get; private set; } = DetectorState.Unknown;
  35
  36         /// <summary>
  37         /// Returns true or false based on whether the face down gesture detector is supported by the device.
  38         /// </summary>
  39         /// <since_tizen> 3 </since_tizen>
  40         /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
  41         public static bool IsSupported
  42         {
  43             get
  44             {
  45                 Log.Info(Globals.LogTag, "Checking if the face down gesture detector is supported");
  46                 return CheckIfSupported(SensorType.FaceDownGestureDetector, GestureDetectorKey);
  47             }
  48         }
  49
  50         /// <summary>
  51         /// Returns the number of face down gesture detectors available on the device.
  52         /// </summary>
  53         /// <since_tizen> 3 </since_tizen>
  54         /// <value> The count of face down gesture detectors. </value>
  55         public static int Count
  56         {
  57             get
  58             {
  59                 Log.Info(Globals.LogTag, "Getting the count of face down gesture detectors");
  60                 return GetCount();
  61             }
  62         }
  63
  64         /// <summary>
  65         /// Initializes a new instance of the <see cref="Tizen.Sensor.FaceDownGestureDetector"/> class.
  66         /// </summary>
  67         /// <since_tizen> 3 </since_tizen>
  68         /// <feature>http://tizen.org/feature/sensor.gesture_recognition</feature>
  69         /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
  70         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
  71         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
  72         /// <param name='index'>
  73         /// Index. Default value for this is 0. Index refers to a particular face down gesture detector in case of multiple sensors.
  74         /// </param>
  75         public FaceDownGestureDetector(uint index = 0) : base(index)
  76         {
  77             Log.Info(Globals.LogTag, "Creating face down gesture detector object");
  78         }
  79
  80         internal override SensorType GetSensorType()
  81         {
  82             return SensorType.FaceDownGestureDetector;
  83         }
  84
  85         private static int GetCount()
  86         {
  87             IntPtr list;
  88             int count;
  89             int error = Interop.SensorManager.GetSensorList(SensorType.FaceDownGestureDetector, out list, out count);
  90             if (error != (int)SensorError.None)
  91             {
  92                 Log.Error(Globals.LogTag, "Error getting sensor list for face down gesture detector");
  93                 count = 0;
  94             }
  95             else
  96                 Interop.Libc.Free(list);
  97             return count;
  98         }
  99
 100         /// <summary>
 101         /// Read face down gesture detector data synchronously.
 102         /// </summary>
 103         internal override void ReadData()
 104         {
 105             Interop.SensorEventStruct sensorData;
 106             int error = Interop.SensorListener.ReadData(ListenerHandle, out sensorData);
 107             if (error != (int)SensorError.None)
 108             {
 109                 Log.Error(Globals.LogTag, "Error reading face down gesture detector data");
 110                 throw SensorErrorFactory.CheckAndThrowException(error, "Reading face down gesture detector data failed");
 111             }
 112
 113             TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
 114             FaceDown = (DetectorState)sensorData.values[0];
 115         }
 116
 117         /// <summary>
 118         /// An event handler for storing the callback functions for the event corresponding to the change in the face down gesture detector data.
 119         /// </summary>
 120         /// <since_tizen> 3 </since_tizen>
 121         public event EventHandler<FaceDownGestureDetectorDataUpdatedEventArgs> DataUpdated;
 122
 123         private static Interop.SensorListener.SensorEventCallback _callback;
 124
 125         internal override void EventListenStart()
 126         {
 127             _callback = (IntPtr sensorHandle, IntPtr eventPtr, IntPtr data) => {
 128                 Interop.SensorEventStruct sensorData = Interop.IntPtrToEventStruct(eventPtr);
 129
 130                 TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
 131                 FaceDown = (DetectorState) sensorData.values[0];
 132
 133                 DataUpdated?.Invoke(this, new FaceDownGestureDetectorDataUpdatedEventArgs(sensorData.values[0]));
 134             };
 135
 136             int error = Interop.SensorListener.SetEventCallback(ListenerHandle, Interval, _callback, IntPtr.Zero);
 137             if (error != (int)SensorError.None)
 138             {
 139                 Log.Error(Globals.LogTag, "Error setting event callback for face down gesture detector");
 140                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set event callback for face down gesture detector");
 141             }
 142         }
 143
 144         internal override void EventListenStop()
 145         {
 146             int error = Interop.SensorListener.UnsetEventCallback(ListenerHandle);
 147             if (error != (int)SensorError.None)
 148             {
 149                 Log.Error(Globals.LogTag, "Error unsetting event callback for face down gesture detector");
 150                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset event callback for face down gesture detector");
 151             }
 152         }
 153     }
 154 }