touchcontrols.h

Go to the documentation of this file.

// Luanti
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2014 sapier
// Copyright (C) 2024 grorp, Gregor Parzefall
 
#pragma once
 
#include "irrlichttypes.h"
#include "IEventReceiver.h"
 
#include <memory>
#include <optional>
#include <unordered_map>
#include <vector>
 
#include "itemdef.h"
#include "touchscreenlayout.h"
#include "util/basic_macros.h"
#include "client/keycode.h"
 
class IrrlichtDevice;
namespace gui
{
        class IGUIEnvironment;
        class IGUIImage;
        class IGUIStaticText;
}
 
class ISimpleTextureSource;
 
using namespace core;
using namespace gui;
 
 
enum class TapState
{
        None,
        ShortTap,
        LongTap,
};
 
 
#define BUTTON_REPEAT_DELAY 0.5f
#define BUTTON_REPEAT_INTERVAL 0.333f
 
// Our simulated clicks last some milliseconds so that server-side mods have a
// chance to detect them via l_get_player_control.
// If you tap faster than this value, the simulated clicks are of course shorter.
#define SIMULATED_CLICK_DURATION_MS 50
 
 
struct button_info
{
        touch_gui_button_id id;
        float repeat_counter;
        GameKeyType game_key;
        std::vector<size_t> pointer_ids;
        std::shared_ptr<IGUIImage> gui_button = nullptr;
 
        enum {
                NOT_TOGGLEABLE,
                FIRST_TEXTURE,
                SECOND_TEXTURE
        } toggleable = NOT_TOGGLEABLE;
        std::string toggle_textures[2];
};
 
 
class TouchControls
{
public:
        TouchControls(IrrlichtDevice *device, ISimpleTextureSource *tsrc);
        ~TouchControls();
        DISABLE_CLASS_COPY(TouchControls);
 
        void translateEvent(const SEvent &event);
        void applyContextControls(const TouchInteractionMode &mode);
 
        double getYawChange()
        {
                double res = m_camera_yaw_change;
                m_camera_yaw_change = 0;
                return res;
        }
 
        double getPitchChange() {
                double res = m_camera_pitch_change;
                m_camera_pitch_change = 0;
                return res;
        }
 
        bool isShootlineAvailable() { return m_interaction_style == TAP; }

        line3d<f32> getShootline() { return m_shootline; }
 
        void step(float dtime);
 
        void setVisible(bool visible);
        void hide();
        void show();
 
        void resetHotbarRects();
        void registerHotbarRect(u16 index, const recti &rect);
        std::optional<u16> getHotbarSelection();
 
        bool isStatusTextOverridden() { return m_overflow_open; }
        IGUIStaticText *getStatusText() { return m_status_text.get(); }
 
private:
        IrrlichtDevice *m_device = nullptr;
        IGUIEnvironment *m_guienv = nullptr;
        IEventReceiver *m_receiver = nullptr;
        ISimpleTextureSource *m_texturesource = nullptr;
        bool m_visible = true;
 
        // changes to these two values are handled in TouchControls::step
        v2u32 m_screensize;
        s32 m_button_size;
 
        // cached settings
        TouchInteractionStyle m_interaction_style;
        double m_touchscreen_threshold;
        u16 m_long_tap_delay;
        bool m_fixed_joystick;
        bool m_joystick_triggers_aux1;
 
        static void settingChangedCallback(const std::string &name, void *data);
        void readSettings();
 
        ButtonLayout m_layout;
        void applyLayout(const ButtonLayout &layout);
 
        std::unordered_map<u16, recti> m_hotbar_rects;
        std::optional<u16> m_hotbar_selection = std::nullopt;
 
        // value in degree
        double m_camera_yaw_change = 0.0;
        double m_camera_pitch_change = 0.0;

        line3d<f32> m_shootline;
 
        bool m_has_move_id = false;
        size_t m_move_id;
        bool m_move_has_really_moved = false;
        u64 m_move_downtime = 0;
        // m_move_pos stays valid even after the m_move_id pointer has been
        // released and m_pointer_pos[m_move_id] has been erased
        // (or even overwritten by a new pointer reusing the same id).
        v2s32 m_move_pos;
        // This is needed so that we don't miss if m_has_move_id is true for less
        // than one client step, i.e. press and release happen in the same step.
        bool m_had_move_id = false;
        bool m_move_prevent_short_tap = false;
 
        bool m_has_joystick_id = false;
        size_t m_joystick_id;
        bool m_joystick_has_really_moved = false;
        bool m_joystick_status_aux1 = false;
        std::shared_ptr<IGUIImage> m_joystick_btn_off;
        std::shared_ptr<IGUIImage> m_joystick_btn_bg;
        std::shared_ptr<IGUIImage> m_joystick_btn_center;
 
        std::vector<button_info> m_buttons;
        std::shared_ptr<IGUIImage> m_overflow_btn;
 
        bool m_overflow_open = false;
        std::shared_ptr<IGUIStaticText> m_overflow_bg;
        std::vector<button_info> m_overflow_buttons;
        std::vector<std::shared_ptr<IGUIStaticText>> m_overflow_button_titles;
        std::vector<recti> m_overflow_button_rects;
 
        std::shared_ptr<IGUIStaticText> m_status_text;
 
        // Note: TouchControls intentionally uses IGUIImage instead of IGUIButton
        // for its buttons. We only want static image display, not interactivity,
        // from Irrlicht.
 
        void emitGameKeyEvent(GameKeyType key, float value);
 
        void loadButtonTexture(IGUIImage *gui_button, const std::string &path);
        void buttonEmitAction(button_info &btn, bool action);
 
        bool buttonsHandlePress(std::vector<button_info> &buttons, size_t pointer_id, IGUIElement *element);
        bool buttonsHandleRelease(std::vector<button_info> &buttons, size_t pointer_id);
        bool buttonsStep(std::vector<button_info> &buttons, float dtime);
 
        void toggleOverflowMenu();
        void updateVisibility();
        void releaseAll();
 
        // initialize a button
        bool mayAddButton(touch_gui_button_id id);
        void addButton(std::vector<button_info> &buttons,
                        touch_gui_button_id id, const std::string &image,
                        const recti &rect, bool visible);
        void addToggleButton(std::vector<button_info> &buttons,
                        touch_gui_button_id id,
                        const std::string &image_1, const std::string &image_2,
                        const recti &rect, bool visible);
 
        IGUIImage *makeButtonDirect(touch_gui_button_id id,
                        const recti &rect, bool visible);
 
        // handle pressing hotbar items
        bool isHotbarButton(const SEvent &event);
 
        // handle release event
        void handleReleaseEvent(size_t pointer_id);
 
        // apply joystick status
        void applyJoystickStatus();
 
        // map to store the IDs and original positions of currently pressed pointers
        std::unordered_map<size_t, v2s32> m_pointer_downpos;
        // map to store the IDs and positions of currently pressed pointers
        std::unordered_map<size_t, v2s32> m_pointer_pos;
 
        // The following are not used if m_interaction_style == BUTTONS_CROSSHAIR
 
        TouchInteractionMode m_last_mode = TouchInteractionMode_END;
        TapState m_tap_state = TapState::None;
 
        bool m_dig_pressed = false;
        u64 m_dig_pressed_until = 0;
 
        bool m_place_pressed = false;
        u64 m_place_pressed_until = 0;
};
 
extern TouchControls *g_touchcontrols;