1 #ifndef __DALI_TOUCH_EVENT_H__
2 #define __DALI_TOUCH_EVENT_H__
5 * Copyright (c) 2014 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 * @addtogroup CAPI_DALI_EVENTS_MODULE
27 #include <dali/public-api/common/vector-wrapper.h>
28 #include <dali/public-api/common/dali-common.h>
29 #include <dali/public-api/events/touch-point.h>
31 namespace Dali DALI_IMPORT_API
33 typedef std::vector<TouchPoint> TouchPointContainer; ///< Container of touch points.
34 typedef TouchPointContainer::iterator TouchPointContainerIterator; ///< Iterator for Dali::TouchPointContainer
35 typedef TouchPointContainer::const_iterator TouchPointContainerConstIterator; ///< Const iterator for Dali::TouchPointContainer
38 * @brief Touch events are a collection of touch points at a specific moment in time.
40 * When a multi-touch event occurs, each touch point represents the points that are currently being
41 * touched or the points where a touch has stopped.
43 struct DALI_IMPORT_API TouchEvent
45 // Construction & Destruction
48 * @brief Default constructor
54 * @param[in] time The time the event occurred
56 TouchEvent(unsigned long time);
66 * @brief This is a container of points for this touch event.
68 * The first point in the set is always the
69 * primary touch point (i.e. the first point touched in a multi-touch event).
71 TouchPointContainer points;
74 * @brief The time (in ms) that the touch event occurred.
78 // Convenience Methods
81 * @brief Returns the total number of points in this TouchEvent.
83 * @return Total number of Points.
85 unsigned int GetPointCount() const;
88 * @brief Returns a touch point at the index requested.
90 * The first point in the set is always the primary
91 * touch point (i.e. the first point touched in a multi-touch event).
92 * @note "point" should be less than the value returned by GetPointCount().
93 * If out of range, then program asserts.
94 * @param[in] point The index of the required Point.
95 * @return Point requested
97 const TouchPoint& GetPoint(unsigned int point) const;
105 #endif // __DALI_TOUCH_EVENT_H__