1 #ifndef __DALI_INTERNAL_PAN_GESTURE_EVENT_PROCESSOR_H__
2 #define __DALI_INTERNAL_PAN_GESTURE_EVENT_PROCESSOR_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/render-tasks/render-task.h>
23 #include <dali/internal/event/events/pan-gesture-detector-impl.h>
24 #include <dali/internal/event/events/gesture-processor.h>
33 struct PanGestureEvent;
47 * Pan Gesture Event Processing:
49 * When we receive a pinch gesture event, we do the following:
50 * - Determine the hot actor underneath the current position of the pan gesture event.
51 * - Determine whether this actor is, or is a child of, the actor(s) attached to any of the
53 * - Emit the gesture when all the above conditions are met.
55 * The above is only checked when our gesture starts. We continue sending the pan gesture to the
56 * same actor and detector until the pan ends or is cancelled.
58 class PanGestureProcessor : public GestureProcessor
63 * Create a pan gesture processor.
64 * @param[in] stage The stage.
65 * @param[in] gestureManager The gesture manager
67 PanGestureProcessor( Stage& stage, Integration::GestureManager& gestureManager );
70 * Non-virtual destructor; PanGestureProcessor is not a base class
72 ~PanGestureProcessor();
74 public: // To be called by GestureEventProcessor
77 * This method is called whenever a pinch gesture event occurs.
78 * @param[in] panEvent The event that has occurred.
80 void Process( const Integration::PanGestureEvent& panEvent );
83 * Adds a gesture detector to this gesture processor.
84 * If this is the first gesture detector being added, then this method registers the required
85 * gesture with the adaptor.
86 * @param[in] gestureDetector The gesture detector being added.
88 void AddGestureDetector( PanGestureDetector* gestureDetector );
91 * Removes the specified gesture detector from this gesture processor. If, after removing this
92 * gesture detector, there are no more gesture detectors registered, then this method unregisters
93 * the gesture from the adaptor.
94 * @param[in] gestureDetector The gesture detector being removed.
96 void RemoveGestureDetector( PanGestureDetector* gestureDetector );
99 * This method updates the gesture detection parameters.
100 * @param[in] gestureDetector The gesture detector that has been updated.
102 void GestureDetectorUpdated( PanGestureDetector* gestureDetector );
105 * Sets the pan gesture properties stored in the scene object directly,
106 * @param[in] pan The pan gesture to override the properties with.
107 * @note If we are already processing a normal pan, then this call is ignored.
109 void SetPanGestureProperties( const PanGesture& pan );
112 * Called to provide pan-gesture profiling information.
114 void EnableProfiling();
117 * Called to set the prediction mode for pan gestures
119 * @param[in] mode The prediction mode
123 * 1 - Prediction using average acceleration
125 void SetPredictionMode(int mode);
128 * @brief Sets the prediction amount of the pan gesture
130 * @param[in] amount The prediction amount in milliseconds
132 void SetPredictionAmount(unsigned int amount);
135 * Called to set the prediction mode for pan gestures
137 * @param[in] mode The prediction mode
141 * 1 - average between last 2 values
143 void SetSmoothingMode(int mode);
146 * @brief Sets the smoothing amount of the pan gesture
148 * @param[in] amount The smotthing amount from 0.0f (none) to 1.0f (full)
150 void SetSmoothingAmount(float amount);
155 PanGestureProcessor( const PanGestureProcessor& );
156 PanGestureProcessor& operator=( const PanGestureProcessor& rhs );
159 * Iterates through our GestureDetectors and determines if we need to ask the adaptor to update
160 * its detection policy. If it does, it sends the appropriate gesture update request to adaptor.
162 void UpdateDetection();
165 * Creates a PanGesture and asks the specified detector to emit its detected signal.
166 * @param[in] actor The actor that has been panned.
167 * @param[in] gestureDetectors The gesture detector container that should emit the signal.
168 * @param[in] panEvent The panEvent received from the adaptor.
169 * @param[in] localCurrent Current position relative to the actor attached to the detector.
170 * @param[in] state The state of the gesture.
171 * @param[in] renderTask The renderTask to use.
173 void EmitPanSignal( Actor* actor,
174 const GestureDetectorContainer& gestureDetectors,
175 const Integration::PanGestureEvent& panEvent,
176 Vector2 localCurrent,
177 Gesture::State state,
178 Dali::RenderTask renderTask );
180 // GestureProcessor overrides
183 * @copydoc GestureProcessor::OnGesturedActorStageDisconnection()
185 void OnGesturedActorStageDisconnection();
188 * @copydoc GestureProcessor::CheckGestureDetector()
190 bool CheckGestureDetector( GestureDetector* detector, Actor* actor );
193 * @copydoc GestureProcessor::EmitGestureSignal()
195 void EmitGestureSignal( Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates );
200 Integration::GestureManager& mGestureManager;
201 PanGestureDetectorContainer mGestureDetectors;
202 GestureDetectorContainer mCurrentPanEmitters;
203 Dali::RenderTask mCurrentRenderTask;
204 Vector2 mPossiblePanPosition;
206 unsigned int mMinTouchesRequired;
207 unsigned int mMaxTouchesRequired;
209 Vector2 mLastVelocity; ///< The last recorded velocity in local actor coordinates.
210 Vector2 mLastScreenVelocity; ///< The last recorded velocity in screen coordinates.
212 const Integration::PanGestureEvent* mCurrentPanEvent; ///< Pointer to current PanEvent, used when calling ProcessAndEmit()
213 SceneGraph::PanGesture* mSceneObject; ///< Not owned, but we write to it directly
216 } // namespace Internal
220 #endif // __DALI_INTERNAL_PAN_GESTURE_EVENT_PROCESSOR_H__