dali/devel-api/adaptor-framework/tilt-sensor.h

   1 #ifndef DALI_TILT_SENSOR_H
   2 #define DALI_TILT_SENSOR_H
   3
   4 /*
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/object/base-handle.h>
  23 #include <dali/public-api/signals/dali-signal.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/dali-adaptor-common.h>
  27
  28 namespace Dali
  29 {
  30 namespace Internal DALI_INTERNAL
  31 {
  32 namespace Adaptor
  33 {
  34 class TiltSensor;
  35 }
  36 } // namespace DALI_INTERNAL
  37
  38 /**
  39  * TiltSensor provides pitch & roll values when the device is tilted.
  40  * The basic usage is shown below:
  41  *
  42  * @code
  43  *
  44  *  void Example()
  45  *  {
  46  *    TiltSensor sensor = TiltSensor::Get();
  47  *
  48  *    // Try to start the tilt sensor
  49  *    if ( sensor.Start() )
  50  *    {
  51  *      // Query the current values
  52  *      std::cout << "Roll = " << sensor.GetRoll() << ", Pitch = " << sensor.GetPitch() << std::endl;
  53  *
  54  *      // Get notifications when the device is tilted
  55  *      sensor.TiltedSignal().Connect( &OnTilted );
  56  *    }
  57  *  }
  58  *
  59  *  void OnTilted( const TiltSensor& sensor )
  60  *  {
  61  *    // Query the new values
  62  *    std::cout << "Roll = " << sensor.GetRoll() << ", Pitch = " << sensor.GetPitch() << std::endl;
  63  *  }
  64  *
  65  * @endcode
  66  *
  67  * While the tilt sensor is started, it will periodically poll for the latest pitch & roll values.
  68  * For performance & power-saving, applications should disable this polling when no longer needed:
  69  *
  70  * @code
  71  *
  72  *  void EndExample()
  73  *  {
  74  *    // Stop the sensor when no longer needed
  75  *    TiltSensor::Get().Stop();
  76  *  }
  77  *
  78  * @endcode
  79  */
  80 class DALI_ADAPTOR_API TiltSensor : public BaseHandle
  81 {
  82 public:
  83   typedef Signal<void(const TiltSensor&)> TiltedSignalType;
  84
  85   static const float DEFAULT_UPDATE_FREQUENCY; // 60 hertz
  86
  87   /**
  88    * Create an uninitialized handle.
  89    * This can be initialized by calling TiltSensor::Get().
  90    */
  91   TiltSensor();
  92
  93   /**
  94    * Create an initialized handle to the TiltSensor.
  95    * @return A handle to a newly allocated Dali resource.
  96    */
  97   static TiltSensor Get();
  98
  99   /**
 100    * @brief Destructor
 101    *
 102    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 103    */
 104   ~TiltSensor();
 105
 106   /**
 107    * Attempt to start the tilt-sensor. This will fail if the underlying sensor hardware is powered-down,
 108    * typically this occurs when the device is set to "sleep" mode.
 109    * @return True if the tilt-sensor is started.
 110    */
 111   bool Start();
 112
 113   /**
 114    * Stop the tilt-sensor.
 115    */
 116   void Stop();
 117
 118   /**
 119    * Query whether the tilt-sensor is started.
 120    * The sensor may be disabled automatically; typically this occurs when the device is set to "sleep" mode.
 121    * @return True if the tilt-sensor is started.
 122    */
 123   bool IsStarted() const;
 124
 125   /**
 126    * Query the roll value. This is in the range -1 to 1.
 127    * When the device is lying face-up on a flat surface, this method will return a value close to zero.
 128    * A value close to 1 indicates that the right-side of the device is pointing upwards.
 129    * A value close to -1 indicates that the right-side of the device is pointing downwards.
 130    * @pre The tilt-sensor is started.
 131    * @return The roll value.
 132    */
 133   float GetRoll() const;
 134
 135   /**
 136    * Query the pitch value. This is in the range -1 to 1.
 137    * When the device is lying face-up on a flat surface, this method will return a value close to zero.
 138    * A value close to 1 indicates that the top of the device is pointing upwards.
 139    * A value close to -1 indicates that the top of the device is pointing downwards.
 140    * @pre The tilt-sensor is started.
 141    * @return The pitch value.
 142    */
 143   float GetPitch() const;
 144
 145   /**
 146    * Retrieve the rotation of the device.
 147    * When the device is lying face-up on a flat surface, the rotation angle will be approximately zero.
 148    * The roll & pitch of the device is considered to be a rotation around the Y and X axes respectively.
 149    * @pre The tilt-sensor is started.
 150    * @return The rotation in quaternion format.
 151    */
 152   Quaternion GetRotation() const;
 153
 154   /**
 155    * This signal will be emitted when the device is tilted, if the tilt-sensor is started.
 156    * The frequency of the signals can be controlled using SetUpdateFrequency().
 157    * @return The signal to connect to.
 158    *
 159    * @note The signal name is "tilted" if using BaseHandle::ConnectSignal()
 160    */
 161   TiltedSignalType& TiltedSignal();
 162
 163   /**
 164    * Set the sensor update frequency.
 165    * The default is TiltSensor::DEFAULT_UPDATE_FREQUENCY.
 166    * @param[in] frequencyHertz The frequency in hertz.
 167    */
 168   void SetUpdateFrequency(float frequencyHertz);
 169
 170   /**
 171    * Query the sensor update frequency.
 172    * @return The frequency in hertz.
 173    */
 174   float GetUpdateFrequency() const;
 175
 176   /**
 177    * Set the threshold value for rotation in Radians, above which TiltedSignal should be emitted.
 178    * The default is 0.0f in Radians (i.e) it will be emitted always at the frequency set.
 179    * Example tiltSensor.SetRotationThreshold( Radian(Degree(10) ) // A rotation threshold of 10 degrees
 180    * @param[in] rotationThreshold The threshold value for rotation.
 181    */
 182   void SetRotationThreshold(Radian rotationThreshold);
 183
 184   /**
 185    * Query the rotation threshold above which TiltedSignal will be emitted.
 186    * @return The rotation degree threshold in Radians.
 187    */
 188   Radian GetRotationThreshold() const;
 189
 190 public: // Not intended for application developers
 191   /**
 192    * This constructor is used by TiltSensor::Get().
 193    * @param[in] sensor A pointer to the tilt sensor.
 194    */
 195   explicit DALI_INTERNAL TiltSensor(Internal::Adaptor::TiltSensor* sensor);
 196 };
 197
 198 } // namespace Dali
 199
 200 #endif // DALI_TILT_SENSOR_H