1 #ifndef DALI_INTERNAL_TOUCH_EVENT_H
2 #define DALI_INTERNAL_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.
22 #include <dali/public-api/common/vector-wrapper.h>
23 #include <dali/public-api/events/point-state.h>
24 #include <dali/public-api/events/touch-event.h>
25 #include <dali/public-api/object/base-object.h>
26 #include <dali/integration-api/events/point.h>
38 using TouchEventPtr = IntrusivePtr<TouchEvent>;
41 * @copydoc Dali::TouchEvent
43 class TouchEvent : public BaseObject
47 // Construction & Destruction
50 * @brief Default constructor
52 TouchEvent() = default;
56 * @param[in] time The time the event occurred
58 TouchEvent( unsigned long time )
64 * @brief Clones the TouchEvent object.
66 * Required because base class copy constructor is not implemented.
67 * @param[in] other The TouchEvent to clone from.
68 * @return A new TouchEvent object which has the same touch point data.
70 static TouchEventPtr Clone( const TouchEvent& other );
72 TouchEvent( const TouchEvent& other ) = delete; ///< Deleted copy constructor.
73 TouchEvent( TouchEvent&& other ) = delete; ///< Deleted move constructor.
74 TouchEvent& operator=( const TouchEvent& other ) = delete; ///< Deleted copy assignment operator.
75 TouchEvent& operator=( TouchEvent&& other ) = delete; ///< Deleted move assignment operator.
80 * @copydoc Dali::TouchEvent::GetTime()
82 inline unsigned long GetTime() const
88 * @copydoc Dali::TouchEvent::GetPointCount()
90 inline std::size_t GetPointCount() const
92 return mPoints.size();
96 * @copydoc Dali::TouchEvent::GetDeviceId()
98 int32_t GetDeviceId( std::size_t point ) const;
101 * @copydoc Dali::TouchEvent::GetGetState()
103 PointState::Type GetState( std::size_t point ) const;
106 * @copydoc Dali::TouchEvent::GetHitActor()
108 Dali::Actor GetHitActor( std::size_t point ) const;
111 * @copydoc Dali::TouchEvent::GetLocalPosition()
113 const Vector2& GetLocalPosition( std::size_t point ) const;
116 * @copydoc Dali::TouchEvent::GetScreenPosition()
118 const Vector2& GetScreenPosition( std::size_t point ) const;
121 * @copydoc Dali::TouchEvent::GetRadius()
123 float GetRadius( std::size_t point ) const;
126 * @copydoc Dali::TouchEvent::GetEllipseRadius()
128 const Vector2& GetEllipseRadius( std::size_t point ) const;
131 * @copydoc Dali::TouchEvent::GetPressure()
133 float GetPressure( std::size_t point ) const;
136 * @copydoc Dali::TouchEvent::GetAngle()
138 Degree GetAngle( std::size_t point ) const;
141 * @brief Returns a const reference to a point at the index requested.
143 * The first point in the set is always the primary point (i.e. the first point touched in a multi-touch event).
145 * @param[in] point The index of the required Point.
146 * @return A const reference to the Point at the position requested
147 * @note point should be less than the value returned by GetPointCount(). Will assert if out of range.
149 const Integration::Point& GetPoint( std::size_t point ) const;
152 * @brief Returns a reference to a point at the index requested.
154 * The first point in the set is always the primary point (i.e. the first point touched in a multi-touch event).
156 * @param[in] point The index of the required Point.
157 * @return A reference to the Point at the position requested
158 * @note point should be less than the value returned by GetPointCount(). Will assert if out of range.
160 Integration::Point& GetPoint( std::size_t point );
163 * @brief Get the device class the mouse/touch event originated from
165 * @return The device class
167 Device::Class::Type GetDeviceClass( std::size_t point ) const;
170 * @brief Get the device subclass the mouse/touch event originated from
172 * @return The device subclass
174 Device::Subclass::Type GetDeviceSubclass( std::size_t point ) const;
177 * @brief Get mouse's button value (ex: right/left button)
179 * @return The value of mouse button
181 MouseButton::Type GetMouseButton( std::size_t point ) const;
186 * @brief Adds a point to this touch event handler.
187 * @param[in] point The point to add to the touch event handler.
189 void AddPoint( const Integration::Point& point );
194 * @brief Virtual Destructor
196 * A reference counted object may only be deleted by calling Unreference()
198 ~TouchEvent() override = default;
202 std::vector< Integration::Point > mPoints; ///< Container of the points for this touch event.
203 unsigned long mTime{0u}; ///< The time (in ms) that the touch event occurred.
206 } // namespace Internal
208 // Helpers for public-api forwarding methods
210 inline Internal::TouchEvent& GetImplementation( Dali::TouchEvent& touchEvent )
212 DALI_ASSERT_ALWAYS( touchEvent && "Touch Event handle is empty" );
214 BaseObject& object = touchEvent.GetBaseObject();
216 return static_cast< Internal::TouchEvent& >( object );
219 inline const Internal::TouchEvent& GetImplementation( const Dali::TouchEvent& touchEvent )
221 DALI_ASSERT_ALWAYS( touchEvent && "Touch Event handle is empty" );
223 const BaseObject& object = touchEvent.GetBaseObject();
225 return static_cast< const Internal::TouchEvent& >( object );
230 #endif // DALI_INTERNAL_TOUCH_EVENT_H