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/vector-wrapper.h>
23 #include <dali/public-api/common/dali-common.h>
24 #include <dali/public-api/events/touch-point.h>
29 * @brief Touch events are a collection of touch points at a specific moment in time.
31 * When a multi-touch event occurs, each touch point represents the points that are currently being
32 * touched or the points where a touch has stopped.
34 struct DALI_IMPORT_API TouchEvent
36 // Construction & Destruction
39 * @brief Default constructor
45 * @param[in] time The time the event occurred
47 TouchEvent(unsigned long time);
57 * @brief This is a container of points for this touch event.
59 * The first point in the set is always the
60 * primary touch point (i.e. the first point touched in a multi-touch event).
62 TouchPointContainer points;
65 * @brief The time (in ms) that the touch event occurred.
69 // Convenience Methods
72 * @brief Returns the total number of points in this TouchEvent.
74 * @return Total number of Points.
76 unsigned int GetPointCount() const;
79 * @brief Returns a touch point at the index requested.
81 * The first point in the set is always the primary
82 * touch point (i.e. the first point touched in a multi-touch event).
83 * @note "point" should be less than the value returned by GetPointCount().
84 * If out of range, then program asserts.
85 * @param[in] point The index of the required Point.
86 * @return Point requested
88 const TouchPoint& GetPoint(unsigned int point) const;
93 #endif // __DALI_TOUCH_EVENT_H__