1 #ifndef __DALI_TAP_GESTURE_DETECTOR_H__
2 #define __DALI_TAP_GESTURE_DETECTOR_H__
5 * Copyright (c) 2014 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 and TapGestureDetector::SetTouchesRequired.
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);
54 * | %Signal Name | Method |
55 * |--------------|-----------------------|
56 * | tap-detected | @ref DetectedSignal() |
58 class DALI_IMPORT_API TapGestureDetector : public GestureDetector
63 * @brief Signal type for detected signal.
65 typedef Signal< void ( Actor, const TapGesture& ) > DetectedSignalType;
67 public: // Creation & Destruction
70 * @brief Create an uninitialized TapGestureDetector; this can be initialized with TapGestureDetector::New().
72 * Calling member functions with an uninitialized Dali::Object is not allowed.
77 * @brief Create an initialized TapGestureDetector.
79 * By default, this would create a gesture detector which requires one tap with one touch.
80 * @return A handle to a newly allocated Dali resource.
82 static TapGestureDetector New();
85 * @brief Create an initialized TapGestureDetector with the specified parameters.
87 * @param[in] tapsRequired The number of taps required.
88 * @param[in] touchesRequired The number of touches required.
89 * @return A handle to a newly allocated Dali resource.
91 static TapGestureDetector New(unsigned int tapsRequired, unsigned int touchesRequired);
94 * @brief Downcast an Object handle to TapGestureDetector handle.
96 * If handle points to a TapGestureDetector object the
97 * downcast produces valid handle. If not the returned handle is left uninitialized.
98 * @param[in] handle to An object
99 * @return handle to a TapGestureDetector object or an uninitialized handle
101 static TapGestureDetector DownCast( BaseHandle handle );
106 * This is non-virtual since derived Handle types must not contain data or virtual methods.
108 ~TapGestureDetector();
111 * @brief This copy constructor is required for (smart) pointer semantics.
113 * @param [in] handle A reference to the copied handle
115 TapGestureDetector(const TapGestureDetector& handle);
118 * @brief This assignment operator is required for (smart) pointer semantics.
120 * @param [in] rhs A reference to the copied handle
121 * @return A reference to this
123 TapGestureDetector& operator=(const TapGestureDetector& rhs);
128 * @brief Set the number of taps required.
130 * The tap count is the number of times a user should "tap" the screen.
131 * @param[in] taps Taps required.
132 * @pre The gesture detector has been initialized.
133 * @note The default is '1'.
135 void SetTapsRequired(unsigned int taps);
138 * @brief Set the number of touches required.
140 * The number of touches corresponds to the number of fingers a user has on the screen.
141 * @param[in] touches Touches required.
142 * @pre The gesture detector has been initialized.
143 * @note The default is '1'.
145 void SetTouchesRequired(unsigned int touches);
150 * @brief Retrieves the number of taps required.
152 * @return The taps required.
153 * @pre The gesture detector has been initialized.
155 unsigned int GetTapsRequired() const;
158 * @brief Retrieves the number of touches required.
160 * @return The number of touches required.
161 * @pre The gesture detector has been initialized.
163 unsigned int GetTouchesRequired() const;
168 * @brief This signal is emitted when the specified tap is detected on the attached actor.
170 * A callback of the following type may be connected:
172 * void YourCallbackName( Actor actor, const TapGesture& gesture );
174 * @pre The gesture detector has been initialized.
175 * @return The signal to connect to.
177 DetectedSignalType& DetectedSignal();
179 public: // Not intended for Application developers
182 * @brief This constructor is used by Dali New() methods.
184 * @param [in] internal A pointer to a newly allocated Dali resource.
186 explicit DALI_INTERNAL TapGestureDetector(Internal::TapGestureDetector* internal);
191 #endif // __DALI_TAP_GESTURE_DETECTOR_H__