[Tizen] Revert "Use touch consumed return to set whether we process a gesture or...
[platform/core/uifw/dali-core.git] / dali / internal / event / events / touch-event-processor.h
1 #ifndef DALI_INTERNAL_TOUCH_EVENT_PROCESSOR_H
2 #define DALI_INTERNAL_TOUCH_EVENT_PROCESSOR_H
3
4 /*
5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
6  *
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
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
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.
18  *
19  */
20
21 // INTERNAL INCLUDES
22 #include <dali/internal/event/events/actor-observer.h>
23 #include <dali/internal/event/render-tasks/render-task-impl.h>
24
25 namespace Dali
26 {
27
28 class Actor;
29 struct Vector2;
30 struct Vector4;
31
32 namespace Integration
33 {
34 struct TouchEvent;
35 }
36
37 namespace Internal
38 {
39
40 class Actor;
41 class Scene;
42 struct ActorObserver;
43
44 /**
45  * <h3>Multi-Touch Event Processing:</h3>
46  *
47  * The TouchEventProcessor processes touch events and emits the Touched signal on the hit actor (and
48  * its parents).
49  *
50  * - Hit Testing & Touch Event Delivery are described in Dali::Actor.
51  */
52 class TouchEventProcessor
53 {
54 public:
55
56   /**
57    * Create an event processor.
58    * @param[in] scene The scene the event processor belongs to.
59    */
60   TouchEventProcessor( Scene& scene );
61
62   /**
63    * Non-virtual destructor; TouchEventProcessor is not a base class
64    */
65   ~TouchEventProcessor();
66
67   /**
68    * This function is called by the event processor whenever a touch event occurs.
69    * @param[in] event The touch event that has occurred.
70    */
71   void ProcessTouchEvent( const Integration::TouchEvent& event );
72
73 private:
74
75   // Undefined
76   TouchEventProcessor(const TouchEventProcessor&);
77
78   // Undefined
79   TouchEventProcessor& operator=(const TouchEventProcessor& rhs);
80
81 private:
82
83   Scene& mScene; ///< Used to deliver touch events
84
85   /**
86    * Called by some actor-observers when the observed actor is disconnected.
87    *
88    * @param[in]  actor  The actor that has been disconnected.
89    */
90   void OnObservedActorDisconnected( Actor* actor );
91
92   ActorObserver mLastPrimaryHitActor; ///< Stores the last primary point hit actor
93   ActorObserver mLastConsumedActor; ///< Stores the last consumed actor
94   ActorObserver mCapturingTouchActor; ///< Stored the actor that captures touch
95   ActorObserver mTouchDownConsumedActor; ///< Stores the touch-down consumed actor
96   RenderTaskPtr mLastRenderTask; ///< The RenderTask used for the last hit actor
97 };
98
99 } // namespace Internal
100
101 } // namespace Dali
102
103 #endif // DALI_INTERNAL_TOUCH_EVENT_PROCESSOR_H