summaryrefslogtreecommitdiffstats
path: root/xbmc/input/touch/ITouchInputHandler.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 18:07:22 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 18:07:22 +0000
commitc04dcc2e7d834218ef2d4194331e383402495ae1 (patch)
tree7333e38d10d75386e60f336b80c2443c1166031d /xbmc/input/touch/ITouchInputHandler.h
parentInitial commit. (diff)
downloadkodi-c04dcc2e7d834218ef2d4194331e383402495ae1.tar.xz
kodi-c04dcc2e7d834218ef2d4194331e383402495ae1.zip
Adding upstream version 2:20.4+dfsg.upstream/2%20.4+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'xbmc/input/touch/ITouchInputHandler.h')
-rw-r--r--xbmc/input/touch/ITouchInputHandler.h104
1 files changed, 104 insertions, 0 deletions
diff --git a/xbmc/input/touch/ITouchInputHandler.h b/xbmc/input/touch/ITouchInputHandler.h
new file mode 100644
index 0000000..1275839
--- /dev/null
+++ b/xbmc/input/touch/ITouchInputHandler.h
@@ -0,0 +1,104 @@
+/*
+ * Copyright (C) 2013-2018 Team Kodi
+ * This file is part of Kodi - https://kodi.tv
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ * See LICENSES/README.md for more information.
+ */
+
+#pragma once
+
+#include "input/touch/ITouchInputHandling.h"
+
+#include <atomic>
+#include <stdint.h>
+
+/*!
+ * \ingroup touch
+ * \brief Touch input event
+ */
+typedef enum
+{
+ TouchInputUnchanged = 0,
+ TouchInputAbort,
+ TouchInputDown,
+ TouchInputUp,
+ TouchInputMove
+} TouchInput;
+
+/*!
+ * \ingroup touch
+ * \brief Interface (implements ITouchInputHandling) defining methods to handle
+ * raw touch input events (down, up, move).
+ *
+ * This interface should be implemented on platforms only supporting low level
+ * (raw) touch input events like touch down/up/move and with no gesture
+ * recognition logic.
+ */
+class ITouchInputHandler : public ITouchInputHandling
+{
+public:
+ ITouchInputHandler() : m_dpi(160.0f) {}
+ ~ITouchInputHandler() override = default;
+
+ /*!
+ * \brief Handle a touch event
+ *
+ * Handles the given touch event at the given location.
+ * This takes into account all the currently active pointers
+ * which need to be updated before calling this method to
+ * actually interpret and handle the changes in touch.
+ *
+ * \param event The actual touch event (abort, down, up, move)
+ * \param x The x coordinate (with sub-pixel) of the touch
+ * \param y The y coordinate (with sub-pixel) of the touch
+ * \param time The time (in nanoseconds) when this touch occurred
+ * \param pointer The number of the touch pointer which caused this event (default 0)
+ * \param size The size of the touch pointer (with sub-pixel) (default 0.0)
+ *
+ * \return True if the event was handled otherwise false.
+ *
+ * \sa Update
+ */
+ virtual bool HandleTouchInput(
+ TouchInput event, float x, float y, int64_t time, int32_t pointer = 0, float size = 0.0f) = 0;
+
+ /*!
+ * \brief Update the coordinates of a pointer
+ *
+ * Depending on how a platform handles touch input and provides the necessary events
+ * this method needs to be called at different times. If there's an event for every
+ * touch action this method does not need to be called at all. If there's only a
+ * touch event for the primary pointer (and no special events for any secondary
+ * pointers in a multi touch gesture) this method should be called for every active
+ * secondary pointer before calling Handle.
+ *
+ * \param pointer The number of the touch pointer which caused this event (default 0)
+ * \param x The x coordinate (with sub-pixel) of the touch
+ * \param y The y coordinate (with sub-pixel) of the touch
+ * \param time The time (in nanoseconds) when this touch occurred
+ * \param size The size of the touch pointer (with sub-pixel) (default 0.0)
+ *
+ * \return True if the pointer was updated otherwise false.
+ *
+ * \sa Handle
+ */
+ virtual bool UpdateTouchPointer(
+ int32_t pointer, float x, float y, int64_t time, float size = 0.0f)
+ {
+ return false;
+ }
+
+ void SetScreenDPI(float dpi)
+ {
+ if (dpi > 0.0f)
+ m_dpi = dpi;
+ }
+ float GetScreenDPI() { return m_dpi; }
+
+protected:
+ /*!
+ * \brief DPI value of the touch screen
+ */
+ std::atomic<float> m_dpi;
+};