Add TOUCH_FOCUSABLE property
[platform/core/uifw/dali-core.git] / dali / internal / event / events / hit-test-algorithm-impl.cpp
1 /*
2  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17
18 // CLASS HEADER
19 #include <dali/internal/event/events/hit-test-algorithm-impl.h>
20
21 // INTERNAL INCLUDES
22 #include <dali/integration-api/debug.h>
23 #include <dali/internal/event/actors/actor-impl.h>
24 #include <dali/internal/event/actors/camera-actor-impl.h>
25 #include <dali/internal/event/actors/layer-impl.h>
26 #include <dali/internal/event/actors/layer-list.h>
27 #include <dali/internal/event/common/projection.h>
28 #include <dali/internal/event/events/ray-test.h>
29 #include <dali/internal/event/render-tasks/render-task-impl.h>
30 #include <dali/internal/event/render-tasks/render-task-list-impl.h>
31 #include <dali/internal/event/rendering/renderer-impl.h>
32 #include <dali/public-api/actors/layer.h>
33 #include <dali/public-api/math/vector2.h>
34 #include <dali/public-api/math/vector4.h>
35
36 namespace Dali
37 {
38 namespace Internal
39 {
40 namespace HitTestAlgorithm
41 {
42 namespace
43 {
44 struct HitActor
45 {
46   HitActor()
47   : actor(nullptr),
48     distance(std::numeric_limits<float>::max()),
49     depth(std::numeric_limits<int>::min())
50   {
51   }
52
53   Actor*  actor;       ///< The actor hit (if actor is hit, then this is initialised).
54   Vector2 hitPosition; ///< Position of hit (only valid if actor valid).
55   float   distance;    ///< Distance from ray origin to hit actor.
56   int32_t depth;       ///< Depth index of this actor.
57 };
58
59 /**
60  * Creates an Actor handle so that a HitTestFunction provided via the public API can be called.
61  */
62 struct HitTestFunctionWrapper : public HitTestInterface
63 {
64   /**
65    * Constructor
66    *
67    * @param[in] func HitTestFunction to call with an Actor handle.
68    */
69   HitTestFunctionWrapper(Dali::HitTestAlgorithm::HitTestFunction func)
70   : mFunc(func)
71   {
72   }
73
74   bool IsActorHittable(Actor* actor) override
75   {
76     return mFunc(Dali::Actor(actor), Dali::HitTestAlgorithm::CHECK_ACTOR);
77   }
78
79   bool DescendActorHierarchy(Actor* actor) override
80   {
81     return mFunc(Dali::Actor(actor), Dali::HitTestAlgorithm::DESCEND_ACTOR_TREE);
82   }
83
84   bool DoesLayerConsumeHit(Layer* layer) override
85   {
86     // Layer::IsTouchConsumed() focuses on touch only. Here we are a wrapper for the public-api
87     // where the caller may want to check for something completely different.
88     // TODO: Should provide a means to let caller decide. For now do not allow layers to consume
89     return false;
90   }
91
92   Dali::HitTestAlgorithm::HitTestFunction mFunc;
93 };
94
95 /**
96  * Used in the hit-test algorithm to check whether the actor is touchable.
97  * It is used by the touch event processor.
98  */
99 struct ActorTouchableCheck : public HitTestInterface
100 {
101   bool IsActorHittable(Actor* actor) override
102   {
103     return (actor->GetTouchRequired() || actor->IsTouchFocusable()) && // Does the Application or derived actor type require a touch event? or focusable by touch?
104            actor->IsHittable();                                        // Is actor sensitive, visible and on the scene?
105   }
106
107   bool DescendActorHierarchy(Actor* actor) override
108   {
109     return actor->IsVisible() && // Actor is visible, if not visible then none of its children are visible.
110            actor->IsSensitive(); // Actor is sensitive, if insensitive none of its children should be hittable either.
111   }
112
113   bool DoesLayerConsumeHit(Layer* layer) override
114   {
115     return layer->IsTouchConsumed();
116   }
117 };
118
119 /**
120  * Check to see if the actor we're about to hit test is exclusively owned by another rendertask?
121  */
122 bool IsActorExclusiveToAnotherRenderTask(const Actor&                               actor,
123                                          const RenderTask&                          renderTask,
124                                          const RenderTaskList::ExclusivesContainer& exclusives)
125
126 {
127   if(exclusives.size())
128   {
129     for(const auto& exclusive : exclusives)
130     {
131       if((exclusive.renderTaskPtr != &renderTask) && (exclusive.actor.GetActor() == &actor))
132       {
133         return true;
134       }
135     }
136   }
137   return false;
138 }
139
140 /**
141  * Recursively hit test all the actors, without crossing into other layers.
142  * This algorithm performs a Depth-First-Search (DFS) on all Actors within Layer.
143  * Hit-Testing each Actor, noting the distance from the Ray-Origin (3D origin
144  * of touch vector). The closest Hit-Tested Actor is that which is returned.
145  * Exceptions to this rule are:
146  * - When comparing against renderable parents, if Actor is the same distance
147  * or closer than it's renderable parent, then it takes priority.
148  */
149 HitActor HitTestWithinLayer(Actor&                                     actor,
150                             const RenderTask&                          renderTask,
151                             const RenderTaskList::ExclusivesContainer& exclusives,
152                             const Vector4&                             rayOrigin,
153                             const Vector4&                             rayDir,
154                             float&                                     nearClippingPlane,
155                             float&                                     farClippingPlane,
156                             HitTestInterface&                          hitCheck,
157                             bool&                                      overlayHit,
158                             bool                                       layerIs3d,
159                             uint32_t                                   clippingDepth,
160                             uint32_t                                   clippingBitPlaneMask,
161                             const RayTest&                             rayTest)
162 {
163   HitActor hit;
164
165   if(IsActorExclusiveToAnotherRenderTask(actor, renderTask, exclusives))
166   {
167     return hit;
168   }
169
170   // For clipping, regardless of whether we have hit this actor or not,
171   // we increase the clipping depth if we have hit a clipping actor.
172   // This is used later to ensure all nested clipped children have hit
173   // all clipping actors also for them to be counted as hit.
174   uint32_t newClippingDepth = clippingDepth;
175   bool     clippingActor    = actor.GetClippingMode() != ClippingMode::DISABLED;
176   if(clippingActor)
177   {
178     ++newClippingDepth;
179   }
180
181   // If we are a clipping actor or hittable...
182   if(clippingActor || hitCheck.IsActorHittable(&actor))
183   {
184     Vector3 size(actor.GetCurrentSize());
185
186     // Ensure the actor has a valid size.
187     // If so, perform a quick ray sphere test to see if our ray is close to the actor.
188     if(size.x > 0.0f && size.y > 0.0f && rayTest.SphereTest(actor, rayOrigin, rayDir))
189     {
190       Vector2 hitPointLocal;
191       float   distance;
192
193       // Finally, perform a more accurate ray test to see if our ray actually hits the actor.
194       if(rayTest.ActorTest(actor, rayOrigin, rayDir, hitPointLocal, distance))
195       {
196         if(distance >= nearClippingPlane && distance <= farClippingPlane)
197         {
198           // If the hit has happened on a clipping actor, then add this clipping depth to the mask of hit clipping depths.
199           // This mask shows all the actors that have been hit at different clipping depths.
200           if(clippingActor)
201           {
202             clippingBitPlaneMask |= 1u << clippingDepth;
203           }
204
205           if(overlayHit && !actor.IsOverlay())
206           {
207             // If we have already hit an overlay and current actor is not an overlay ignore current actor.
208           }
209           else
210           {
211             if(actor.IsOverlay())
212             {
213               overlayHit = true;
214             }
215
216             // At this point we have hit an actor.
217             // Now perform checks for clipping.
218             // Assume we have hit the actor first as if it is not clipped this would be the case.
219             bool haveHitActor = true;
220
221             // Check if we are performing clipping. IE. if any actors so far have clipping enabled - not necessarily this one.
222             // We can do this by checking the clipping depth has a value 1 or above.
223             if(newClippingDepth >= 1u)
224             {
225               // Now for us to count this actor as hit, we must have also hit
226               // all CLIPPING actors up to this point in the hierarchy as well.
227               // This information is stored in the clippingBitPlaneMask we updated above.
228               // Here we calculate a comparison mask by setting all the bits up to the current depth value.
229               // EG. a depth of 4 (10000 binary) = a mask of 1111 binary.
230               // This allows us a fast way of comparing all bits are set up to this depth.
231               // Note: If the current Actor has clipping, that is included in the depth mask too.
232               uint32_t clippingDepthMask = (1u << newClippingDepth) - 1u;
233
234               // The two masks must be equal to be a hit, as we are already assuming a hit
235               // (for non-clipping mode) then they must be not-equal to disqualify the hit.
236               if(clippingBitPlaneMask != clippingDepthMask)
237               {
238                 haveHitActor = false;
239               }
240             }
241
242             if(haveHitActor)
243             {
244               hit.actor       = &actor;
245               hit.hitPosition = hitPointLocal;
246               hit.distance    = distance;
247               hit.depth       = actor.GetSortingDepth();
248
249               if(actor.GetRendererCount() > 0)
250               {
251                 //Get renderer with maximum depth
252                 int rendererMaxDepth(actor.GetRendererAt(0).Get()->GetDepthIndex());
253                 for(uint32_t i(1); i < actor.GetRendererCount(); ++i)
254                 {
255                   int depth = actor.GetRendererAt(i).Get()->GetDepthIndex();
256                   if(depth > rendererMaxDepth)
257                   {
258                     rendererMaxDepth = depth;
259                   }
260                 }
261                 hit.depth += rendererMaxDepth;
262               }
263             }
264           }
265         }
266       }
267     }
268   }
269
270   // Find a child hit, until we run out of actors in the current layer.
271   HitActor childHit;
272   if(actor.GetChildCount() > 0)
273   {
274     childHit.distance        = std::numeric_limits<float>::max();
275     childHit.depth           = std::numeric_limits<int32_t>::min();
276     ActorContainer& children = actor.GetChildrenInternal();
277
278     // Hit test ALL children and calculate their distance.
279     bool parentIsRenderable = actor.IsRenderable();
280
281     for(ActorIter iter = children.begin(), endIter = children.end(); iter != endIter; ++iter)
282     {
283       // Descend tree only if...
284       if(!(*iter)->IsLayer() &&                           // Child is NOT a layer, hit testing current layer only
285          (hitCheck.DescendActorHierarchy((*iter).Get()))) // We can descend into child hierarchy
286       {
287         HitActor currentHit(HitTestWithinLayer((*iter->Get()),
288                                                renderTask,
289                                                exclusives,
290                                                rayOrigin,
291                                                rayDir,
292                                                nearClippingPlane,
293                                                farClippingPlane,
294                                                hitCheck,
295                                                overlayHit,
296                                                layerIs3d,
297                                                newClippingDepth,
298                                                clippingBitPlaneMask,
299                                                rayTest));
300
301         // Make sure the set hit actor is actually hittable. This is usually required when we have some
302         // clipping as we need to hit-test all actors as we descend the tree regardless of whether they
303         // are hittable or not.
304         if(currentHit.actor && !hitCheck.IsActorHittable(currentHit.actor))
305         {
306           continue;
307         }
308
309         bool updateChildHit = false;
310         if(currentHit.distance >= 0.0f)
311         {
312           if(layerIs3d)
313           {
314             updateChildHit = ((currentHit.depth > childHit.depth) ||
315                               ((currentHit.depth == childHit.depth) && (currentHit.distance < childHit.distance)));
316           }
317           else
318           {
319             updateChildHit = currentHit.depth >= childHit.depth;
320           }
321         }
322
323         if(updateChildHit)
324         {
325           if(!parentIsRenderable || currentHit.depth > hit.depth ||
326              (layerIs3d && (currentHit.depth == hit.depth && currentHit.distance < hit.distance)))
327           {
328             childHit = currentHit;
329           }
330         }
331       }
332     }
333   }
334
335   return (childHit.actor) ? childHit : hit;
336 }
337
338 /**
339  * Return true if actor is sourceActor or a descendent of sourceActor
340  */
341 bool IsWithinSourceActors(const Actor& sourceActor, const Actor& actor)
342 {
343   if(&sourceActor == &actor)
344   {
345     return true;
346   }
347
348   Actor* parent = actor.GetParent();
349   if(parent)
350   {
351     return IsWithinSourceActors(sourceActor, *parent);
352   }
353
354   // Not within source actors
355   return false;
356 }
357
358 /**
359  * Returns true if the layer and all of the layer's parents are visible and sensitive.
360  */
361 inline bool IsActuallyHittable(Layer& layer, const Vector2& screenCoordinates, const Vector2& stageSize, HitTestInterface& hitCheck)
362 {
363   bool hittable(true);
364
365   if(layer.IsClipping())
366   {
367     ClippingBox box = layer.GetClippingBox();
368
369     if(screenCoordinates.x < static_cast<float>(box.x) ||
370        screenCoordinates.x > static_cast<float>(box.x + box.width) ||
371        screenCoordinates.y < stageSize.y - static_cast<float>(box.y + box.height) ||
372        screenCoordinates.y > stageSize.y - static_cast<float>(box.y))
373     {
374       // Not touchable if clipping is enabled in the layer and the screen coordinate is outside the clip region.
375       hittable = false;
376     }
377   }
378
379   if(hittable)
380   {
381     Actor* actor(&layer);
382
383     // Ensure that we can descend into the layer's (or any of its parent's) hierarchy.
384     while(actor && hittable)
385     {
386       if(!hitCheck.DescendActorHierarchy(actor))
387       {
388         hittable = false;
389         break;
390       }
391       actor = actor->GetParent();
392     }
393   }
394
395   return hittable;
396 }
397
398 /**
399  * Gets the near and far clipping planes of the camera from which the scene is viewed in the render task.
400  */
401 void GetCameraClippingPlane(RenderTask& renderTask, float& nearClippingPlane, float& farClippingPlane)
402 {
403   CameraActor* cameraActor = renderTask.GetCameraActor();
404   nearClippingPlane        = cameraActor->GetNearClippingPlane();
405   farClippingPlane         = cameraActor->GetFarClippingPlane();
406 }
407
408 /**
409  * Hit test a RenderTask
410  */
411 bool HitTestRenderTask(const RenderTaskList::ExclusivesContainer& exclusives,
412                        const Vector2&                             sceneSize,
413                        LayerList&                                 layers,
414                        RenderTask&                                renderTask,
415                        Vector2                                    screenCoordinates,
416                        Results&                                   results,
417                        HitTestInterface&                          hitCheck,
418                        const RayTest&                             rayTest)
419 {
420   if(renderTask.IsHittable(screenCoordinates))
421   {
422     Viewport viewport;
423     renderTask.GetViewport(viewport);
424     if(screenCoordinates.x < static_cast<float>(viewport.x) ||
425        screenCoordinates.x > static_cast<float>(viewport.x + viewport.width) ||
426        screenCoordinates.y < static_cast<float>(viewport.y) ||
427        screenCoordinates.y > static_cast<float>(viewport.y + viewport.height))
428     {
429       // The screen coordinate is outside the viewport of render task. The viewport clips all layers.
430       return false;
431     }
432
433     float nearClippingPlane, farClippingPlane;
434     GetCameraClippingPlane(renderTask, nearClippingPlane, farClippingPlane);
435
436     // Determine the layer depth of the source actor
437     Actor* sourceActor(renderTask.GetSourceActor());
438     if(sourceActor)
439     {
440       Dali::Layer layer(sourceActor->GetLayer());
441       if(layer)
442       {
443         const uint32_t sourceActorDepth(layer.GetProperty<bool>(Dali::Layer::Property::DEPTH));
444
445         CameraActor* cameraActor     = renderTask.GetCameraActor();
446         bool         pickingPossible = cameraActor->BuildPickingRay(
447           screenCoordinates,
448           viewport,
449           results.rayOrigin,
450           results.rayDirection);
451         if(!pickingPossible)
452         {
453           return false;
454         }
455
456         // Hit test starting with the top layer, working towards the bottom layer.
457         HitActor hit;
458         bool     overlayHit       = false;
459         bool     layerConsumesHit = false;
460
461         for(int32_t i = layers.GetLayerCount() - 1; i >= 0 && !(hit.actor); --i)
462         {
463           Layer* layer(layers.GetLayer(i));
464           overlayHit = false;
465
466           // Ensure layer is touchable (also checks whether ancestors are also touchable)
467           if(IsActuallyHittable(*layer, screenCoordinates, sceneSize, hitCheck))
468           {
469             // Always hit-test the source actor; otherwise test whether the layer is below the source actor in the hierarchy
470             if(sourceActorDepth == static_cast<uint32_t>(i))
471             {
472               // Recursively hit test the source actor & children, without crossing into other layers.
473               hit = HitTestWithinLayer(*sourceActor,
474                                        renderTask,
475                                        exclusives,
476                                        results.rayOrigin,
477                                        results.rayDirection,
478                                        nearClippingPlane,
479                                        farClippingPlane,
480                                        hitCheck,
481                                        overlayHit,
482                                        layer->GetBehavior() == Dali::Layer::LAYER_3D,
483                                        0u,
484                                        0u,
485                                        rayTest);
486             }
487             else if(IsWithinSourceActors(*sourceActor, *layer))
488             {
489               // Recursively hit test all the actors, without crossing into other layers.
490               hit = HitTestWithinLayer(*layer,
491                                        renderTask,
492                                        exclusives,
493                                        results.rayOrigin,
494                                        results.rayDirection,
495                                        nearClippingPlane,
496                                        farClippingPlane,
497                                        hitCheck,
498                                        overlayHit,
499                                        layer->GetBehavior() == Dali::Layer::LAYER_3D,
500                                        0u,
501                                        0u,
502                                        rayTest);
503             }
504
505             // If this layer is set to consume the hit, then do not check any layers behind it
506             if(hitCheck.DoesLayerConsumeHit(layer))
507             {
508               layerConsumesHit = true;
509               break;
510             }
511           }
512         }
513
514         if(hit.actor)
515         {
516           results.renderTask       = RenderTaskPtr(&renderTask);
517           results.actor            = Dali::Actor(hit.actor);
518           results.actorCoordinates = hit.hitPosition;
519
520           return true; // Success
521         }
522
523         if(layerConsumesHit)
524         {
525           return true; // Also success if layer is consuming the hit
526         }
527       }
528     }
529   }
530   return false;
531 }
532
533 /**
534  * Iterate through the RenderTaskList and perform hit testing.
535  *
536  * @param[in] sceneSize The scene size the tests will be performed in
537  * @param[in] layers The list of layers to test
538  * @param[in] taskList The list of render tasks
539  * @param[out] results Ray information calculated by the camera
540  * @param[in] hitCheck The hit testing interface object to use
541  * @param[in] onScreen True to test on-screen, false to test off-screen
542  * @return True if we have a hit, false otherwise
543  */
544 bool HitTestRenderTaskList(const Vector2&    sceneSize,
545                            LayerList&        layers,
546                            RenderTaskList&   taskList,
547                            const Vector2&    screenCoordinates,
548                            Results&          results,
549                            HitTestInterface& hitCheck,
550                            bool              onScreen)
551 {
552   RenderTaskList::RenderTaskContainer&                  tasks      = taskList.GetTasks();
553   RenderTaskList::RenderTaskContainer::reverse_iterator endIter    = tasks.rend();
554   const auto&                                           exclusives = taskList.GetExclusivesList();
555   RayTest                                               rayTest;
556
557   for(RenderTaskList::RenderTaskContainer::reverse_iterator iter = tasks.rbegin(); endIter != iter; ++iter)
558   {
559     RenderTask& renderTask            = *iter->Get();
560     const bool  isOffscreenRenderTask = renderTask.GetFrameBuffer();
561     if((onScreen && isOffscreenRenderTask) || (!onScreen && !isOffscreenRenderTask))
562     {
563       // Skip to next task
564       continue;
565     }
566
567     if(HitTestRenderTask(exclusives, sceneSize, layers, renderTask, screenCoordinates, results, hitCheck, rayTest))
568     {
569       // Return true when an actor is hit (or layer in our render-task consumes the hit)
570       return true; // don't bother checking off screen tasks
571     }
572   }
573
574   return false;
575 }
576
577 /**
578  * Iterate through the RenderTaskList and perform hit testing for both on-screen and off-screen.
579  *
580  * @param[in] sceneSize The scene size the tests will be performed in
581  * @param[in] layers The list of layers to test
582  * @param[in] taskList The list of render tasks
583  * @param[out] results Ray information calculated by the camera
584  * @param[in] hitCheck The hit testing interface object to use
585  * @param[in] onScreen True to test on-screen, false to test off-screen
586  * @return True if we have a hit, false otherwise
587  */
588 bool HitTestForEachRenderTask(const Vector2&    sceneSize,
589                               LayerList&        layers,
590                               RenderTaskList&   taskList,
591                               const Vector2&    screenCoordinates,
592                               Results&          results,
593                               HitTestInterface& hitCheck)
594 {
595   bool result = false;
596
597   // Check on-screen tasks before off-screen ones.
598   // Hit test order should be reverse of draw order (see ProcessRenderTasks() where off-screen tasks are drawn first).
599   if(HitTestRenderTaskList(sceneSize, layers, taskList, screenCoordinates, results, hitCheck, true) ||
600      HitTestRenderTaskList(sceneSize, layers, taskList, screenCoordinates, results, hitCheck, false))
601   {
602     // Found hit.
603     result = true;
604   }
605
606   return result;
607 }
608
609 } // unnamed namespace
610
611 HitTestInterface::~HitTestInterface() = default;
612
613 bool HitTest(const Vector2& sceneSize, RenderTaskList& taskList, LayerList& layerList, const Vector2& screenCoordinates, Dali::HitTestAlgorithm::Results& results, Dali::HitTestAlgorithm::HitTestFunction func)
614 {
615   bool wasHit(false);
616   // Hit-test the regular on-scene actors
617   Results                hitTestResults;
618   HitTestFunctionWrapper hitTestFunctionWrapper(func);
619   if(HitTestForEachRenderTask(sceneSize, layerList, taskList, screenCoordinates, hitTestResults, hitTestFunctionWrapper))
620   {
621     results.actor            = hitTestResults.actor;
622     results.actorCoordinates = hitTestResults.actorCoordinates;
623     wasHit                   = true;
624   }
625   return wasHit;
626 }
627
628 bool HitTest(const Vector2& sceneSize, RenderTaskList& renderTaskList, LayerList& layerList, const Vector2& screenCoordinates, Results& results, HitTestInterface& hitTestInterface)
629 {
630   bool wasHit(false);
631
632   // Hit-test the regular on-scene actors
633   if(!wasHit)
634   {
635     wasHit = HitTestForEachRenderTask(sceneSize, layerList, renderTaskList, screenCoordinates, results, hitTestInterface);
636   }
637   return wasHit;
638 }
639
640 bool HitTest(const Vector2& sceneSize, RenderTaskList& renderTaskList, LayerList& layerList, const Vector2& screenCoordinates, Results& results)
641 {
642   ActorTouchableCheck actorTouchableCheck;
643   return HitTest(sceneSize, renderTaskList, layerList, screenCoordinates, results, actorTouchableCheck);
644 }
645
646 } // namespace HitTestAlgorithm
647
648 } // namespace Internal
649
650 } // namespace Dali