dali/devel-api/adaptor-framework/orientation.h

   1 #ifndef __DALI_ORIENTATION_H__
   2 #define __DALI_ORIENTATION_H__
   3
   4 /*
   5  * Copyright (c) 2018 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/signals/dali-signal.h>
  23 #include <dali/public-api/object/base-handle.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/dali-adaptor-common.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace Internal DALI_INTERNAL
  32 {
  33 namespace Adaptor
  34 {
  35 class Orientation;
  36 }
  37 }
  38
  39 /**
  40  * @brief Orientation allows the user to determine the orientation of the device.
  41  *
  42  * A signal is emitted whenever the orientation changes.
  43  * Dali applications have full control over visual layout when the device is rotated
  44  * i.e. the application developer decides which UI controls to rotate, if any.
  45  */
  46 class DALI_ADAPTOR_API Orientation : public BaseHandle
  47 {
  48 public:
  49
  50   typedef Signal< void (Orientation) > OrientationSignalType; ///< Orientation changed signal type
  51
  52   /**
  53    * @brief Create an unintialized handle.
  54    *
  55    * This can be initialized by calling Dali::Application::GetOrientation()
  56    */
  57   Orientation();
  58
  59   /**
  60    * @brief Destructor
  61    *
  62    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  63    */
  64   ~Orientation();
  65
  66   /**
  67    * @brief This copy constructor is required for (smart) pointer semantics.
  68    *
  69    * @param [in] handle A reference to the copied handle
  70    */
  71   Orientation(const Orientation& handle);
  72
  73   /**
  74    * @brief This assignment operator is required for (smart) pointer semantics.
  75    *
  76    * @param [in] rhs  A reference to the copied handle
  77    * @return A reference to this
  78    */
  79   Orientation& operator=(const Orientation& rhs);
  80
  81   /**
  82    * @brief Returns the orientation of the device in degrees.
  83    *
  84    * This is one of four discrete values, in degrees clockwise: 0, 90, 180, & 270
  85    * For a device with a portrait form-factor:
  86    *   0 indicates that the device is in the "normal" portrait orientation.
  87    *   90 indicates that device has been rotated clockwise, into a landscape orientation.
  88    * @return The orientation in degrees clockwise.
  89    */
  90   int GetDegrees() const;
  91
  92   /**
  93    * @brief Returns the orientation of the device in radians.
  94    *
  95    * This is one of four discrete values, in radians clockwise: 0, PI/2, PI, & 3xPI/2
  96    * For a device with a portrait form-factor:
  97    *   0 indicates that the device is in the "normal" portrait orientation.
  98    *   PI/2 indicates that device has been rotated clockwise, into a landscape orientation.
  99    * @return The orientation in radians clockwise.
 100    */
 101   float GetRadians() const;
 102
 103   /**
 104    * @brief The user should connect to this signal so that they can be notified whenever
 105    * the orientation of the device changes.
 106    *
 107    * @return The orientation change signal.
 108    */
 109   OrientationSignalType& ChangedSignal();
 110
 111 public: // Not intended for application developers
 112   /**
 113    * @brief Helper function.
 114    *
 115    * @param[in] orientation A pointer to the orientation object
 116    */
 117   explicit DALI_INTERNAL Orientation( Internal::Adaptor::Orientation* orientation );
 118 };
 119
 120 } // namespace Dali
 121
 122 #endif // __DALI_ORIENTATION_H__