#define DALI_INTERNAL_HIT_TEST_ALGORITHM_H
/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2022 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
// INTERNAL INCLUDES
#include <dali/devel-api/events/hit-test-algorithm.h>
-#include <dali/public-api/render-tasks/render-task.h>
+#include <dali/integration-api/events/touch-event-integ.h>
+#include <dali/internal/event/render-tasks/render-task-impl.h>
+#include <dali/public-api/actors/actor.h>
namespace Dali
{
-
namespace Internal
{
-
class Layer;
+class LayerList;
/**
* This namespace is provided for application developers to do hit test for the actors.
*/
namespace HitTestAlgorithm
{
-
struct Results
{
- Dali::RenderTask renderTask; ///< The render-task displaying the actor.
- Dali::Actor actor; ///< The hit actor.
- Vector2 actorCoordinates; ///< The actor coordinates.
- Vector4 rayOrigin; ///< The point of origin of the ray.
- Vector4 rayDirection; ///< The direction vector of the ray.
+ RenderTaskPtr renderTask; ///< The render-task displaying the actor.
+ Dali::Actor actor; ///< The hit actor.
+ Vector2 actorCoordinates; ///< The actor coordinates.
+ Vector4 rayOrigin; ///< The point of origin of the ray.
+ Vector4 rayDirection; ///< The direction vector of the ray.
+ Integration::Point point; ///< The point of event touched.
+ uint32_t eventTime; ///< The time the event occurred.
};
/**
*
* @return true if actor is hittable, false otherwise.
*/
- virtual bool IsActorHittable( Actor* actor ) = 0;
+ virtual bool IsActorHittable(Actor* actor) = 0;
/**
* Called by the hit-test algorithm to determine whether the algorithm should descend the actor's
*
* @return true if we should descend the actor's hierarchy, false otherwise.
*/
- virtual bool DescendActorHierarchy( Actor* actor ) = 0;
+ virtual bool DescendActorHierarchy(Actor* actor) = 0;
/**
* Called by the hit-test algorithm to determine whether the layer specified consumes the hit
*
* @return true if the layer should consume the hit, false otherwise.
*/
- virtual bool DoesLayerConsumeHit( Layer* layer ) = 0;
+ virtual bool DoesLayerConsumeHit(Layer* layer) = 0;
-protected:
+ /**
+ * Called by the hit-test algorithm to determine whether the actor will be hit or not.
+ *
+ * @note If true is returned, then this actor will be hit.
+ * If false is returend, then this actor passes the hit-test and the next actor performs the hit-test.
+ *
+ * @param[in] actor The hit actor.
+ * @param[in] point The point of event touched.
+ * @param[in] hitPointLocal The hit point in the Actor's local reference system.
+ * @param[in] timeStamp The time the event occurred.
+ *
+ * @return true if the actor should be the hit, false otherwise.
+ */
+ virtual bool ActorRequiresHitResultCheck(Actor* actor, Integration::Point point, Vector2 hitPointLocal, uint32_t timeStamp) = 0;
+protected:
/**
* Virtual destructor, no deletion through this interface
*/
virtual ~HitTestInterface();
-
};
/**
- * @copydoc Dali::HitTestAlgorithm::HitTest(Stage stage, const Vector2& screenCoordinates, Results& results, HitTestFunction func )
+ * Hit test specific to a given scene.
+ *
+ * @param[in] sceneSize The size of the scene.
+ * @param[in] renderTaskList The render task list of the scene.
+ * @param[in] layerList The layer list of the scene.
+ * @param[in] screenCoordinates The screen coordinates.
+ * @param[out] results The results of the hit-test.
+ * @param[in] func The function to use in the hit-test algorithm.
+ * @return true if something was hit
+ *
+ * @see HitTest(Stage&, const Vector2&, Results&, HitTestInterface&)
*/
-bool HitTest( Stage& stage, const Vector2& screenCoordinates, Dali::HitTestAlgorithm::Results& results, Dali::HitTestAlgorithm::HitTestFunction func );
+bool HitTest(const Vector2& sceneSize, RenderTaskList& renderTaskList, LayerList& layerList, const Vector2& screenCoordinates, Dali::HitTestAlgorithm::Results& results, Dali::HitTestAlgorithm::HitTestFunction func);
/**
* Given screen coordinates, this method returns the hit actor & the local coordinates relative to the actor etc.
- * @param[in] stage The stage.
+ * @param[in] sceneSize The size of the scene.
+ * @param[in] renderTaskList The render task list of the scene.
+ * @param[in] layerList The layer list of the scene.
* @param[in] screenCoordinates The screen coordinates.
* @param[out] results The results of the hit-test.
* @param[in] hitTestInterface Used to determine whether the actor is hit or whether we walk down its hierarchy
*
* <h3>Hit Test Algorithm:</h3>
*
- * - The system overlay RenderTaskList is hit-tested first.
- * - If no hit then the regular RenderTaskList is used to hit test the on stage actors.
+ * - The regular RenderTaskList is used to hit test the on scene actors.
* - The bulk of the hit test algorithm is described in Dali::Actor.
* - In each RenderTask's its viewing parameters (the view and projection matrices, and the viewport)
* are used to build a picking ray into the scene which is used for our ray tests when hit testing
* @note Currently, we prefer a child hit over a parent (regardless of the distance from the
* camera) unless the parent is a RenderableActor but this is subject to change.
*/
-bool HitTest( Stage& stage, const Vector2& screenCoordinates, Results& results, HitTestInterface& hitTestInterface );
+bool HitTest(const Vector2& sceneSize, RenderTaskList& renderTaskList, LayerList& layerList, const Vector2& screenCoordinates, Results& results, HitTestInterface& hitTestInterface);
/**
* Default HitTest where we check if a touch is required.
*
- * @param[in] stage The stage.
+ * @param[in] sceneSize The size of the scene.
+ * @param[in] renderTaskList The render task list of the scene.
+ * @param[in] layerList The layer list of the scene.
* @param[in] screenCoordinates The screen coordinates.
* @param[out] results The results of the hit-test.
+ * @param[in] ownActor The actor from which the touch down was started.
* @return true if something was hit
*
* @see HitTest(Stage&, const Vector2&, Results&, HitTestInterface&)
*/
-bool HitTest( Stage& stage, const Vector2& screenCoordinates, Results& results );
-
-/**
- * Hit test specific to a given RenderTask
- *
- * @param[in] stage The stage.
- * @param[in] renderTask The render task for hit test
- * @param[in] screenCoordinates The screen coordinates.
- * @param[out] results The results of the hit-test.
- * @param[in] func The function to use in the hit-test algorithm.
- * @return true if something was hit
- */
-bool HitTest( Stage& stage, RenderTask& renderTask, const Vector2& screenCoordinates,
- Dali::HitTestAlgorithm::Results& results, Dali::HitTestAlgorithm::HitTestFunction func );
-
+bool HitTest(const Vector2& sceneSize, RenderTaskList& renderTaskList, LayerList& layerList, const Vector2& screenCoordinates, Results& results, const Actor* ownActor = nullptr);
} // namespace HitTestAlgorithm