1 #ifndef __DALI_TOUCH_EVENT_H__
2 #define __DALI_TOUCH_EVENT_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/common/dali-common.h>
23 #include <dali/public-api/events/touch-point.h>
28 * @brief Touch events are a collection of touch points at a specific moment in time.
30 * When a multi-touch event occurs, each touch point represents the points that are currently being
31 * touched or the points where a touch has stopped.
33 struct DALI_IMPORT_API TouchEvent
35 // Construction & Destruction
38 * @brief Default constructor
44 * @param[in] time The time the event occurred
46 TouchEvent(unsigned long time);
56 * @brief This is a container of points for this touch event.
58 * The first point in the set is always the
59 * primary touch point (i.e. the first point touched in a multi-touch event).
61 TouchPointContainer points;
64 * @brief The time (in ms) that the touch event occurred.
68 // Convenience Methods
71 * @brief Returns the total number of points in this TouchEvent.
73 * @return Total number of Points.
75 unsigned int GetPointCount() const;
78 * @brief Returns a touch point at the index requested.
80 * The first point in the set is always the primary
81 * touch point (i.e. the first point touched in a multi-touch event).
82 * @note "point" should be less than the value returned by GetPointCount().
83 * If out of range, then program asserts.
84 * @param[in] point The index of the required Point.
85 * @return Point requested
87 const TouchPoint& GetPoint(unsigned int point) const;
92 #endif // __DALI_TOUCH_EVENT_H__