1 #ifndef __DALI_TILT_SENSOR_H__
2 #define __DALI_TILT_SENSOR_H__
5 * Copyright (c) 2015 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>
28 namespace Internal DALI_INTERNAL
37 * TiltSensor provides pitch & roll values when the device is tilted.
38 * The basic usage is shown below:
44 * TiltSensor sensor = TiltSensor::Get();
46 * // Try to start the tilt sensor
47 * if ( sensor.Start() )
49 * // Query the current values
50 * std::cout << "Roll = " << sensor.GetRoll() << ", Pitch = " << sensor.GetPitch() << std::endl;
52 * // Get notifications when the device is tilted
53 * sensor.TiltedSignal().Connect( &OnTilted );
57 * void OnTilted( const TiltSensor& sensor )
59 * // Query the new values
60 * std::cout << "Roll = " << sensor.GetRoll() << ", Pitch = " << sensor.GetPitch() << std::endl;
65 * While the tilt sensor is started, it will periodically poll for the latest pitch & roll values.
66 * For performance & power-saving, applications should disable this polling when no longer needed:
72 * // Stop the sensor when no longer needed
73 * TiltSensor::Get().Stop();
78 class DALI_IMPORT_API TiltSensor : public BaseHandle
82 typedef Signal< void (const TiltSensor&) > TiltedSignalType;
84 static const float DEFAULT_UPDATE_FREQUENCY; // 60 hertz
87 * Create an uninitialized handle.
88 * This can be initialized by calling TiltSensor::Get().
93 * Create an initialized handle to the TiltSensor.
94 * @return A handle to a newly allocated Dali resource.
96 static TiltSensor Get();
101 * This is non-virtual since derived Handle types must not contain data or virtual methods.
106 * Attempt to start the tilt-sensor. This will fail if the underlying sensor hardware is powered-down,
107 * typically this occurs when the device is set to "sleep" mode.
108 * @return True if the tilt-sensor is started.
113 * Stop the tilt-sensor.
118 * Query whether the tilt-sensor is started.
119 * The sensor may be disabled automatically; typically this occurs when the device is set to "sleep" mode.
120 * @return True if the tilt-sensor is started.
122 bool IsStarted() const;
125 * Query the roll value. This is in the range -1 to 1.
126 * When the device is lying face-up on a flat surface, this method will return a value close to zero.
127 * A value close to 1 indicates that the right-side of the device is pointing upwards.
128 * A value close to -1 indicates that the right-side of the device is pointing downwards.
129 * @pre The tilt-sensor is started.
130 * @return The roll value.
132 float GetRoll() const;
135 * Query the pitch value. This is in the range -1 to 1.
136 * When the device is lying face-up on a flat surface, this method will return a value close to zero.
137 * A value close to 1 indicates that the top of the device is pointing upwards.
138 * A value close to -1 indicates that the top of the device is pointing downwards.
139 * @pre The tilt-sensor is started.
140 * @return The pitch value.
142 float GetPitch() const;
145 * Retrieve the rotation of the device.
146 * When the device is lying face-up on a flat surface, the rotation angle will be approximately zero.
147 * The roll & pitch of the device is considered to be a rotation around the Y and X axes respectively.
148 * @pre The tilt-sensor is started.
149 * @return The rotation in quaternion format.
151 Quaternion GetRotation() const;
154 * This signal will be emitted when the device is tilted, if the tilt-sensor is started.
155 * The frequency of the signals can be controlled using SetUpdateFrequency().
156 * @return The signal to connect to.
158 * @note The signal name is "tilted" if using BaseHandle::ConnectSignal()
160 TiltedSignalType& TiltedSignal();
163 * Set the sensor update frequency.
164 * The default is TiltSensor::DEFAULT_UPDATE_FREQUENCY.
165 * @param[in] frequencyHertz The frequency in hertz.
167 void SetUpdateFrequency( float frequencyHertz );
170 * Query the sensor update frequency.
171 * @return The frequency in hertz.
173 float GetUpdateFrequency() const;
176 * Set the threshold value for rotation in Radians, above which TiltedSignal should be emitted.
177 * The default is 0.0f in Radians (i.e) it will be emitted always at the frequency set.
178 * Example tiltSensor.SetRotationThreshold( Radian(Degree(10) ) // A rotation threshold of 10 degrees
179 * @param[in] rotationThreshold The threshold value for rotation.
181 void SetRotationThreshold( Radian rotationThreshold );
184 * Query the rotation threshold above which TiltedSignal will be emitted.
185 * @return The rotation degree threshold in Radians.
187 Radian GetRotationThreshold() const;
189 public: // Not intended for application developers
192 * This constructor is used by TiltSensor::Get().
193 * @param[in] sensor A pointer to the tilt sensor.
195 explicit DALI_INTERNAL TiltSensor( Internal::Adaptor::TiltSensor* sensor );
200 #endif // __DALI_TILT_SENSOR_H__