1 #ifndef DALI_ORIENTATION_H
2 #define DALI_ORIENTATION_H
5 * Copyright (c) 2020 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>
30 namespace Internal DALI_INTERNAL
36 } // namespace DALI_INTERNAL
39 * @brief Orientation allows the user to determine the orientation of the device.
41 * A signal is emitted whenever the orientation changes.
42 * Dali applications have full control over visual layout when the device is rotated
43 * i.e. the application developer decides which UI controls to rotate, if any.
45 class DALI_ADAPTOR_API Orientation : public BaseHandle
48 typedef Signal<void(Orientation)> OrientationSignalType; ///< Orientation changed signal type
51 * @brief Create an unintialized handle.
53 * This can be initialized by calling Dali::Application::GetOrientation()
60 * This is non-virtual since derived Handle types must not contain data or virtual methods.
65 * @brief This copy constructor is required for (smart) pointer semantics.
67 * @param [in] handle A reference to the copied handle
69 Orientation(const Orientation& handle);
72 * @brief This assignment operator is required for (smart) pointer semantics.
74 * @param [in] rhs A reference to the copied handle
75 * @return A reference to this
77 Orientation& operator=(const Orientation& rhs);
80 * @brief Returns the orientation of the device in degrees.
82 * This is one of four discrete values, in degrees clockwise: 0, 90, 180, & 270
83 * For a device with a portrait form-factor:
84 * 0 indicates that the device is in the "normal" portrait orientation.
85 * 90 indicates that device has been rotated clockwise, into a landscape orientation.
86 * @return The orientation in degrees clockwise.
88 int GetDegrees() const;
91 * @brief Returns the orientation of the device in radians.
93 * This is one of four discrete values, in radians clockwise: 0, PI/2, PI, & 3xPI/2
94 * For a device with a portrait form-factor:
95 * 0 indicates that the device is in the "normal" portrait orientation.
96 * PI/2 indicates that device has been rotated clockwise, into a landscape orientation.
97 * @return The orientation in radians clockwise.
99 float GetRadians() const;
102 * @brief The user should connect to this signal so that they can be notified whenever
103 * the orientation of the device changes.
105 * @return The orientation change signal.
107 OrientationSignalType& ChangedSignal();
109 public: // Not intended for application developers
111 * @brief Helper function.
113 * @param[in] orientation A pointer to the orientation object
115 explicit DALI_INTERNAL Orientation(Internal::Adaptor::Orientation* orientation);
120 #endif // DALI_ORIENTATION_H