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 /// RotationVectorSensor Class. Used for registering callbacks for rotation vector sensor and getting rotation vector data
24 public sealed class RotationVectorSensor : Sensor
26 private static string RotationVectorKey = "http://tizen.org/feature/sensor.rotation_vector";
28 private event EventHandler<SensorAccuracyChangedEventArgs> _accuracyChanged;
30 /// Gets the X component of the rotation vector.
32 /// <since_tizen> 3 </since_tizen>
33 /// <value> X </value>
34 public float X { get; private set; } = float.MinValue;
37 /// Gets the Y component of the rotation vector.
39 /// <since_tizen> 3 </since_tizen>
40 /// <value> Y </value>
41 public float Y { get; private set; } = float.MinValue;
44 /// Gets the Z component of the rotation vector.
46 /// <since_tizen> 3 </since_tizen>
47 /// <value> Z </value>
48 public float Z { get; private set; } = float.MinValue;
51 /// Gets the W component of the rotation vector.
53 /// <since_tizen> 3 </since_tizen>
54 /// <value> W </value>
55 public float W { get; private set; } = float.MinValue;
58 /// Gets the Accuracy of the rotation vector data.
60 /// <since_tizen> 3 </since_tizen>
61 /// <value> Accuracy </value>
62 public SensorDataAccuracy Accuracy { get; private set; } = SensorDataAccuracy.Undefined;
65 /// Returns true or false based on whether rotation vector sensor is supported by device.
67 /// <since_tizen> 3 </since_tizen>
68 /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
69 public static bool IsSupported
73 Log.Info(Globals.LogTag, "Checking if the RotationVectorSensor is supported");
74 return CheckIfSupported(SensorType.RotationVectorSensor, RotationVectorKey);
79 /// Returns the number of rotation vector sensors available on the device.
81 /// <since_tizen> 3 </since_tizen>
82 /// <value> The count of rotation vector sensors </value>
83 public static int Count
87 Log.Info(Globals.LogTag, "Getting the count of rotation vector sensors");
93 /// Initializes a new instance of the <see cref="Tizen.Sensor.RotationVectorSensor"/> class.
95 /// <since_tizen> 3 </since_tizen>
96 /// <feature>http://tizen.org/feature/sensor.rotation_vector</feature>
97 /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
98 /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
99 /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
100 /// <param name='index'>
101 /// Index. Default value for this is 0. Index refers to a particular rotation vector sensor in case of multiple sensors
103 public RotationVectorSensor(uint index = 0) : base(index)
105 Log.Info(Globals.LogTag, "Creating RotationVectorSensor object");
108 internal override SensorType GetSensorType()
110 return SensorType.RotationVectorSensor;
114 /// Event Handler for storing the callback functions for event corresponding to change in rotation vector sensor data.
116 /// <since_tizen> 3 </since_tizen>
118 public event EventHandler<RotationVectorSensorDataUpdatedEventArgs> DataUpdated;
121 /// Event handler for accuracy changed events.
123 /// <since_tizen> 3 </since_tizen>
124 public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
128 if (_accuracyChanged == null)
130 AccuracyListenStart();
132 _accuracyChanged += value;
136 _accuracyChanged -= value;
137 if (_accuracyChanged == null)
139 AccuracyListenStop();
144 private static int GetCount()
148 int error = Interop.SensorManager.GetSensorList(SensorType.RotationVectorSensor, out list, out count);
149 if (error != (int)SensorError.None)
151 Log.Error(Globals.LogTag, "Error getting sensor list for rotation vector");
155 Interop.Libc.Free(list);
159 private static Interop.SensorListener.SensorEventCallback _callback;
161 internal override void EventListenStart()
163 _callback = (IntPtr sensorHandle, IntPtr eventPtr, IntPtr data) => {
164 Interop.SensorEventStruct sensorData = Interop.IntPtrToEventStruct(eventPtr);
166 TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
167 X = sensorData.values[0];
168 Y = sensorData.values[1];
169 Z = sensorData.values[2];
170 W = sensorData.values[3];
171 Accuracy = sensorData.accuracy;
173 DataUpdated?.Invoke(this, new RotationVectorSensorDataUpdatedEventArgs(sensorData.values, sensorData.accuracy));
176 int error = Interop.SensorListener.SetEventCallback(ListenerHandle, Interval, _callback, IntPtr.Zero);
177 if (error != (int)SensorError.None)
179 Log.Error(Globals.LogTag, "Error setting event callback for rotation vector sensor");
180 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set event callback for rotation vector");
184 internal override void EventListenStop()
186 int error = Interop.SensorListener.UnsetEventCallback(ListenerHandle);
187 if (error != (int)SensorError.None)
189 Log.Error(Globals.LogTag, "Error unsetting event callback for rotation vector sensor");
190 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset event callback for rotation vector");
194 private static Interop.SensorListener.SensorAccuracyCallback _accuracyCallback;
196 private void AccuracyListenStart()
198 _accuracyCallback = (IntPtr sensorHandle, UInt64 timestamp, SensorDataAccuracy accuracy, IntPtr data) => {
199 TimeSpan = new TimeSpan((Int64)timestamp);
201 _accuracyChanged?.Invoke(this, new SensorAccuracyChangedEventArgs(new TimeSpan((Int64)timestamp), accuracy));
204 int error = Interop.SensorListener.SetAccuracyCallback(ListenerHandle, _accuracyCallback, IntPtr.Zero);
205 if (error != (int)SensorError.None)
207 Log.Error(Globals.LogTag, "Error setting accuracy event callback for rotation vector sensor");
208 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set accuracy event callback for rotation vector");
212 private void AccuracyListenStop()
214 int error = Interop.SensorListener.UnsetAccuracyCallback(ListenerHandle);
215 if (error != (int)SensorError.None)
217 Log.Error(Globals.LogTag, "Error unsetting accuracy event callback for rotation vector sensor");
218 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset accuracy event callback for rotation vector");