-#ifndef __DALI_INTERNAL_HIT_TEST_ALGORITHM_H__
-#define __DALI_INTERNAL_HIT_TEST_ALGORITHM_H__
-
-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+#ifndef DALI_INTERNAL_HIT_TEST_ALGORITHM_H
+#define DALI_INTERNAL_HIT_TEST_ALGORITHM_H
+
+/*
+ * Copyright (c) 2019 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
// INTERNAL INCLUDES
-#include <dali/public-api/events/hit-test-algorithm.h>
-#include <dali/public-api/render-tasks/render-task.h>
+#include <dali/public-api/actors/actor.h>
+#include <dali/devel-api/events/hit-test-algorithm.h>
+#include <dali/internal/event/render-tasks/render-task-impl.h>
namespace Dali
{
namespace Internal
{
+class Layer;
+class LayerList;
+
/**
* This namespace is provided for application developers to do hit test for the actors.
*/
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.
};
/**
- * @copydoc Dali::HitTestAlgorithm::HitTest(Stage stage, const Vector2& screenCoordinates, Results& results, HitTestFunction func )
+ * Interface used by the hit-test-algorithm to determine whether the actor is hittable or whether
+ * we walk down its hierarchy.
*/
-void HitTest( Stage& stage, const Vector2& screenCoordinates, Dali::HitTestAlgorithm::Results& results, Dali::HitTestAlgorithm::HitTestFunction func );
+struct HitTestInterface
+{
+ /**
+ * Called by the hit-test algorithm to determine whether the actor is hittable or not.
+ *
+ * @param[in] actor Raw pointer to an Actor object.
+ *
+ * @return true if actor is hittable, false otherwise.
+ */
+ virtual bool IsActorHittable( Actor* actor ) = 0;
+
+ /**
+ * Called by the hit-test algorithm to determine whether the algorithm should descend the actor's
+ * hierarchy (and hit-test its children as well).
+ *
+ * @param[in] actor Raw pointer to an Actor object.
+ *
+ * @return true if we should descend the actor's hierarchy, false otherwise.
+ */
+ virtual bool DescendActorHierarchy( Actor* actor ) = 0;
+
+ /**
+ * Called by the hit-test algorithm to determine whether the layer specified consumes the hit
+ * regardless of whether an actor in the layer requires it or not.
+ *
+ * @note If true is returned, then no layers behind this layer will be hit-test.
+ *
+ * @param[in] layer Raw pointer to a Layer object.
+ *
+ * @return true if the layer should consume the hit, false otherwise.
+ */
+ virtual bool DoesLayerConsumeHit( Layer* layer ) = 0;
+
+protected:
+
+ /**
+ * Virtual destructor, no deletion through this interface
+ */
+ virtual ~HitTestInterface();
+
+};
+
+/**
+ * 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( 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
+ * @return true if something was hit
*
* <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
* first to determine if the ray is in the actor's proximity.
* - If this is also successful, then a more accurate ray test is performed to see if we have a hit.
*
- * - 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.
+ * @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.
*/
-void HitTest( Stage& stage, const Vector2& screenCoordinates, Results& results );
+bool HitTest( const Vector2& sceneSize, RenderTaskList& renderTaskList, LayerList& layerList, const Vector2& screenCoordinates,
+ Results& results, HitTestInterface& hitTestInterface );
/**
- * Hit test specific to a given RenderTask
- * @param[in] stage The stage.
- * @param[in] renderTask The render task for hit test
+ * Default HitTest where we check if a touch is required.
+ *
+ * @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&)
*/
-void 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 );
} // namespace HitTestAlgorithm
} // namespace Dali
-#endif // __DALI_INTERNAL_HIT_TEST_ALGORITHM_H__
+#endif // DALI_INTERNAL_HIT_TEST_ALGORITHM_H
projects / platform / core / uifw / dali-core.git / blobdiff