2 * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 namespace Tizen.Sensor
22 /// The PickUpGestureDetector class is used for registering callbacks for the pick up activity detector and getting the pick up state.
24 /// <since_tizen> 3 </since_tizen>
25 public sealed class PickUpGestureDetector : Sensor
27 private static string GestureDetectorKey = "http://tizen.org/feature/sensor.gesture_recognition";
30 /// Gets the state of the pick up gesture.
32 /// <since_tizen> 3 </since_tizen>
33 /// <value> The pick up state. </value>
34 public DetectorState PickUp { get; private set; } = DetectorState.Unknown;
37 /// Returns true or false based on whether the pick up gesture detector is supported by the device.
39 /// <since_tizen> 3 </since_tizen>
40 /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
41 public static bool IsSupported
45 Log.Info(Globals.LogTag, "Checking if the pick up gesture detector is supported");
46 return CheckIfSupported(SensorType.PickUpGestureDetector, GestureDetectorKey);
51 /// Returns the number of pick up gesture detectors available on the device.
53 /// <since_tizen> 3 </since_tizen>
54 /// <value> The count of pick up gesture detectors. </value>
55 public static int Count
59 Log.Info(Globals.LogTag, "Getting the count of pick up gesture detectors");
65 /// Initializes a new instance of the <see cref="Tizen.Sensor.PickUpGestureDetector"/> class.
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 pick up gesture detector in case of multiple sensors.
75 public PickUpGestureDetector(uint index = 0) : base(index)
77 Log.Info(Globals.LogTag, "Creating pick up gesture detector object");
80 internal override SensorType GetSensorType()
82 return SensorType.PickUpGestureDetector;
85 private static bool CheckIfSupported()
88 int error = Interop.SensorManager.SensorIsSupported(SensorType.PickUpGestureDetector, out isSupported);
89 if (error != (int)SensorError.None)
91 Log.Error(Globals.LogTag, "Error checking if pick up gesture detector is supported");
97 private static int GetCount()
101 int error = Interop.SensorManager.GetSensorList(SensorType.PickUpGestureDetector, out list, out count);
102 if (error != (int)SensorError.None)
104 Log.Error(Globals.LogTag, "Error getting sensor list for pick up gesture detector");
108 Interop.Libc.Free(list);
113 /// Read pick up gesture detector data synchronously.
115 internal override void ReadData()
117 Interop.SensorEventStruct sensorData;
118 int error = Interop.SensorListener.ReadData(ListenerHandle, out sensorData);
119 if (error != (int)SensorError.None)
121 Log.Error(Globals.LogTag, "Error reading pick up gesture detector data");
122 throw SensorErrorFactory.CheckAndThrowException(error, "Reading pick up gesture detector data failed");
125 TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
126 PickUp = (DetectorState)sensorData.values[0];
130 /// An event handler for storing the callback functions for the event corresponding to the change in the pick up gesture detector data.
132 /// <since_tizen> 3 </since_tizen>
133 public event EventHandler<PickUpGestureDetectorDataUpdatedEventArgs> DataUpdated;
135 private static Interop.SensorListener.SensorEventCallback _callback;
137 internal override void EventListenStart()
139 _callback = (IntPtr sensorHandle, IntPtr eventPtr, IntPtr data) => {
140 Interop.SensorEventStruct sensorData = Interop.IntPtrToEventStruct(eventPtr);
142 TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
143 PickUp = (DetectorState) sensorData.values[0];
145 DataUpdated?.Invoke(this, new PickUpGestureDetectorDataUpdatedEventArgs(sensorData.values[0]));
148 int error = Interop.SensorListener.SetEventCallback(ListenerHandle, Interval, _callback, IntPtr.Zero);
149 if (error != (int)SensorError.None)
151 Log.Error(Globals.LogTag, "Error setting event callback for pick up gesture detector");
152 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set event callback for pick up gesture detector");
156 internal override void EventListenStop()
158 int error = Interop.SensorListener.UnsetEventCallback(ListenerHandle);
159 if (error != (int)SensorError.None)
161 Log.Error(Globals.LogTag, "Error unsetting event callback for pick up gesture detector");
162 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset event callback for pick up gesture detector");