1 #ifndef __DALI_TOUCH_DATA_H__
2 #define __DALI_TOUCH_DATA_H__
5 * Copyright (c) 2016 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/point-state.h>
27 #include <dali/public-api/object/base-handle.h>
28 #include <dali/public-api/math/degree.h>
33 namespace Internal DALI_INTERNAL
39 * @addtogroup dali_core_events
47 * @brief Touch events are a collection of points at a specific moment in time.
49 * When a multi-touch event occurs, each point represents the points that are currently being
50 * touched or the points where a touch has stopped.
52 * The first point is the primary point that's used for hit-testing.
54 * @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.
55 * The internal object can change which may not be what an application writer expects.
56 * 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).
58 * Should not use this in a TouchData container as it is just a handle and the internal object can change.
60 class DALI_IMPORT_API TouchData : public BaseHandle
64 // Construction & Destruction
67 * @brief An uninitialized TouchData instance.
69 * Calling member functions with an uninitialized TouchData handle is not allowed.
75 * @brief Copy constructor
78 * @param[in] other The TouchData to copy from.
80 TouchData( const TouchData& other );
92 * @brief Assignment Operator
95 * @param[in] other The TouchData to copy from.
97 TouchData& operator=( const TouchData& other );
102 * @brief Returns the time (in ms) that the touch event occurred.
105 * @return The time (in ms) that the touch event occurred.
107 unsigned long GetTime() const;
110 * @brief Returns the total number of points in this TouchData.
113 * @return Total number of Points.
115 std::size_t GetPointCount() const;
118 * @brief Returns the ID of the device used for the Point specified.
120 * Each point has a unique device ID which specifies the device used for that
121 * point. This is returned by this method.
124 * @param[in] point The point required.
125 * @return The Device ID of this point.
126 * @note If point is greater than GetPointCount() then this method will return -1.
128 int32_t GetDeviceId( std::size_t point ) const;
131 * @brief Retrieves the State of the point specified.
134 * @param[in] point The point required.
135 * @return The state of the point specified.
136 * @note If point is greater than GetPointCount() then this method will return PointState::FINISHED.
139 PointState::Type GetState( std::size_t point ) const;
142 * @brief Retrieve the actor that was underneath the point specified.
145 * @param[in] point The point required.
146 * @return The actor that was underneath the point specified.
147 * @note If point is greater than GetPointCount() then this method will return an empty handle.
149 Actor GetHitActor( std::size_t point ) const;
152 * @brief Retrieve the co-ordinates relative to the top-left of the hit-actor at the point specified.
155 * @param[in] point The point required.
156 * @return The co-ordinates relative to the top-left of the hit-actor of the point specified.
158 * @note The top-left of an actor is (0.0, 0.0, 0.5).
159 * @note If you require the local coordinates of another actor (e.g the parent of the hit actor),
160 * then you should use Actor::ScreenToLocal().
161 * @note If point is greater than GetPointCount() then this method will return Vector2::ZERO.
163 const Vector2& GetLocalPosition( std::size_t point ) const;
166 * @brief Retrieves the co-ordinates relative to the top-left of the screen of the point specified.
169 * @param[in] point The point required.
170 * @return The co-ordinates relative to the top-left of the screen of the point specified.
171 * @note If point is greater than GetPointCount() then this method will return Vector2::ZERO.
173 const Vector2& GetScreenPosition( std::size_t point ) const;
176 * @brief Retrieve the radius of the press point.
178 * This is the average of both the horizontal and vertical radii of the press point.
181 * @param[in] point The point required.
182 * @return The radius of the press point.
183 * @note If point is greater than GetPointCount() then this method will return 0.0f.
185 float GetRadius( std::size_t point ) const;
188 * @brief Retrieve BOTH the horizontal and the vertical radii of the press point.
191 * @param[in] point The point required.
192 * @return The horizontal and vertical radii of the press point.
193 * @note If point is greater than GetPointCount() then this method will return Vector2::ZERO.
195 const Vector2& GetEllipseRadius( std::size_t point ) const;
198 * @brief Retrieve the touch pressure.
200 * The pressure range starts at 0.0f.
201 * Normal pressure is defined as 1.0f.
202 * A value between 0.0f and 1.0f means light pressure has been applied.
203 * A value greater than 1.0f means more pressure than normal has been applied.
206 * @param[in] point The point required.
207 * @return The touch pressure.
208 * @note If point is greater than GetPointCount() then this method will return 1.0f.
210 float GetPressure( std::size_t point ) const;
213 * @brief Retrieve the angle of the press point relative to the Y-Axis.
216 * @param[in] point The point required.
217 * @return The angle of the press point.
218 * @note If point is greater than GetPointCount() then this method will return Degree().
220 Degree GetAngle( std::size_t point ) const;
222 public: // Not intended for application developers
226 * @brief This constructor is used internally to Create an initialized TouchData handle.
229 * @param [in] touchData A pointer to a newly allocated Dali resource
231 explicit DALI_INTERNAL TouchData( Internal::TouchData* touchData );
240 #endif // __DALI_TOUCH_DATA_H__