1 #ifndef __DALI_TILT_SENSOR_H__
2 #define __DALI_TILT_SENSOR_H__
5 * Copyright (c) 2018 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/object/base-handle.h>
23 #include <dali/public-api/signals/dali-signal.h>
26 #include <dali/public-api/dali-adaptor-common.h>
31 namespace Internal DALI_INTERNAL
40 * TiltSensor provides pitch & roll values when the device is tilted.
41 * The basic usage is shown below:
47 * TiltSensor sensor = TiltSensor::Get();
49 * // Try to start the tilt sensor
50 * if ( sensor.Start() )
52 * // Query the current values
53 * std::cout << "Roll = " << sensor.GetRoll() << ", Pitch = " << sensor.GetPitch() << std::endl;
55 * // Get notifications when the device is tilted
56 * sensor.TiltedSignal().Connect( &OnTilted );
60 * void OnTilted( const TiltSensor& sensor )
62 * // Query the new values
63 * std::cout << "Roll = " << sensor.GetRoll() << ", Pitch = " << sensor.GetPitch() << std::endl;
68 * While the tilt sensor is started, it will periodically poll for the latest pitch & roll values.
69 * For performance & power-saving, applications should disable this polling when no longer needed:
75 * // Stop the sensor when no longer needed
76 * TiltSensor::Get().Stop();
81 class DALI_ADAPTOR_API TiltSensor : public BaseHandle
85 typedef Signal< void (const TiltSensor&) > TiltedSignalType;
87 static const float DEFAULT_UPDATE_FREQUENCY; // 60 hertz
90 * Create an uninitialized handle.
91 * This can be initialized by calling TiltSensor::Get().
96 * Create an initialized handle to the TiltSensor.
97 * @return A handle to a newly allocated Dali resource.
99 static TiltSensor Get();
104 * This is non-virtual since derived Handle types must not contain data or virtual methods.
109 * Attempt to start the tilt-sensor. This will fail if the underlying sensor hardware is powered-down,
110 * typically this occurs when the device is set to "sleep" mode.
111 * @return True if the tilt-sensor is started.
116 * Stop the tilt-sensor.
121 * Query whether the tilt-sensor is started.
122 * The sensor may be disabled automatically; typically this occurs when the device is set to "sleep" mode.
123 * @return True if the tilt-sensor is started.
125 bool IsStarted() const;
128 * Query the roll value. This is in the range -1 to 1.
129 * When the device is lying face-up on a flat surface, this method will return a value close to zero.
130 * A value close to 1 indicates that the right-side of the device is pointing upwards.
131 * A value close to -1 indicates that the right-side of the device is pointing downwards.
132 * @pre The tilt-sensor is started.
133 * @return The roll value.
135 float GetRoll() const;
138 * Query the pitch value. This is in the range -1 to 1.
139 * When the device is lying face-up on a flat surface, this method will return a value close to zero.
140 * A value close to 1 indicates that the top of the device is pointing upwards.
141 * A value close to -1 indicates that the top of the device is pointing downwards.
142 * @pre The tilt-sensor is started.
143 * @return The pitch value.
145 float GetPitch() const;
148 * Retrieve the rotation of the device.
149 * When the device is lying face-up on a flat surface, the rotation angle will be approximately zero.
150 * The roll & pitch of the device is considered to be a rotation around the Y and X axes respectively.
151 * @pre The tilt-sensor is started.
152 * @return The rotation in quaternion format.
154 Quaternion GetRotation() const;
157 * This signal will be emitted when the device is tilted, if the tilt-sensor is started.
158 * The frequency of the signals can be controlled using SetUpdateFrequency().
159 * @return The signal to connect to.
161 * @note The signal name is "tilted" if using BaseHandle::ConnectSignal()
163 TiltedSignalType& TiltedSignal();
166 * Set the sensor update frequency.
167 * The default is TiltSensor::DEFAULT_UPDATE_FREQUENCY.
168 * @param[in] frequencyHertz The frequency in hertz.
170 void SetUpdateFrequency( float frequencyHertz );
173 * Query the sensor update frequency.
174 * @return The frequency in hertz.
176 float GetUpdateFrequency() const;
179 * Set the threshold value for rotation in Radians, above which TiltedSignal should be emitted.
180 * The default is 0.0f in Radians (i.e) it will be emitted always at the frequency set.
181 * Example tiltSensor.SetRotationThreshold( Radian(Degree(10) ) // A rotation threshold of 10 degrees
182 * @param[in] rotationThreshold The threshold value for rotation.
184 void SetRotationThreshold( Radian rotationThreshold );
187 * Query the rotation threshold above which TiltedSignal will be emitted.
188 * @return The rotation degree threshold in Radians.
190 Radian GetRotationThreshold() const;
192 public: // Not intended for application developers
195 * This constructor is used by TiltSensor::Get().
196 * @param[in] sensor A pointer to the tilt sensor.
198 explicit DALI_INTERNAL TiltSensor( Internal::Adaptor::TiltSensor* sensor );
203 #endif // __DALI_TILT_SENSOR_H__