1 #ifndef DALI_INTERNAL_GESTURE_PROCESSOR_H
2 #define DALI_INTERNAL_GESTURE_PROCESSOR_H
5 * Copyright (c) 2021 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/internal/event/common/object-impl.h>
23 #include <dali/internal/event/events/gesture-detector-impl.h>
24 #include <dali/internal/event/events/gesture-recognizer.h>
25 #include <dali/internal/event/events/hit-test-algorithm-impl.h>
34 * Base class for the different Gesture Processors.
36 class GestureProcessor : public Object::Observer
40 * Process the touch event in the attached recognizer
41 * @param[in] scene Scene.
42 * @param[in] event Touch event to process
44 void ProcessTouch(Scene& scene, const Integration::TouchEvent& event);
47 * Returns whether any GestureDetector requires a Core::Update
48 * @return true if update required
50 inline bool NeedsUpdate()
52 bool updateRequired = mNeedsUpdate;
54 return updateRequired;
58 // Construction & Destruction
61 * Protected constructor. Cannot create an instance of GestureProcessor
63 GestureProcessor(GestureType::Value type);
66 * Virtual protected destructor.
68 ~GestureProcessor() override;
70 // Methods to be used by deriving classes
73 * Given the hit actor, this walks up the actor tree to determine the actor that is connected to one (or several) gesture detectors.
75 * @param[in,out] actor The gestured actor. When this function returns, this is the actor that has been hit by the gesture.
76 * @param[out] gestureDetectors A container containing all the gesture detectors that have the hit actor attached and satisfy the functor parameters.
78 * @note Uses CheckGestureDetector() to check if a the current gesture matches the criteria the gesture detector requires.
79 * @pre gestureDetectors should be empty.
81 void GetGesturedActor(Actor*& actor, GestureDetectorContainer& gestureDetectors);
84 * Calls the emission method in the deriving class for matching gesture-detectors with the hit-actor (or one of its parents).
86 * @param[in] hitTestResults The Hit Test Results.
88 * @note Uses the CheckGestureDetector() to check if the gesture matches the criteria of the given gesture detector
89 * and EmitGestureSignal() to emit the signal.
90 * @pre Hit Testing should already be done.
92 void ProcessAndEmit(HitTestAlgorithm::Results& hitTestResults);
95 * Hit test the screen coordinates, and place the results in hitTestResults.
96 * @param[in] scene Scene.
97 * @param[in] screenCoordinates The screen coordinates to test.
98 * @param[out] hitTestResults Structure to write results into.
99 * @return false if the system overlay was hit or no actor was hit.
101 virtual bool HitTest(Scene& scene, Vector2 screenCoordinates, HitTestAlgorithm::Results& hitTestResults);
104 * Sets the mCurrentGesturedActor and connects to the required signals.
105 * @actor actor The actor so set.
107 void SetActor(Actor* actor);
110 * Resets the set actor and disconnects any connected signals.
115 * Returns the current gestured actor if it is on stage
117 * @return The current gestured actor
119 Actor* GetCurrentGesturedActor();
122 // For derived classes to override
125 * Called when the gestured actor is removed from the stage.
127 virtual void OnGesturedActorStageDisconnection() = 0;
130 * Called by the ProcessAndEmit() & GetGesturedActor() methods to check if the provided
131 * gesture-detector meets the parameters of the current gesture.
133 * @param[in] detector The gesture detector to check.
134 * @param[in] actor The actor that has been gestured.
136 * @return true, if the detector meets the parameters, false otherwise.
138 virtual bool CheckGestureDetector(GestureDetector* detector, Actor* actor) = 0;
141 * Called by the ProcessAndEmit() method when the gesture meets all applicable criteria and
142 * should be overridden by deriving classes to emit the gesture signal on gesture-detectors
143 * provided for the actor the gesture has occurred on.
145 * @param[in] actor The actor which has been gestured.
146 * @param[in] gestureDetectors The detectors that should emit the signal.
147 * @param[in] actorCoordinates The local actor coordinates where the gesture took place.
149 virtual void EmitGestureSignal(Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates) = 0;
153 GestureProcessor(const GestureProcessor&);
154 GestureProcessor& operator=(const GestureProcessor&);
156 // SceneObject overrides
159 * This will never get called as we do not observe objects that have not been added to the scene.
160 * @param[in] object The object object.
161 * @see Object::Observer::SceneObjectAdded()
163 void SceneObjectAdded(Object& object) override
168 * This will be called when the actor is removed from the stage, we should clear and stop
170 * @param[in] object The object object.
171 * @see Object::Observer::SceneObjectRemoved()
173 void SceneObjectRemoved(Object& object) override;
176 * This will be called when the actor is destroyed. We should clear the actor.
177 * No need to stop observing as the object is being destroyed anyway.
178 * @see Object::Observer::ObjectDestroyed()
180 void ObjectDestroyed(Object& object) override;
183 GestureRecognizerPtr mGestureRecognizer; ///< The gesture recognizer
184 bool mNeedsUpdate; ///< Indicates if any GestureDetector requires a Core::Update
187 GestureType::Value mType; ///< Type of GestureProcessor
188 Actor* mCurrentGesturedActor; ///< The current actor that has been gestured.
189 bool mGesturedActorDisconnected : 1; ///< Indicates whether the gestured actor has been disconnected from the scene
192 } // namespace Internal
196 #endif // DALI_INTERNAL_GESTURE_PROCESSOR_H