1 #ifndef __DALI_INTERNAL_GESTURE_PROCESSOR_H__
2 #define __DALI_INTERNAL_GESTURE_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/internal/event/events/gesture-detector-impl.h>
23 #include <dali/internal/event/events/hit-test-algorithm-impl.h>
24 #include <dali/internal/event/common/proxy-object.h>
35 * Base class for the different Gesture Processors.
37 class GestureProcessor : public ProxyObject::Observer
41 // Construction & Destruction
44 * Protected constructor. Cannot create an instance of GestureProcessor
46 GestureProcessor( Gesture::Type type );
49 * Virtual protected destructor.
51 virtual ~GestureProcessor();
53 // Methods to be used by deriving classes
56 * Given the hit actor, this walks up the actor tree to determine the actor that is connected to one (or several) gesture detectors.
58 * @param[in,out] actor The gestured actor. When this function returns, this is the actor that has been hit by the gesture.
59 * @param[out] gestureDetectors A container containing all the gesture detectors that have the hit actor attached and satisfy the functor parameters.
61 * @note Uses CheckGestureDetector() to check if a the current gesture matches the criteria the gesture detector requires.
62 * @pre gestureDetectors should be empty.
64 void GetGesturedActor( Actor*& actor, GestureDetectorContainer& gestureDetectors );
67 * Calls the emission method in the deriving class for matching gesture-detectors with the hit-actor (or one of its parents).
69 * @param[in] hitTestResults The Hit Test Results.
71 * @note Uses the CheckGestureDetector() to check if the gesture matches the criteria of the given gesture detector
72 * and EmitGestureSignal() to emit the signal.
73 * @pre Hit Testing should already be done.
75 void ProcessAndEmit( HitTestAlgorithm::Results& hitTestResults );
78 * Hit test the screen coordinates, and place the results in hitTestResults.
79 * @param[in] stage Stage.
80 * @param[in] screenCoordinates The screen coordinates to test.
81 * @param[out] hitTestResults Structure to write results into.
82 * @return false if the system overlay was hit or no actor was hit.
84 virtual bool HitTest(Stage& stage, Vector2 screenCoordinates, HitTestAlgorithm::Results& hitTestResults);
87 * Sets the mCurrentGesturedActor and connects to the required signals.
88 * @actor actor The actor so set.
90 void SetActor( Actor* actor );
93 * Resets the set actor and disconnects any connected signals.
98 * Returns the current gestured actor if it is on stage
100 * @return The current gestured actor
102 Actor* GetCurrentGesturedActor();
106 // For derived classes to override
109 * Called when the gestured actor is removed from the stage.
111 virtual void OnGesturedActorStageDisconnection() = 0;
114 * Called by the ProcessAndEmit() & GetGesturedActor() methods to check if the provided
115 * gesture-detector meets the parameters of the current gesture.
117 * @param[in] detector The gesture detector to check.
118 * @param[in] actor The actor that has been gestured.
120 * @return true, if the detector meets the parameters, false otherwise.
122 virtual bool CheckGestureDetector( GestureDetector* detector, Actor* actor ) = 0;
125 * Called by the ProcessAndEmit() method when the gesture meets all applicable criteria and
126 * should be overridden by deriving classes to emit the gesture signal on gesture-detectors
127 * provided for the actor the gesture has occurred on.
129 * @param[in] actor The actor which has been gestured.
130 * @param[in] gestureDetectors The detectors that should emit the signal.
131 * @param[in] actorCoordinates The local actor coordinates where the gesture took place.
133 virtual void EmitGestureSignal( Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates ) = 0;
137 GestureProcessor( const GestureProcessor& );
138 GestureProcessor& operator=( const GestureProcessor& );
140 // SceneObject overrides
143 * This will never get called as we do not observe objects that have not been added to the scene.
144 * @param[in] proxy The proxy object.
145 * @see ProxyObject::Observer::SceneObjectAdded()
147 virtual void SceneObjectAdded(ProxyObject& proxy) { }
150 * This will be called when the actor is removed from the stage, we should clear and stop
152 * @param[in] proxy The proxy object.
153 * @see ProxyObject::Observer::SceneObjectRemoved()
155 virtual void SceneObjectRemoved(ProxyObject& proxy);
158 * This will be called when the actor is destroyed. We should clear the actor.
159 * No need to stop observing as the object is being destroyed anyway.
160 * @see ProxyObject::Observer::ProxyDestroyed()
162 virtual void ProxyDestroyed(ProxyObject& proxy);
166 Gesture::Type mType; ///< Type of GestureProcessor
167 Actor* mCurrentGesturedActor; ///< The current actor that has been gestured.
168 bool mGesturedActorDisconnected:1; ///< Indicates whether the gestured actor has been disconnected from the scene
171 } // namespace Internal
175 #endif // __DALI_INTERNAL_GESTURE_PROCESSOR_H__