1 #ifndef __DALI_PINCH_GESTURE_DETECTOR_H__
2 #define __DALI_PINCH_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 PinchGestureDetector;
36 * @brief This class looks for pinching gestures involving two touches.
38 * It tries to detect when the user moves two touch points towards or
39 * away from each other. Please see PinchGesture for more
42 * The application programmer can use this gesture detector as follows:
44 * PinchGestureDetector detector = PinchGestureDetector::New();
45 * detector.Attach(myActor);
46 * detector.DetectedSignal().Connect(this, &MyApplication::OnPinch);
52 * | %Signal Name | Method |
53 * |----------------|-----------------------|
54 * | pinch-detected | @ref DetectedSignal() |
56 class DALI_IMPORT_API PinchGestureDetector : public GestureDetector
63 typedef Signal< void ( Actor, const PinchGesture& ) > DetectedSignalType;
65 public: // Creation & Destruction
68 * @brief Create an uninitialized PinchGestureDetector; this can be initialized with PinchGestureDetector::New().
70 * Calling member functions with an uninitialized Dali::Object is not allowed.
72 PinchGestureDetector();
75 * @brief Create an initialized PinchGestureDetector.
77 * @return A handle to a newly allocated Dali resource.
79 static PinchGestureDetector New();
82 * @brief Downcast an Object handle to PinchGestureDetector handle.
84 * If handle points to a PinchGestureDetector object the
85 * downcast produces valid handle. If not the returned handle is left uninitialized.
86 * @param[in] handle to An object
87 * @return handle to a PinchGestureDetector object or an uninitialized handle
89 static PinchGestureDetector DownCast( BaseHandle handle );
94 * This is non-virtual since derived Handle types must not contain data or virtual methods.
96 ~PinchGestureDetector();
99 * @brief This copy constructor is required for (smart) pointer semantics.
101 * @param [in] handle A reference to the copied handle
103 PinchGestureDetector(const PinchGestureDetector& handle);
106 * @brief This assignment operator is required for (smart) pointer semantics.
108 * @param [in] rhs A reference to the copied handle
109 * @return A reference to this
111 PinchGestureDetector& operator=(const PinchGestureDetector& rhs);
116 * @brief This signal is emitted when the pinch gesture is detected on the attached actor.
118 * A callback of the following type may be connected:
120 * void YourCallbackName( Actor actor, const PinchGesture& gesture );
122 * @pre The gesture detector has been initialized.
123 * @return The signal to connect to.
125 DetectedSignalType& DetectedSignal();
127 public: // Not intended for Application developers
130 * @brief This constructor is used by Dali New() methods.
132 * @param [in] internal A pointer to a newly allocated Dali resource.
134 explicit DALI_INTERNAL PinchGestureDetector(Internal::PinchGestureDetector* internal);
140 #endif // __DALI_PINCH_GESTURE_DETECTOR_H__