2 Copyright (C) 2014 sapier
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU Lesser General Public License as published by
6 the Free Software Foundation; either version 2.1 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU Lesser General Public License for more details.
14 You should have received a copy of the GNU Lesser General Public License along
15 with this program; if not, write to the Free Software Foundation, Inc.,
16 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 #include "touchscreengui.h"
20 #include "irrlichttypes.h"
26 #include "util/numeric.h"
32 #include <ISceneCollisionManager.h>
34 using namespace irr::core;
36 extern Settings *g_settings;
38 const char** touchgui_button_imagenames = (const char*[]) {
49 static irr::EKEY_CODE id2keycode(touch_gui_button_id id)
79 return keyname_to_keycode(g_settings->get("keymap_" + key).c_str());
82 TouchScreenGUI *g_touchscreengui;
84 TouchScreenGUI::TouchScreenGUI(IrrlichtDevice *device, IEventReceiver* receiver):
86 m_guienv(device->getGUIEnvironment()),
93 for (unsigned int i=0; i < after_last_element_id; i++) {
94 m_buttons[i].guibutton = 0;
95 m_buttons[i].repeatcounter = -1;
98 m_screensize = m_device->getVideoDriver()->getScreenSize();
101 void TouchScreenGUI::loadButtonTexture(button_info* btn, const char* path)
104 video::ITexture *texture = m_texturesource->getTexture(path,&tid);
106 btn->guibutton->setUseAlphaChannel(true);
107 btn->guibutton->setImage(texture);
108 btn->guibutton->setPressedImage(texture);
109 btn->guibutton->setScaleImage(true);
110 btn->guibutton->setDrawBorder(false);
111 btn->guibutton->setText(L"");
115 void TouchScreenGUI::initButton(touch_gui_button_id id, rect<s32> button_rect,
116 std::wstring caption, bool immediate_release )
119 button_info* btn = &m_buttons[id];
120 btn->guibutton = m_guienv->addButton(button_rect, 0, id, caption.c_str());
121 btn->guibutton->grab();
122 btn->repeatcounter = -1;
123 btn->keycode = id2keycode(id);
124 btn->immediate_release = immediate_release;
127 loadButtonTexture(btn,touchgui_button_imagenames[id]);
130 static int getMaxControlPadSize(float density) {
131 return 200 * density * g_settings->getFloat("gui_scaling");
134 void TouchScreenGUI::init(ISimpleTextureSource* tsrc, float density)
138 u32 control_pad_size =
139 MYMIN((2 * m_screensize.Y) / 3,getMaxControlPadSize(density));
141 u32 button_size = control_pad_size / 3;
143 m_texturesource = tsrc;
144 m_control_pad_rect = rect<s32>(0, m_screensize.Y - 3 * button_size,
145 3 * button_size, m_screensize.Y);
150 for now only 0, 1, 2, and 4 are used
153 for (int y = 0; y < 2; ++y)
154 for (int x = 0; x < 3; ++x, ++number) {
155 rect<s32> button_rect(
156 x * button_size, m_screensize.Y - button_size * (2 - y),
157 (x + 1) * button_size, m_screensize.Y - button_size * (1 - y)
159 touch_gui_button_id id = after_last_element_id;
160 std::wstring caption;
179 if (id != after_last_element_id) {
180 initButton(id, button_rect, caption, false);
184 /* init inventory button */
185 initButton(inventory_id,
186 rect<s32>(0, m_screensize.Y - (button_size/2),
187 (button_size/2), m_screensize.Y), L"inv", true);
189 /* init jump button */
191 rect<s32>(m_screensize.X-(1.75*button_size),
192 m_screensize.Y - (0.5*button_size),
193 m_screensize.X-(0.25*button_size),
197 /* init crunch button */
198 initButton(crunch_id,
199 rect<s32>(m_screensize.X-(3.25*button_size),
200 m_screensize.Y - (0.5*button_size),
201 m_screensize.X-(1.75*button_size),
205 /* init chat button */
207 rect<s32>(m_screensize.X-(1.5*button_size), 0,
208 m_screensize.X, button_size),
212 touch_gui_button_id TouchScreenGUI::getButtonID(s32 x, s32 y)
214 IGUIElement* rootguielement = m_guienv->getRootGUIElement();
216 if (rootguielement != NULL) {
217 gui::IGUIElement *element =
218 rootguielement->getElementFromPoint(core::position2d<s32>(x,y));
221 for (unsigned int i=0; i < after_last_element_id; i++) {
222 if (element == m_buttons[i].guibutton) {
223 return (touch_gui_button_id) i;
228 return after_last_element_id;
231 touch_gui_button_id TouchScreenGUI::getButtonID(int eventID)
233 for (unsigned int i=0; i < after_last_element_id; i++) {
234 button_info* btn = &m_buttons[i];
236 std::vector<int>::iterator id =
237 std::find(btn->ids.begin(),btn->ids.end(), eventID);
239 if (id != btn->ids.end())
240 return (touch_gui_button_id) i;
243 return after_last_element_id;
246 bool TouchScreenGUI::isHUDButton(const SEvent &event)
248 // check if hud item is pressed
249 for (std::map<int,rect<s32> >::iterator iter = m_hud_rects.begin();
250 iter != m_hud_rects.end(); iter++) {
251 if (iter->second.isPointInside(
252 v2s32(event.TouchInput.X,
255 if ( iter->first < 8) {
256 SEvent* translated = new SEvent();
257 memset(translated,0,sizeof(SEvent));
258 translated->EventType = irr::EET_KEY_INPUT_EVENT;
259 translated->KeyInput.Key = (irr::EKEY_CODE) (KEY_KEY_1 + iter->first);
260 translated->KeyInput.Control = false;
261 translated->KeyInput.Shift = false;
262 translated->KeyInput.PressedDown = true;
263 m_receiver->OnEvent(*translated);
264 m_hud_ids[event.TouchInput.ID] = translated->KeyInput.Key;
273 bool TouchScreenGUI::isReleaseHUDButton(int eventID)
275 std::map<int,irr::EKEY_CODE>::iterator iter = m_hud_ids.find(eventID);
277 if (iter != m_hud_ids.end()) {
278 SEvent* translated = new SEvent();
279 memset(translated,0,sizeof(SEvent));
280 translated->EventType = irr::EET_KEY_INPUT_EVENT;
281 translated->KeyInput.Key = iter->second;
282 translated->KeyInput.PressedDown = false;
283 translated->KeyInput.Control = false;
284 translated->KeyInput.Shift = false;
285 m_receiver->OnEvent(*translated);
286 m_hud_ids.erase(iter);
293 void TouchScreenGUI::ButtonEvent(touch_gui_button_id button,
294 int eventID, bool action)
296 button_info* btn = &m_buttons[button];
297 SEvent* translated = new SEvent();
298 memset(translated,0,sizeof(SEvent));
299 translated->EventType = irr::EET_KEY_INPUT_EVENT;
300 translated->KeyInput.Key = btn->keycode;
301 translated->KeyInput.Control = false;
302 translated->KeyInput.Shift = false;
303 translated->KeyInput.Char = 0;
307 assert(std::find(btn->ids.begin(),btn->ids.end(), eventID) == btn->ids.end());
309 btn->ids.push_back(eventID);
311 if (btn->ids.size() > 1) return;
313 btn->repeatcounter = 0;
314 translated->KeyInput.PressedDown = true;
315 translated->KeyInput.Key = btn->keycode;
316 m_receiver->OnEvent(*translated);
319 if ((!action) || (btn->immediate_release)) {
321 std::vector<int>::iterator pos =
322 std::find(btn->ids.begin(),btn->ids.end(), eventID);
323 /* has to be in touch list */
324 assert(pos != btn->ids.end());
327 if (btn->ids.size() > 0) { return; }
329 translated->KeyInput.PressedDown = false;
330 btn->repeatcounter = -1;
331 m_receiver->OnEvent(*translated);
336 void TouchScreenGUI::translateEvent(const SEvent &event)
339 infostream << "TouchScreenGUI::translateEvent got event but not visible?!" << std::endl;
343 if (event.EventType != EET_TOUCH_INPUT_EVENT) {
347 if (event.TouchInput.Event == ETIE_PRESSED_DOWN) {
349 /* add to own copy of eventlist ...
350 * android would provide this information but irrlicht guys don't
351 * wanna design a efficient interface
354 toadd.id = event.TouchInput.ID;
355 toadd.X = event.TouchInput.X;
356 toadd.Y = event.TouchInput.Y;
357 m_known_ids.push_back(toadd);
359 int eventID = event.TouchInput.ID;
361 touch_gui_button_id button =
362 getButtonID(event.TouchInput.X, event.TouchInput.Y);
364 /* handle button events */
365 if (button != after_last_element_id) {
366 ButtonEvent(button,eventID,true);
368 else if (isHUDButton(event))
370 /* already handled in isHUDButton() */
372 /* handle non button events */
374 /* if we don't already have a moving point make this the moving one */
375 if (m_move_id == -1) {
376 m_move_id = event.TouchInput.ID;
377 m_move_has_really_moved = false;
378 m_move_downtime = getTimeMs();
379 m_move_downlocation = v2s32(event.TouchInput.X, event.TouchInput.Y);
380 m_move_sent_as_mouse_event = false;
384 m_pointerpos[event.TouchInput.ID] = v2s32(event.TouchInput.X, event.TouchInput.Y);
386 else if (event.TouchInput.Event == ETIE_LEFT_UP) {
387 verbosestream << "Up event for pointerid: " << event.TouchInput.ID << std::endl;
389 touch_gui_button_id button = getButtonID(event.TouchInput.ID);
391 /* handle button events */
392 if (button != after_last_element_id) {
393 ButtonEvent(button,event.TouchInput.ID,false);
395 /* handle hud button events */
396 else if (isReleaseHUDButton(event.TouchInput.ID)) {
397 /* nothing to do here */
399 /* handle the point used for moving view */
400 else if (event.TouchInput.ID == m_move_id) {
403 /* if this pointer issued a mouse event issue symmetric release here */
404 if (m_move_sent_as_mouse_event) {
405 SEvent* translated = new SEvent;
406 memset(translated,0,sizeof(SEvent));
407 translated->EventType = EET_MOUSE_INPUT_EVENT;
408 translated->MouseInput.X = m_move_downlocation.X;
409 translated->MouseInput.Y = m_move_downlocation.Y;
410 translated->MouseInput.Shift = false;
411 translated->MouseInput.Control = false;
412 translated->MouseInput.ButtonStates = 0;
413 translated->MouseInput.Event = EMIE_LMOUSE_LEFT_UP;
414 m_receiver->OnEvent(*translated);
418 /* do double tap detection */
419 doubleTapDetection();
424 << "TouchScreenGUI::translateEvent released unknown button: "
425 << event.TouchInput.ID << std::endl;
428 for (std::vector<id_status>::iterator iter = m_known_ids.begin();
429 iter != m_known_ids.end(); iter++) {
430 if (iter->id == event.TouchInput.ID) {
431 m_known_ids.erase(iter);
437 assert(event.TouchInput.Event == ETIE_MOVED);
438 int move_idx = event.TouchInput.ID;
440 if (m_pointerpos[event.TouchInput.ID] ==
441 v2s32(event.TouchInput.X, event.TouchInput.Y)) {
445 if (m_move_id != -1) {
446 if ((event.TouchInput.ID == m_move_id) &&
447 (!m_move_sent_as_mouse_event)) {
449 double distance = sqrt(
450 (m_pointerpos[event.TouchInput.ID].X - event.TouchInput.X) *
451 (m_pointerpos[event.TouchInput.ID].X - event.TouchInput.X) +
452 (m_pointerpos[event.TouchInput.ID].Y - event.TouchInput.Y) *
453 (m_pointerpos[event.TouchInput.ID].Y - event.TouchInput.Y));
455 if ((distance > g_settings->getU16("touchscreen_threshold")) ||
456 (m_move_has_really_moved)) {
457 m_move_has_really_moved = true;
458 s32 X = event.TouchInput.X;
459 s32 Y = event.TouchInput.Y;
461 // update camera_yaw and camera_pitch
462 s32 dx = X - m_pointerpos[event.TouchInput.ID].X;
463 s32 dy = Y - m_pointerpos[event.TouchInput.ID].Y;
465 /* adapt to similar behaviour as pc screen */
466 double d = g_settings->getFloat("mouse_sensitivity") *4;
467 double old_yaw = m_camera_yaw;
468 double old_pitch = m_camera_pitch;
470 m_camera_yaw -= dx * d;
471 m_camera_pitch = MYMIN(MYMAX( m_camera_pitch + (dy * d),-180),180);
473 while (m_camera_yaw < 0)
476 while (m_camera_yaw > 360)
480 m_shootline = m_device
482 ->getSceneCollisionManager()
483 ->getRayFromScreenCoordinates(v2s32(X, Y));
484 m_pointerpos[event.TouchInput.ID] = v2s32(X, Y);
487 else if ((event.TouchInput.ID == m_move_id) &&
488 (m_move_sent_as_mouse_event)) {
489 m_shootline = m_device
491 ->getSceneCollisionManager()
492 ->getRayFromScreenCoordinates(
493 v2s32(event.TouchInput.X,event.TouchInput.Y));
497 handleChangedButton(event);
502 void TouchScreenGUI::handleChangedButton(const SEvent &event)
504 for (unsigned int i = 0; i < after_last_element_id; i++) {
506 if (m_buttons[i].ids.empty()) {
509 for(std::vector<int>::iterator iter = m_buttons[i].ids.begin();
510 iter != m_buttons[i].ids.end(); iter++) {
512 if (event.TouchInput.ID == *iter) {
514 int current_button_id =
515 getButtonID(event.TouchInput.X, event.TouchInput.Y);
517 if (current_button_id == i) {
521 /* remove old button */
522 ButtonEvent((touch_gui_button_id) i,*iter,false);
524 if (current_button_id == after_last_element_id) {
527 ButtonEvent((touch_gui_button_id) current_button_id,*iter,true);
534 int current_button_id = getButtonID(event.TouchInput.X, event.TouchInput.Y);
536 if (current_button_id == after_last_element_id) {
540 button_info* btn = &m_buttons[current_button_id];
541 if (std::find(btn->ids.begin(),btn->ids.end(), event.TouchInput.ID) == btn->ids.end()) {
542 ButtonEvent((touch_gui_button_id) current_button_id,event.TouchInput.ID,true);
547 bool TouchScreenGUI::doubleTapDetection()
549 m_key_events[0].down_time = m_key_events[1].down_time;
550 m_key_events[0].x = m_key_events[1].x;
551 m_key_events[0].y = m_key_events[1].y;
552 m_key_events[1].down_time = m_move_downtime;
553 m_key_events[1].x = m_move_downlocation.X;
554 m_key_events[1].y = m_move_downlocation.Y;
556 u32 delta = porting::getDeltaMs(m_key_events[0].down_time,getTimeMs());
560 double distance = sqrt(
561 (m_key_events[0].x - m_key_events[1].x) * (m_key_events[0].x - m_key_events[1].x) +
562 (m_key_events[0].y - m_key_events[1].y) * (m_key_events[0].y - m_key_events[1].y));
565 if (distance >(20 + g_settings->getU16("touchscreen_threshold")))
568 SEvent* translated = new SEvent();
569 memset(translated,0,sizeof(SEvent));
570 translated->EventType = EET_MOUSE_INPUT_EVENT;
571 translated->MouseInput.X = m_key_events[0].x;
572 translated->MouseInput.Y = m_key_events[0].y;
573 translated->MouseInput.Shift = false;
574 translated->MouseInput.Control = false;
575 translated->MouseInput.ButtonStates = EMBSM_RIGHT;
578 m_shootline = m_device
580 ->getSceneCollisionManager()
581 ->getRayFromScreenCoordinates(v2s32(m_key_events[0].x, m_key_events[0].y));
583 translated->MouseInput.Event = EMIE_RMOUSE_PRESSED_DOWN;
584 verbosestream << "TouchScreenGUI::translateEvent right click press" << std::endl;
585 m_receiver->OnEvent(*translated);
587 translated->MouseInput.ButtonStates = 0;
588 translated->MouseInput.Event = EMIE_RMOUSE_LEFT_UP;
589 verbosestream << "TouchScreenGUI::translateEvent right click release" << std::endl;
590 m_receiver->OnEvent(*translated);
596 TouchScreenGUI::~TouchScreenGUI()
598 for (unsigned int i=0; i < after_last_element_id; i++) {
599 button_info* btn = &m_buttons[i];
600 if (btn->guibutton != 0) {
601 btn->guibutton->drop();
602 btn->guibutton = NULL;
607 void TouchScreenGUI::step(float dtime)
609 /* simulate keyboard repeats */
610 for (unsigned int i=0; i < after_last_element_id; i++) {
611 button_info* btn = &m_buttons[i];
613 if (btn->ids.size() > 0) {
614 btn->repeatcounter += dtime;
616 if (btn->repeatcounter < 0.2) continue;
618 btn->repeatcounter = 0;
620 memset(&translated,0,sizeof(SEvent));
621 translated.EventType = irr::EET_KEY_INPUT_EVENT;
622 translated.KeyInput.Key = btn->keycode;
623 translated.KeyInput.PressedDown = false;
624 m_receiver->OnEvent(translated);
626 translated.KeyInput.PressedDown = true;
627 m_receiver->OnEvent(translated);
631 /* if a new placed pointer isn't moved for some time start digging */
632 if ((m_move_id != -1) &&
633 (!m_move_has_really_moved) &&
634 (!m_move_sent_as_mouse_event)) {
636 u32 delta = porting::getDeltaMs(m_move_downtime,getTimeMs());
638 if (delta > MIN_DIG_TIME_MS) {
639 m_shootline = m_device
641 ->getSceneCollisionManager()
642 ->getRayFromScreenCoordinates(
643 v2s32(m_move_downlocation.X,m_move_downlocation.Y));
646 memset(&translated,0,sizeof(SEvent));
647 translated.EventType = EET_MOUSE_INPUT_EVENT;
648 translated.MouseInput.X = m_move_downlocation.X;
649 translated.MouseInput.Y = m_move_downlocation.Y;
650 translated.MouseInput.Shift = false;
651 translated.MouseInput.Control = false;
652 translated.MouseInput.ButtonStates = EMBSM_LEFT;
653 translated.MouseInput.Event = EMIE_LMOUSE_PRESSED_DOWN;
654 verbosestream << "TouchScreenGUI::step left click press" << std::endl;
655 m_receiver->OnEvent(translated);
656 m_move_sent_as_mouse_event = true;
661 void TouchScreenGUI::resetHud()
666 void TouchScreenGUI::registerHudItem(int index, const rect<s32> &rect)
668 m_hud_rects[index] = rect;
671 void TouchScreenGUI::Toggle(bool visible)
674 for (unsigned int i=0; i < after_last_element_id; i++) {
675 button_info* btn = &m_buttons[i];
676 if (btn->guibutton != 0) {
677 btn->guibutton->setVisible(visible);
682 void TouchScreenGUI::Hide()
687 void TouchScreenGUI::Show()