1 #ifndef __DALI_TOUCH_POINT_H__
2 #define __DALI_TOUCH_POINT_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/actors/actor.h>
23 #include <dali/public-api/math/vector2.h>
28 * @addtogroup dali_core_events
33 * @brief A TouchPoint represents a point on the screen that is currently being touched
34 * or where touch has stopped.
36 struct DALI_IMPORT_API TouchPoint
45 Started, /**< Touch or hover started */
46 Finished, /**< Touch or hover finished */
47 Down = Started, /**< Screen touched */
48 Up = Finished, /**< Touch stopped */
49 Motion, /**< Finger dragged or hovered */
50 Leave, /**< Leave the boundary of an actor */
51 Stationary, /**< No change from last event. Useful when a multi-point event occurs where
52 all points are sent but indicates that this particular point has not changed
53 since the last time */
54 Interrupted, /**< A system event has occurred which has interrupted the touch or hover event sequence. */
55 Last /**< Number of states. */
58 // Construction & Destruction
63 * @param[in] id The touch device ID.
64 * @param[in] state The state.
65 * @param[in] screenX The X co-ordinate relative to the screen's origin.
66 * @param[in] screenY The Y co-ordinate relative to the screen's origin.
68 TouchPoint(int id, State state, float screenX, float screenY);
73 * @param[in] id The touch device ID.
74 * @param[in] state The state.
75 * @param[in] screenX The X co-ordinate relative to the screen's origin.
76 * @param[in] screenY The Y co-ordinate relative to the screen's origin.
77 * @param[in] localX The X co-ordinate relative to the top-left (0.0, 0.0, 0.5) of the actor.
78 * @param[in] localY The Y co-ordinate relative to the top-left (0.0, 0.0, 0.5) of the actor.
80 TouchPoint(int id, State state, float screenX, float screenY, float localX, float localY);
90 * @brief Each touch point has a unique device ID which specifies the touch device for that point.
95 * @brief State of the point.
102 * @brief The actor that was underneath the touch point.
107 * @brief The co-ordinates relative to the top-left of the hit-actor.
109 * @note The top-left of an actor is (0.0, 0.0, 0.5).
110 * @note If you require the local coordinates of another actor (e.g the parent of the hit actor),
111 * then you should use Actor::ScreenToLocal().
116 * @brief The co-ordinates relative to the top-left of the screen.
121 typedef std::vector<TouchPoint> TouchPointContainer; ///< Container of touch points.
122 typedef TouchPointContainer::iterator TouchPointContainerIterator; ///< Iterator for Dali::TouchPointContainer
123 typedef TouchPointContainer::const_iterator TouchPointContainerConstIterator; ///< Const iterator for Dali::TouchPointContainer
130 #endif // __DALI_TOUCH_POINT_H__