1 #ifndef DALI_TOUCH_EVENT_H
2 #define DALI_TOUCH_EVENT_H
5 * Copyright (c) 2020 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.
25 #include <dali/public-api/common/dali-common.h>
26 #include <dali/public-api/events/device.h>
27 #include <dali/public-api/events/mouse-button.h>
28 #include <dali/public-api/events/point-state.h>
29 #include <dali/public-api/math/degree.h>
30 #include <dali/public-api/object/base-handle.h>
34 namespace Internal DALI_INTERNAL
40 * @addtogroup dali_core_events
48 * @brief Touch events are a collection of points at a specific moment in time.
50 * When a multi-touch event occurs, each point represents the points that are currently being
51 * touched or the points where a touch has stopped.
53 * The first point is the primary point that's used for hit-testing.
55 * @note As this is a handle to an internal object, it should not be copied (or used in a container) as all that will do is copy the handle to the same object.
56 * The internal object can change which may not be what an application writer expects.
57 * If data does need to be stored in the application, then only the required data should be saved (retrieved using the methods of this class).
59 * Should not use this in a TouchEvent container as it is just a handle and the internal object can change.
61 class DALI_CORE_API TouchEvent : public BaseHandle
64 // Construction & Destruction
67 * @brief An uninitialized TouchEvent instance.
69 * Calling member functions with an uninitialized TouchEvent handle is not allowed.
75 * @brief Copy constructor.
78 * @param[in] other The TouchEvent to copy from
80 TouchEvent(const TouchEvent& other);
83 * @brief Move constructor.
86 * @param[in] other The TouchEvent to move
88 TouchEvent(TouchEvent&& other) noexcept;
100 * @brief Assignment Operator.
103 * @param[in] other The TouchEvent to copy from
104 * @return A reference to this
106 TouchEvent& operator=(const TouchEvent& other);
109 * @brief Move assignment Operator.
112 * @param[in] other The TouchEvent to move
113 * @return A reference to this
115 TouchEvent& operator=(TouchEvent&& other) noexcept;
120 * @brief Returns the time (in ms) that the touch event occurred.
123 * @return The time (in ms) that the touch event occurred
125 unsigned long GetTime() const;
128 * @brief Returns the total number of points in this TouchEvent.
131 * @return Total number of Points
133 std::size_t GetPointCount() const;
136 * @brief Returns the ID of the device used for the Point specified.
138 * Each point has a unique device ID which specifies the device used for that
139 * point. This is returned by this method.
142 * @param[in] point The point required
143 * @return The Device ID of this point
144 * @note If point is greater than GetPointCount() then this method will return -1.
146 int32_t GetDeviceId(std::size_t point) const;
149 * @brief Retrieves the State of the point specified.
152 * @param[in] point The point required
153 * @return The state of the point specified
154 * @note If point is greater than GetPointCount() then this method will return PointState::FINISHED.
157 PointState::Type GetState(std::size_t point) const;
160 * @brief Retrieves the actor that was underneath the point specified.
163 * @param[in] point The point required
164 * @return The actor that was underneath the point specified
165 * @note If point is greater than GetPointCount() then this method will return an empty handle.
167 Actor GetHitActor(std::size_t point) const;
170 * @brief Retrieves the co-ordinates relative to the top-left of the hit-actor at the point specified.
173 * @param[in] point The point required
174 * @return The co-ordinates relative to the top-left of the hit-actor of the point specified
176 * @note The top-left of an actor is (0.0, 0.0, 0.5).
177 * @note If you require the local coordinates of another actor (e.g the parent of the hit actor),
178 * then you should use Actor::ScreenToLocal().
179 * @note If point is greater than GetPointCount() then this method will return Vector2::ZERO.
181 const Vector2& GetLocalPosition(std::size_t point) const;
184 * @brief Retrieves the co-ordinates relative to the top-left of the screen of the point specified.
187 * @param[in] point The point required
188 * @return The co-ordinates relative to the top-left of the screen of the point specified
189 * @note If point is greater than GetPointCount() then this method will return Vector2::ZERO.
191 const Vector2& GetScreenPosition(std::size_t point) const;
194 * @brief Retrieves the radius of the press point.
196 * This is the average of both the horizontal and vertical radii of the press point.
199 * @param[in] point The point required
200 * @return The radius of the press point
201 * @note If point is greater than GetPointCount() then this method will return 0.0f.
203 float GetRadius(std::size_t point) const;
206 * @brief Retrieves BOTH the horizontal and the vertical radii of the press point.
209 * @param[in] point The point required
210 * @return The horizontal and vertical radii of the press point
211 * @note If point is greater than GetPointCount() then this method will return Vector2::ZERO.
213 const Vector2& GetEllipseRadius(std::size_t point) const;
216 * @brief Retrieves the touch pressure.
218 * The pressure range starts at 0.0f.
219 * Normal pressure is defined as 1.0f.
220 * A value between 0.0f and 1.0f means light pressure has been applied.
221 * A value greater than 1.0f means more pressure than normal has been applied.
224 * @param[in] point The point required
225 * @return The touch pressure
226 * @note If point is greater than GetPointCount() then this method will return 1.0f.
228 float GetPressure(std::size_t point) const;
231 * @brief Retrieves the angle of the press point relative to the Y-Axis.
234 * @param[in] point The point required
235 * @return The angle of the press point
236 * @note If point is greater than GetPointCount() then this method will return Degree().
238 Degree GetAngle(std::size_t point) const;
241 * @brief Gets the device class type from which the mouse/touch event is originated.
243 * The device class type is classification type of the input device of event received.
245 * @param[in] point The point required
246 * @return The type of the device class
248 Device::Class::Type GetDeviceClass(std::size_t point) const;
251 * @brief Gets the subclass type of the device from which the mouse/touch event is originated.
253 * The device subclass type is subclassification type of the input device of event received.
255 * @param[in] point The point required
256 * @return The type of the device subclass
258 Device::Subclass::Type GetDeviceSubclass(std::size_t point) const;
261 * @brief Gets the value, which indicates a mouse button. (ex: right/left button)
264 * @param[in] point The point required
265 * @return The mouse button value
267 MouseButton::Type GetMouseButton(std::size_t point) const;
269 public: // Not intended for application developers
272 * @brief This constructor is used internally to Create an initialized TouchEvent handle.
275 * @param[in] internal A pointer to a newly allocated Dali resource
277 explicit DALI_INTERNAL TouchEvent(Internal::TouchEvent* internal);
286 #endif // DALI_TOUCH_EVENT_H