1 #ifndef __DALI_TOUCH_DATA_H__
2 #define __DALI_TOUCH_DATA_H__
5 * Copyright (c) 2017 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/point-state.h>
28 #include <dali/public-api/object/base-handle.h>
29 #include <dali/public-api/math/degree.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 TouchData container as it is just a handle and the internal object can change.
61 class DALI_IMPORT_API TouchData : public BaseHandle
65 // Construction & Destruction
68 * @brief An uninitialized TouchData instance.
70 * Calling member functions with an uninitialized TouchData handle is not allowed.
76 * @brief Copy constructor.
79 * @param[in] other The TouchData to copy from
81 TouchData( const TouchData& other );
93 * @brief Assignment Operator.
96 * @param[in] other The TouchData to copy from
97 * @return A reference to this
99 TouchData& operator=( const TouchData& other );
104 * @brief Returns the time (in ms) that the touch event occurred.
107 * @return The time (in ms) that the touch event occurred
109 unsigned long GetTime() const;
112 * @brief Returns the total number of points in this TouchData.
115 * @return Total number of Points
117 std::size_t GetPointCount() const;
120 * @brief Returns the ID of the device used for the Point specified.
122 * Each point has a unique device ID which specifies the device used for that
123 * point. This is returned by this method.
126 * @param[in] point The point required
127 * @return The Device ID of this point
128 * @note If point is greater than GetPointCount() then this method will return -1.
130 int32_t GetDeviceId( std::size_t point ) const;
133 * @brief Retrieves the State of the point specified.
136 * @param[in] point The point required
137 * @return The state of the point specified
138 * @note If point is greater than GetPointCount() then this method will return PointState::FINISHED.
141 PointState::Type GetState( std::size_t point ) const;
144 * @brief Retrieves the actor that was underneath the point specified.
147 * @param[in] point The point required
148 * @return The actor that was underneath the point specified
149 * @note If point is greater than GetPointCount() then this method will return an empty handle.
151 Actor GetHitActor( std::size_t point ) const;
154 * @brief Retrieves the co-ordinates relative to the top-left of the hit-actor at the point specified.
157 * @param[in] point The point required
158 * @return The co-ordinates relative to the top-left of the hit-actor of the point specified
160 * @note The top-left of an actor is (0.0, 0.0, 0.5).
161 * @note If you require the local coordinates of another actor (e.g the parent of the hit actor),
162 * then you should use Actor::ScreenToLocal().
163 * @note If point is greater than GetPointCount() then this method will return Vector2::ZERO.
165 const Vector2& GetLocalPosition( std::size_t point ) const;
168 * @brief Retrieves the co-ordinates relative to the top-left of the screen of the point specified.
171 * @param[in] point The point required
172 * @return The co-ordinates relative to the top-left of the screen of the point specified
173 * @note If point is greater than GetPointCount() then this method will return Vector2::ZERO.
175 const Vector2& GetScreenPosition( std::size_t point ) const;
178 * @brief Retrieves the radius of the press point.
180 * This is the average of both the horizontal and vertical radii of the press point.
183 * @param[in] point The point required
184 * @return The radius of the press point
185 * @note If point is greater than GetPointCount() then this method will return 0.0f.
187 float GetRadius( std::size_t point ) const;
190 * @brief Retrieves BOTH the horizontal and the vertical radii of the press point.
193 * @param[in] point The point required
194 * @return The horizontal and vertical radii of the press point
195 * @note If point is greater than GetPointCount() then this method will return Vector2::ZERO.
197 const Vector2& GetEllipseRadius( std::size_t point ) const;
200 * @brief Retrieves the touch pressure.
202 * The pressure range starts at 0.0f.
203 * Normal pressure is defined as 1.0f.
204 * A value between 0.0f and 1.0f means light pressure has been applied.
205 * A value greater than 1.0f means more pressure than normal has been applied.
208 * @param[in] point The point required
209 * @return The touch pressure
210 * @note If point is greater than GetPointCount() then this method will return 1.0f.
212 float GetPressure( std::size_t point ) const;
215 * @brief Retrieves the angle of the press point relative to the Y-Axis.
218 * @param[in] point The point required
219 * @return The angle of the press point
220 * @note If point is greater than GetPointCount() then this method will return Degree().
222 Degree GetAngle( std::size_t point ) const;
225 * @brief Get the device class type the mouse/touch event originated from.
227 * The device class type is classification type of the input device of event received.
229 * @param[in] point The point required
230 * @return The type of the device class
232 Device::Class::Type GetDeviceClass( std::size_t point ) const;
235 * @brief Get the device subclass type the mouse/touch event originated from.
237 * The device subclass type is subclassification type of the input device of event received.
239 * @param[in] point The point required
240 * @return The type of the device subclass
242 Device::Subclass::Type GetDeviceSubclass( std::size_t point ) const;
244 public: // Not intended for application developers
248 * @brief This constructor is used internally to Create an initialized TouchData handle.
251 * @param[in] touchData A pointer to a newly allocated Dali resource
253 explicit DALI_INTERNAL TouchData( Internal::TouchData* touchData );
262 #endif // __DALI_TOUCH_DATA_H__