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