src/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.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 RotationVectorSensor class is used for registering callbacks for the rotation vector sensor and getting the rotation vector data.
  23     /// </summary>
  24     /// <since_tizen> 3 </since_tizen>
  25     public sealed class RotationVectorSensor : Sensor
  26     {
  27         private static string RotationVectorKey = "http://tizen.org/feature/sensor.rotation_vector";
  28
  29         private event EventHandler<SensorAccuracyChangedEventArgs> _accuracyChanged;
  30         /// <summary>
  31         /// Gets the X component of the rotation vector.
  32         /// </summary>
  33         /// <since_tizen> 3 </since_tizen>
  34         /// <value> X </value>
  35         public float X { get; private set; } = float.MinValue;
  36
  37         /// <summary>
  38         /// Gets the Y component of the rotation vector.
  39         /// </summary>
  40         /// <since_tizen> 3 </since_tizen>
  41         /// <value> Y </value>
  42         public float Y { get; private set; } = float.MinValue;
  43
  44         /// <summary>
  45         /// Gets the Z component of the rotation vector.
  46         /// </summary>
  47         /// <since_tizen> 3 </since_tizen>
  48         /// <value> Z </value>
  49         public float Z { get; private set; } = float.MinValue;
  50
  51         /// <summary>
  52         /// Gets the W component of the rotation vector.
  53         /// </summary>
  54         /// <since_tizen> 3 </since_tizen>
  55         /// <value> W </value>
  56         public float W { get; private set; } = float.MinValue;
  57
  58         /// <summary>
  59         /// Gets the accuracy of the rotation vector data.
  60         /// </summary>
  61         /// <since_tizen> 3 </since_tizen>
  62         /// <value> Accuracy </value>
  63         public SensorDataAccuracy Accuracy { get; private set; } = SensorDataAccuracy.Undefined;
  64
  65         /// <summary>
  66         /// Returns true or false based on whether the rotation vector sensor is supported by the device.
  67         /// </summary>
  68         /// <since_tizen> 3 </since_tizen>
  69         /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
  70         public static bool IsSupported
  71         {
  72             get
  73             {
  74                 Log.Info(Globals.LogTag, "Checking if the RotationVectorSensor is supported");
  75                 return CheckIfSupported(SensorType.RotationVectorSensor, RotationVectorKey);
  76             }
  77         }
  78
  79         /// <summary>
  80         /// Returns the number of rotation vector sensors available on the device.
  81         /// </summary>
  82         /// <since_tizen> 3 </since_tizen>
  83         /// <value> The count of rotation vector sensors. </value>
  84         public static int Count
  85         {
  86             get
  87             {
  88                 Log.Info(Globals.LogTag, "Getting the count of rotation vector sensors");
  89                 return GetCount();
  90             }
  91         }
  92
  93         /// <summary>
  94         /// Initializes a new instance of the <see cref="Tizen.Sensor.RotationVectorSensor"/> class.
  95         /// </summary>
  96         /// <since_tizen> 3 </since_tizen>
  97         /// <feature>http://tizen.org/feature/sensor.rotation_vector</feature>
  98         /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
  99         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
 100         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
 101         /// <param name='index'>
 102         /// Index. Default value for this is 0. Index refers to a particular rotation vector sensor in case of multiple sensors.
 103         /// </param>
 104         public RotationVectorSensor(uint index = 0) : base(index)
 105         {
 106             Log.Info(Globals.LogTag, "Creating RotationVectorSensor object");
 107         }
 108
 109         internal override SensorType GetSensorType()
 110         {
 111             return SensorType.RotationVectorSensor;
 112         }
 113
 114         /// <summary>
 115         /// An event handler for storing the callback functions for the event corresponding to the change in the rotation vector sensor data.
 116         /// </summary>
 117         /// <since_tizen> 3 </since_tizen>
 118
 119         public event EventHandler<RotationVectorSensorDataUpdatedEventArgs> DataUpdated;
 120
 121         /// <summary>
 122         /// An event handler for accuracy changed events.
 123         /// </summary>
 124         /// <since_tizen> 3 </since_tizen>
 125         public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
 126         {
 127             add
 128             {
 129                 if (_accuracyChanged == null)
 130                 {
 131                     AccuracyListenStart();
 132                 }
 133                 _accuracyChanged += value;
 134             }
 135             remove
 136             {
 137                 _accuracyChanged -= value;
 138                 if (_accuracyChanged == null)
 139                 {
 140                     AccuracyListenStop();
 141                 }
 142             }
 143         }
 144
 145         private static int GetCount()
 146         {
 147             IntPtr list;
 148             int count;
 149             int error = Interop.SensorManager.GetSensorList(SensorType.RotationVectorSensor, out list, out count);
 150             if (error != (int)SensorError.None)
 151             {
 152                 Log.Error(Globals.LogTag, "Error getting sensor list for rotation vector");
 153                 count = 0;
 154             }
 155             else
 156                 Interop.Libc.Free(list);
 157             return count;
 158         }
 159
 160         /// <summary>
 161         /// Read rotation vector sensor data synchronously.
 162         /// </summary>
 163         internal override void ReadData()
 164         {
 165             Interop.SensorEventStruct sensorData;
 166             int error = Interop.SensorListener.ReadData(ListenerHandle, out sensorData);
 167             if (error != (int)SensorError.None)
 168             {
 169                 Log.Error(Globals.LogTag, "Error reading rotation vector sensor data");
 170                 throw SensorErrorFactory.CheckAndThrowException(error, "Reading rotation vector sensor data failed");
 171             }
 172
 173             TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
 174             X = sensorData.values[0];
 175             Y = sensorData.values[1];
 176             Z = sensorData.values[2];
 177             W = sensorData.values[3];
 178             Accuracy = sensorData.accuracy;
 179         }
 180
 181         private static Interop.SensorListener.SensorEventCallback _callback;
 182
 183         internal override void EventListenStart()
 184         {
 185             _callback = (IntPtr sensorHandle, IntPtr eventPtr, IntPtr data) => {
 186                 Interop.SensorEventStruct sensorData = Interop.IntPtrToEventStruct(eventPtr);
 187
 188                 TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
 189                 X = sensorData.values[0];
 190                 Y = sensorData.values[1];
 191                 Z = sensorData.values[2];
 192                 W = sensorData.values[3];
 193                 Accuracy = sensorData.accuracy;
 194
 195                 DataUpdated?.Invoke(this, new RotationVectorSensorDataUpdatedEventArgs(sensorData.values, sensorData.accuracy));
 196             };
 197
 198             int error = Interop.SensorListener.SetEventCallback(ListenerHandle, Interval, _callback, IntPtr.Zero);
 199             if (error != (int)SensorError.None)
 200             {
 201                 Log.Error(Globals.LogTag, "Error setting event callback for rotation vector sensor");
 202                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set event callback for rotation vector");
 203             }
 204         }
 205
 206         internal override void EventListenStop()
 207         {
 208             int error = Interop.SensorListener.UnsetEventCallback(ListenerHandle);
 209             if (error != (int)SensorError.None)
 210             {
 211                 Log.Error(Globals.LogTag, "Error unsetting event callback for rotation vector sensor");
 212                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset event callback for rotation vector");
 213             }
 214         }
 215
 216         private static Interop.SensorListener.SensorAccuracyCallback _accuracyCallback;
 217
 218         private void AccuracyListenStart()
 219         {
 220             _accuracyCallback = (IntPtr sensorHandle, UInt64 timestamp, SensorDataAccuracy accuracy, IntPtr data) => {
 221                 TimeSpan = new TimeSpan((Int64)timestamp);
 222                 Accuracy = accuracy;
 223                 _accuracyChanged?.Invoke(this, new SensorAccuracyChangedEventArgs(new TimeSpan((Int64)timestamp), accuracy));
 224             };
 225
 226             int error = Interop.SensorListener.SetAccuracyCallback(ListenerHandle, _accuracyCallback, IntPtr.Zero);
 227             if (error != (int)SensorError.None)
 228             {
 229                 Log.Error(Globals.LogTag, "Error setting accuracy event callback for rotation vector sensor");
 230                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set accuracy event callback for rotation vector");
 231             }
 232         }
 233
 234         private void AccuracyListenStop()
 235         {
 236             int error = Interop.SensorListener.UnsetAccuracyCallback(ListenerHandle);
 237             if (error != (int)SensorError.None)
 238             {
 239                 Log.Error(Globals.LogTag, "Error unsetting accuracy event callback for rotation vector sensor");
 240                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset accuracy event callback for rotation vector");
 241             }
 242         }
 243     }
 244 }