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