1 #ifndef __DALI_TAP_GESTURE_DETECTOR_H__
2 #define __DALI_TAP_GESTURE_DETECTOR_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/events/gesture-detector.h>
23 #include <dali/public-api/signals/dali-signal.h>
28 namespace Internal DALI_INTERNAL
30 class TapGestureDetector;
36 * @brief This class emits a signal when a tap gesture occurs that meets the requirements set by the
39 * See TapGestureDetector::SetTapsRequired
41 * A Tap Gesture is a discrete gesture, which means it does not have any state information attached
42 * to it. Please see TapGesture for more information.
44 * The application programmer can use this gesture detector as follows:
46 * TapGestureDetector detector = TapGestureDetector::New();
47 * detector.Attach(myActor);
48 * detector.DetectedSignal().Connect(this, &MyApplication::OnTap);
53 * @note Multi-touch taps are not currently supported. However, multiple taps (double & triple tap etc.) ARE supported.
56 * | %Signal Name | Method |
57 * |--------------|-----------------------|
58 * | tap-detected | @ref DetectedSignal() |
60 class DALI_IMPORT_API TapGestureDetector : public GestureDetector
65 * @brief Signal type for detected signal.
67 typedef Signal< void ( Actor, const TapGesture& ) > DetectedSignalType;
69 public: // Creation & Destruction
72 * @brief Create an uninitialized TapGestureDetector; this can be initialized with TapGestureDetector::New().
74 * Calling member functions with an uninitialized Dali::Object is not allowed.
79 * @brief Create an initialized TapGestureDetector.
81 * By default, this would create a gesture detector which requires one tap with one touch.
82 * @return A handle to a newly allocated Dali resource.
84 static TapGestureDetector New();
87 * @brief Create an initialized TapGestureDetector with the specified parameters.
89 * @param[in] tapsRequired The minimum & maximum number of taps required.
90 * @return A handle to a newly allocated Dali resource.
92 static TapGestureDetector New( unsigned int tapsRequired );
95 * @brief Downcast an Object handle to TapGestureDetector handle.
97 * If handle points to a TapGestureDetector object the
98 * downcast produces valid handle. If not the returned handle is left uninitialized.
99 * @param[in] handle to An object
100 * @return handle to a TapGestureDetector object or an uninitialized handle
102 static TapGestureDetector DownCast( BaseHandle handle );
107 * This is non-virtual since derived Handle types must not contain data or virtual methods.
109 ~TapGestureDetector();
112 * @brief This copy constructor is required for (smart) pointer semantics.
114 * @param [in] handle A reference to the copied handle
116 TapGestureDetector(const TapGestureDetector& handle);
119 * @brief This assignment operator is required for (smart) pointer semantics.
121 * @param [in] rhs A reference to the copied handle
122 * @return A reference to this
124 TapGestureDetector& operator=(const TapGestureDetector& rhs);
129 * @brief Set the minimum number of taps required.
131 * The tap count is the number of times a user should "tap" the screen.
132 * @param[in] minimumTaps The minimum taps required.
133 * @pre The gesture detector has been initialized.
134 * @note The default is '1'.
136 void SetMinimumTapsRequired( unsigned int minimumTaps );
139 * @brief Set the maximum number of taps required.
141 * The tap count is the number of times a user should "tap" the screen.
142 * @param[in] maximumTaps The maximum taps required.
143 * @pre The gesture detector has been initialized.
144 * @note The default is '1'.
146 void SetMaximumTapsRequired( unsigned int maximumTaps );
151 * @brief Retrieves the minimum number of taps required.
153 * @return The minimum taps required.
154 * @pre The gesture detector has been initialized.
156 unsigned int GetMinimumTapsRequired() const;
159 * @brief Retrieves the maximum number of taps required.
161 * @return The maximum taps required.
162 * @pre The gesture detector has been initialized.
164 unsigned int GetMaximumTapsRequired() const;
169 * @brief This signal is emitted when the specified tap is detected on the attached actor.
171 * A callback of the following type may be connected:
173 * void YourCallbackName( Actor actor, const TapGesture& gesture );
175 * @pre The gesture detector has been initialized.
176 * @return The signal to connect to.
178 DetectedSignalType& DetectedSignal();
180 public: // Not intended for Application developers
183 * @brief This constructor is used by Dali New() methods.
185 * @param [in] internal A pointer to a newly allocated Dali resource.
187 explicit DALI_INTERNAL TapGestureDetector(Internal::TapGestureDetector* internal);
192 #endif // __DALI_TAP_GESTURE_DETECTOR_H__