2 * Copyright (c) 2016 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
21 #include <dali/public-api/dali-core.h>
22 #include <dali/devel-api/events/hit-test-algorithm.h>
23 #include <dali/integration-api/events/touch-event-integ.h>
24 #include <dali-test-suite-utils.h>
32 * The functor to be used in the hit-test algorithm to check whether the actor is hittable.
34 bool IsActorHittableFunction(Actor actor, Dali::HitTestAlgorithm::TraverseType type)
36 bool hittable = false;
40 case Dali::HitTestAlgorithm::CHECK_ACTOR:
42 // Check whether the actor is visible and not fully transparent.
44 && actor.GetCurrentWorldColor().a > 0.01f) // not FULLY_TRANSPARENT
46 // Check whether the actor has the specific name "HittableActor"
47 if(actor.GetName() == "HittableActor")
54 case Dali::HitTestAlgorithm::DESCEND_ACTOR_TREE:
56 if( actor.IsVisible() ) // Actor is visible, if not visible then none of its children are visible.
72 bool DefaultIsActorTouchableFunction(Dali::Actor actor, Dali::HitTestAlgorithm::TraverseType type)
74 bool hittable = false;
78 case Dali::HitTestAlgorithm::CHECK_ACTOR:
80 if( actor.IsVisible() &&
81 actor.IsSensitive() &&
82 actor.GetCurrentWorldColor().a > 0.01f)
88 case Dali::HitTestAlgorithm::DESCEND_ACTOR_TREE:
90 if( actor.IsVisible() && // Actor is visible, if not visible then none of its children are visible.
91 actor.IsSensitive()) // Actor is sensitive, if insensitive none of its children should be hittable either.
106 } // anonymous namespace
109 // Positive test case for a method
110 int UtcDaliHitTestAlgorithmWithFunctor(void)
112 TestApplication application;
113 tet_infoline("Testing Dali::HitTestAlgorithm functor");
115 Stage stage = Stage::GetCurrent();
117 Actor actor = Actor::New();
118 actor.SetSize(100.0f, 100.0f);
119 actor.SetAnchorPoint(AnchorPoint::TOP_LEFT);
120 actor.SetName("NonHittableActor");
124 application.SendNotification();
125 application.Render();
127 Vector2 screenCoordinates( 10.0f, 10.0f );
128 Vector2 localCoordinates;
129 actor.ScreenToLocal( localCoordinates.x, localCoordinates.y, screenCoordinates.x, screenCoordinates.y );
131 // Perform a hit-test at the given screen coordinates
132 Dali::HitTestAlgorithm::Results results;
133 Dali::HitTestAlgorithm::HitTest( stage, screenCoordinates, results, IsActorHittableFunction );
134 DALI_TEST_CHECK( results.actor != actor );
136 actor.SetName("HittableActor");
138 results.actor = Actor();
139 results.actorCoordinates = Vector2::ZERO;
141 // Perform a hit-test at the given screen coordinates
142 Dali::HitTestAlgorithm::HitTest( stage, screenCoordinates, results, IsActorHittableFunction );
143 DALI_TEST_CHECK( results.actor == actor );
144 DALI_TEST_EQUALS( localCoordinates, results.actorCoordinates, 0.1f, TEST_LOCATION );
148 int UtcDaliHitTestAlgorithmWithFunctorOnRenderTask(void)
150 TestApplication application;
151 tet_infoline("Testing Dali::HitTestAlgorithm functor, specific to a given render task");
153 Stage stage = Stage::GetCurrent();
154 Size stageSize = stage.GetSize();
155 RenderTaskList taskList = stage.GetRenderTaskList();
159 for( int i=0; i<2; i++ )
161 actor[i] = Actor::New();
162 actor[i].SetSize(100.f, 100.f);
163 actor[i].SetParentOrigin(ParentOrigin::TOP_LEFT);
164 actor[i].SetAnchorPoint(AnchorPoint::TOP_LEFT);
165 actor[i].SetName("HittableActor");
168 Vector2 position( 50.f, 40.f );
169 actor[1].SetPosition( position.x, position.y );
171 RenderTask renderTask[2];
172 renderTask[0] = taskList.GetTask( 0u );
174 FrameBufferImage frameBufferImage = FrameBufferImage::New(stageSize.width, stageSize.height, Pixel::A8);
175 renderTask[1] = taskList.CreateTask();
176 renderTask[1].SetSourceActor( actor[1] );
177 renderTask[1].SetExclusive( true );
178 renderTask[1].SetInputEnabled( true );
179 renderTask[1].SetTargetFrameBuffer( frameBufferImage );
180 renderTask[1].SetRefreshRate( RenderTask::REFRESH_ONCE );
181 renderTask[1].SetScreenToFrameBufferFunction( RenderTask::FULLSCREEN_FRAMEBUFFER_FUNCTION );
182 application.GetGlAbstraction().SetCheckFramebufferStatusResult( GL_FRAMEBUFFER_COMPLETE );
185 application.SendNotification();
186 application.Render();
187 application.Render();
188 application.SendNotification();
190 // Perform a hit-test at the given screen coordinates with different render tasks
192 Dali::HitTestAlgorithm::Results results;
193 Vector2 screenCoordinates( 25.f, 25.f );
195 Dali::HitTestAlgorithm::HitTest( renderTask[0], screenCoordinates, results, IsActorHittableFunction );
196 DALI_TEST_CHECK( results.actor == actor[0] );
197 DALI_TEST_EQUALS( screenCoordinates, results.actorCoordinates, 0.1f, TEST_LOCATION );
199 results.actor = Actor();
200 results.actorCoordinates = Vector2::ZERO;
201 Dali::HitTestAlgorithm::HitTest( renderTask[1], screenCoordinates, results, IsActorHittableFunction );
202 DALI_TEST_CHECK( !results.actor );
203 DALI_TEST_EQUALS( Vector2::ZERO, results.actorCoordinates, 0.1f, TEST_LOCATION );
205 screenCoordinates.x = 80.f;
206 screenCoordinates.y = 70.f;
208 results.actor = Actor();
209 results.actorCoordinates = Vector2::ZERO;
210 Dali::HitTestAlgorithm::HitTest( renderTask[0], screenCoordinates, results, IsActorHittableFunction );
211 DALI_TEST_CHECK( results.actor == actor[0] );
212 DALI_TEST_EQUALS( screenCoordinates, results.actorCoordinates, 0.1f, TEST_LOCATION );
214 results.actor = Actor();
215 results.actorCoordinates = Vector2::ZERO;
216 Dali::HitTestAlgorithm::HitTest( renderTask[1], screenCoordinates, results, IsActorHittableFunction );
217 DALI_TEST_CHECK( results.actor == actor[1]);
218 DALI_TEST_EQUALS( screenCoordinates - position, results.actorCoordinates, 0.1f, TEST_LOCATION );
220 screenCoordinates.x = 120.f;
221 screenCoordinates.y = 130.f;
223 results.actor = Actor();
224 results.actorCoordinates = Vector2::ZERO;
225 Dali::HitTestAlgorithm::HitTest( renderTask[0], screenCoordinates, results, IsActorHittableFunction );
226 DALI_TEST_CHECK( !results.actor );
227 DALI_TEST_EQUALS( Vector2::ZERO, results.actorCoordinates, 0.1f, TEST_LOCATION );
229 results.actor = Actor();
230 results.actorCoordinates = Vector2::ZERO;
231 Dali::HitTestAlgorithm::HitTest( renderTask[1], screenCoordinates, results, IsActorHittableFunction );
232 DALI_TEST_CHECK( results.actor == actor[1]);
233 DALI_TEST_EQUALS( screenCoordinates - position, results.actorCoordinates, 0.1f, TEST_LOCATION );
238 int UtcDaliHitTestAlgorithmOrtho01(void)
240 TestApplication application;
241 tet_infoline("Testing Dali::HitTestAlgorithm with parallel Ortho camera()");
243 Stage stage = Stage::GetCurrent();
244 RenderTaskList renderTaskList = stage.GetRenderTaskList();
245 RenderTask defaultRenderTask = renderTaskList.GetTask(0u);
246 Dali::CameraActor cameraActor = defaultRenderTask.GetCameraActor();
248 Vector2 stageSize ( stage.GetSize() );
249 cameraActor.SetOrthographicProjection( stageSize );
250 cameraActor.SetPosition(0.0f, 0.0f, 1600.0f);
252 Vector2 actorSize( stageSize * 0.5f );
253 // Create two actors with half the size of the stage and set them to be partially overlapping
254 Actor blue = Actor::New();
255 blue.SetName( "Blue" );
256 blue.SetAnchorPoint( AnchorPoint::CENTER );
257 blue.SetParentOrigin( Vector3(1.0f/3.0f, 1.0f/3.0f, 0.5f) );
258 blue.SetSize( actorSize );
261 Actor green = Actor::New( );
262 green.SetName( "Green" );
263 green.SetAnchorPoint( AnchorPoint::CENTER );
264 green.SetParentOrigin( Vector3(2.0f/3.0f, 2.0f/3.0f, 0.5f) );
265 green.SetSize( actorSize );
267 // Add the actors to the view
272 application.SendNotification();
273 application.Render(0);
274 application.Render(10);
276 HitTestAlgorithm::Results results;
277 HitTest(stage, stageSize / 2.0f, results, &DefaultIsActorTouchableFunction);
278 DALI_TEST_CHECK( results.actor == green );
279 DALI_TEST_EQUALS( results.actorCoordinates, actorSize * 1.0f/6.0f, TEST_LOCATION );
281 HitTest(stage, stageSize / 3.0f, results, &DefaultIsActorTouchableFunction);
282 DALI_TEST_CHECK( results.actor == blue );
283 DALI_TEST_EQUALS( results.actorCoordinates, actorSize * 0.5f, TEST_LOCATION );
285 HitTest(stage, stageSize * 2.0f / 3.0f, results, &DefaultIsActorTouchableFunction);
286 DALI_TEST_CHECK( results.actor == green );
287 DALI_TEST_EQUALS( results.actorCoordinates, actorSize * 0.5f, TEST_LOCATION );
292 int UtcDaliHitTestAlgorithmOrtho02(void)
294 TestApplication application;
295 tet_infoline("Testing Dali::HitTestAlgorithm with offset Ortho camera()");
297 Stage stage = Stage::GetCurrent();
298 RenderTaskList renderTaskList = stage.GetRenderTaskList();
299 RenderTask defaultRenderTask = renderTaskList.GetTask(0u);
300 Dali::CameraActor cameraActor = defaultRenderTask.GetCameraActor();
302 Vector2 stageSize ( stage.GetSize() );
303 cameraActor.SetOrthographicProjection(-stageSize.x * 0.3f, stageSize.x * 0.7f,
304 stageSize.y * 0.3f, -stageSize.y * 0.7f,
306 cameraActor.SetPosition(0.0f, 0.0f, 1600.0f);
308 Vector2 actorSize( stageSize * 0.5f );
309 // Create two actors with half the size of the stage and set them to be partially overlapping
310 Actor blue = Actor::New();
311 blue.SetName( "Blue" );
312 blue.SetAnchorPoint( AnchorPoint::TOP_LEFT );
313 blue.SetParentOrigin( Vector3(0.2f, 0.2f, 0.5f) );
314 blue.SetSize( actorSize );
317 Actor green = Actor::New( );
318 green.SetName( "Green" );
319 green.SetAnchorPoint( AnchorPoint::TOP_LEFT );
320 green.SetParentOrigin( Vector3(0.4f, 0.4f, 0.5f) );
321 green.SetSize( actorSize );
323 // Add the actors to the view
328 application.SendNotification();
329 application.Render(0);
330 application.Render(10);
333 HitTestAlgorithm::Results results;
334 HitTest(stage, Vector2( 240.0f, 400.0f ), results, &DefaultIsActorTouchableFunction);
335 DALI_TEST_CHECK( results.actor == green );
336 DALI_TEST_EQUALS( results.actorCoordinates, actorSize * 0.6f, 0.01f, TEST_LOCATION );
340 HitTestAlgorithm::Results results;
341 HitTest(stage, Vector2( 0.001f, 0.001f ), results, &DefaultIsActorTouchableFunction);
342 DALI_TEST_CHECK( results.actor == blue );
343 DALI_TEST_EQUALS( results.actorCoordinates, Vector2( 0.001f, 0.001f ), 0.001f, TEST_LOCATION );
347 HitTestAlgorithm::Results results;
348 HitTest(stage, stageSize, results, &DefaultIsActorTouchableFunction);
349 DALI_TEST_CHECK( ! results.actor );
350 DALI_TEST_EQUALS( results.actorCoordinates, Vector2::ZERO, TEST_LOCATION );
355 HitTestAlgorithm::Results results;
356 HitTest(stage, stageSize*0.69f, results, &DefaultIsActorTouchableFunction);
357 DALI_TEST_CHECK( results.actor == green );
358 DALI_TEST_EQUALS( results.actorCoordinates, actorSize * 0.98f, 0.01f, TEST_LOCATION );
364 int UtcDaliHitTestAlgorithmClippingActor(void)
366 TestApplication application;
367 tet_infoline("Testing Dali::HitTestAlgorithm with a stencil");
369 Stage stage = Stage::GetCurrent();
370 Actor rootLayer = stage.GetRootLayer();
371 rootLayer.SetName( "RootLayer" );
374 Layer layer = Layer::New();
375 layer.SetAnchorPoint( AnchorPoint::TOP_LEFT );
376 layer.SetParentOrigin( ParentOrigin::TOP_LEFT );
377 layer.SetName( "layer" );
380 // Create a clipping actor and add it to the layer.
381 Actor clippingActor = CreateRenderableActor( Dali::BufferImage::WHITE() );
382 clippingActor.SetAnchorPoint( AnchorPoint::TOP_LEFT );
383 clippingActor.SetParentOrigin( ParentOrigin::TOP_LEFT );
384 clippingActor.SetSize( 50.0f, 50.0f );
385 clippingActor.SetProperty( Actor::Property::CLIPPING_MODE, ClippingMode::CLIP_CHILDREN );
386 clippingActor.SetName( "clippingActor" );
387 layer.Add( clippingActor );
389 // Create a renderable actor and add it to the clipping actor.
390 Actor childActor = CreateRenderableActor( Dali::BufferImage::WHITE() );
391 childActor.SetSize( 100.0f, 100.0f );
392 childActor.SetAnchorPoint( AnchorPoint::TOP_LEFT );
393 childActor.SetParentOrigin( ParentOrigin::TOP_LEFT );
394 childActor.SetName( "childActor" );
395 clippingActor.Add( childActor );
398 application.SendNotification();
399 application.Render();
401 // Hit within clippingActor and childActor.
402 HitTestAlgorithm::Results results;
403 HitTest( stage, Vector2( 10.0f, 10.0f ), results, &DefaultIsActorTouchableFunction );
404 DALI_TEST_CHECK( results.actor == childActor );
405 tet_printf( "Hit: %s\n", ( results.actor ? results.actor.GetName().c_str() : "NULL" ) );
407 // Hit within childActor but outside of clippingActor, should hit the root-layer instead.
408 HitTest( stage, Vector2( 60.0f, 60.0f ), results, &DefaultIsActorTouchableFunction);
409 DALI_TEST_CHECK( results.actor == rootLayer );
410 tet_printf( "Hit: %s\n", ( results.actor ? results.actor.GetName().c_str() : "NULL" ) );
415 int UtcDaliHitTestAlgorithmOverlay(void)
417 TestApplication application;
418 tet_infoline("Testing Dali::HitTestAlgorithm with overlay actors");
420 Stage stage = Stage::GetCurrent();
421 RenderTaskList renderTaskList = stage.GetRenderTaskList();
422 RenderTask defaultRenderTask = renderTaskList.GetTask(0u);
423 Dali::CameraActor cameraActor = defaultRenderTask.GetCameraActor();
425 Vector2 stageSize ( stage.GetSize() );
426 cameraActor.SetOrthographicProjection( stageSize );
427 cameraActor.SetPosition(0.0f, 0.0f, 1600.0f);
429 Vector2 actorSize( stageSize * 0.5f );
430 // Create two actors with half the size of the stage and set them to be partially overlapping
431 Actor blue = Actor::New();
432 blue.SetDrawMode( DrawMode::OVERLAY_2D );
433 blue.SetName( "Blue" );
434 blue.SetAnchorPoint( AnchorPoint::CENTER );
435 blue.SetParentOrigin( Vector3(1.0f/3.0f, 1.0f/3.0f, 0.5f) );
436 blue.SetSize( actorSize );
439 Actor green = Actor::New( );
440 green.SetName( "Green" );
441 green.SetAnchorPoint( AnchorPoint::CENTER );
442 green.SetParentOrigin( Vector3(2.0f/3.0f, 2.0f/3.0f, 0.5f) );
443 green.SetSize( actorSize );
445 // Add the actors to the view
450 application.SendNotification();
451 application.Render(0);
452 application.Render(10);
454 HitTestAlgorithm::Results results;
456 //Hit in the intersection. Should pick the blue actor since it is an overlay.
457 HitTest(stage, stageSize / 2.0f, results, &DefaultIsActorTouchableFunction);
458 DALI_TEST_CHECK( results.actor == blue );
459 DALI_TEST_EQUALS( results.actorCoordinates, actorSize * 5.0f/6.0f, TEST_LOCATION );
461 //Hit in the blue actor
462 HitTest(stage, stageSize / 3.0f, results, &DefaultIsActorTouchableFunction);
463 DALI_TEST_CHECK( results.actor == blue );
464 DALI_TEST_EQUALS( results.actorCoordinates, actorSize * 0.5f, TEST_LOCATION );
466 //Hit in the green actor
467 HitTest(stage, stageSize * 2.0f / 3.0f, results, &DefaultIsActorTouchableFunction);
468 DALI_TEST_CHECK( results.actor == green );
469 DALI_TEST_EQUALS( results.actorCoordinates, actorSize * 0.5f, TEST_LOCATION );