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>
29 * @brief A TouchPoint represents a point on the screen that is currently being touched
30 * or where touch has stopped.
32 struct DALI_IMPORT_API TouchPoint
41 Started, /**< Touch or hover started */
42 Finished, /**< Touch or hover finished */
43 Down = Started, /**< Screen touched */
44 Up = Finished, /**< Touch stopped */
45 Motion, /**< Finger dragged or hovered */
46 Leave, /**< Leave the boundary of an actor */
47 Stationary, /**< No change from last event. Useful when a multi-point event occurs where
48 all points are sent but indicates that this particular point has not changed
49 since the last time */
50 Interrupted, /**< A system event has occurred which has interrupted the touch or hover event sequence. */
51 Last /**< Number of states. */
54 // Construction & Destruction
59 * @param[in] id The touch device ID.
60 * @param[in] state The state.
61 * @param[in] screenX The X co-ordinate relative to the screen's origin.
62 * @param[in] screenY The Y co-ordinate relative to the screen's origin.
64 TouchPoint(int id, State state, float screenX, float screenY);
69 * @param[in] id The touch device ID.
70 * @param[in] state The state.
71 * @param[in] screenX The X co-ordinate relative to the screen's origin.
72 * @param[in] screenY The Y co-ordinate relative to the screen's origin.
73 * @param[in] localX The X co-ordinate relative to the top-left (0.0, 0.0, 0.5) of the actor.
74 * @param[in] localY The Y co-ordinate relative to the top-left (0.0, 0.0, 0.5) of the actor.
76 TouchPoint(int id, State state, float screenX, float screenY, float localX, float localY);
86 * @brief Each touch point has a unique device ID which specifies the touch device for that point.
91 * @brief State of the point.
98 * @brief The actor that was underneath the touch point.
103 * @brief The co-ordinates relative to the top-left of the hit-actor.
105 * @note The top-left of an actor is (0.0, 0.0, 0.5).
106 * @note If you require the local coordinates of another actor (e.g the parent of the hit actor),
107 * then you should use Actor::ScreenToLocal().
112 * @brief The co-ordinates relative to the top-left of the screen.
117 typedef std::vector<TouchPoint> TouchPointContainer; ///< Container of touch points.
118 typedef TouchPointContainer::iterator TouchPointContainerIterator; ///< Iterator for Dali::TouchPointContainer
119 typedef TouchPointContainer::const_iterator TouchPointContainerConstIterator; ///< Const iterator for Dali::TouchPointContainer
123 #endif // __DALI_TOUCH_POINT_H__