1 #ifndef DALI_ROTATION_GESTURE_DETECTOR_H
2 #define DALI_ROTATION_GESTURE_DETECTOR_H
5 * Copyright (c) 2022 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/events/gesture-detector.h>
23 #include <dali/public-api/signals/dali-signal.h>
27 namespace Internal DALI_INTERNAL
29 class RotationGestureDetector;
32 class RotationGesture;
35 * @brief This class looks for a rotation gesture involving two touches.
37 * It measures the relative rotation of two touch points & emits a signal
38 * when this changes. Please see RotationGesture for more information.
40 * The application programmer can use this gesture detector as follows:
42 * RotationGestureDetector detector = RotationGestureDetector::New();
43 * detector.Attach( myActor );
44 * detector.DetectedSignal().Connect( this, &MyApplication::OnRotation );
47 * @see RotationGesture
50 * | %Signal Name | Method |
51 * |-------------------|-----------------------|
52 * | rotationDetected | @ref DetectedSignal() |
56 class DALI_CORE_API RotationGestureDetector : public GestureDetector
62 using DetectedSignalType = Signal<void(Actor, const RotationGesture&)>;
64 public: // Creation & Destruction
66 * @brief Creates an uninitialized RotationGestureDetector; this can be initialized with RotationGestureDetector::New().
69 * Calling member functions with an uninitialized RotationGestureDetector handle is not allowed.
71 RotationGestureDetector();
74 * @brief Creates an initialized RotationGestureDetector.
77 * @return A handle to a newly allocated Dali resource
79 static RotationGestureDetector New();
82 * @brief Downcasts a handle to RotationGestureDetector handle.
85 * If handle points to a RotationGestureDetector object, the
86 * downcast produces valid handle. If not, the returned handle is left uninitialized.
87 * @param[in] handle Handle to an object
88 * @return Handle to a RotationGestureDetector object or an uninitialized handle
90 static RotationGestureDetector DownCast(BaseHandle handle);
96 * This is non-virtual since derived Handle types must not contain data or virtual methods.
98 ~RotationGestureDetector();
101 * @brief This copy constructor is required for (smart) pointer semantics.
104 * @param[in] handle A reference to the copied handle
106 RotationGestureDetector(const RotationGestureDetector& handle);
109 * @brief This assignment operator is required for (smart) pointer semantics.
112 * @param[in] rhs A reference to the copied handle
113 * @return A reference to this
115 RotationGestureDetector& operator=(const RotationGestureDetector& rhs);
118 * @brief This move constructor is required for (smart) pointer semantics.
121 * @param[in] handle A reference to the moved handle
123 RotationGestureDetector(RotationGestureDetector&& handle);
126 * @brief This move assignment operator is required for (smart) pointer semantics.
129 * @param[in] rhs A reference to the moved handle
130 * @return A reference to this
132 RotationGestureDetector& operator=(RotationGestureDetector&& rhs);
136 * @brief This signal is emitted when the rotation gesture is detected on the attached actor.
138 * A callback of the following type may be connected:
140 * void YourCallbackName( Actor actor, const RotationGesture& gesture );
143 * @return The signal to connect to
144 * @pre The gesture detector has been initialized.
146 DetectedSignalType& DetectedSignal();
148 public: // Not intended for Application developers
151 * @brief This constructor is used by RotationGestureDetector::New() methods.
154 * @param[in] internal A pointer to a newly allocated Dali resource
156 explicit DALI_INTERNAL RotationGestureDetector(Internal::RotationGestureDetector* internal);
162 #endif // DALI_ROTATION_GESTURE_DETECTOR_H