ryzom/client/src/input.cpp

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010-2019  Winch Gate Property Limited
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2010  Robert TIMM (rti) <mail@rtti.de>
   6 // Copyright (C) 2013  Laszlo KIS-ADAM (dfighter) <dfighter1985@gmail.com>
   7 // Copyright (C) 2014  Jan BOON (Kaetemi) <jan.boon@kaetemi.be>
   8 //
   9 // This program is free software: you can redistribute it and/or modify
  10 // it under the terms of the GNU Affero General Public License as
  11 // published by the Free Software Foundation, either version 3 of the
  12 // License, or (at your option) any later version.
  13 //
  14 // This program is distributed in the hope that it will be useful,
  15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 // GNU Affero General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU Affero General Public License
  20 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21
  22
  23
  24 /////////////
  25 // INCLUDE //
  26 /////////////
  27 #include "stdpch.h"
  28 // Client
  29 #include "global.h"
  30 #include "actions.h"
  31 #include "input.h"
  32 #include "interface_v3/interface_manager.h"
  33 #include "interface_v3/input_handler_manager.h"
  34 #include "client_cfg.h"
  35 #include "time_client.h"
  36 // 3D
  37 #include "nel/3d/u_driver.h"
  38 // Misc
  39 #include "nel/misc/mouse_smoother.h"
  40 #include "nel/misc/system_utils.h"
  41 // Game Share
  42
  43
  44 ///////////
  45 // USING //
  46 ///////////
  47 using namespace NL3D;
  48 using namespace NLMISC;
  49
  50
  51 ////////////
  52 // EXTERN //
  53 ////////////
  54 extern UDriver                                  *Driver;
  55 extern UMaterial                                GenericMat;
  56 extern CActionsManager                  Actions;                // Actions Manager.
  57
  58
  59 ////////////
  60 // GLOBAL //
  61 ////////////
  62 bool                                                    MouseHardware = false;
  63 bool                                                    MouseFreeLook = false;
  64 float                                                   MouseCursorSpeed = 1.f;
  65 uint                                                    MouseCursorAcceleration = 0;
  66 bool                                                    InitMouseFirstTime = true;
  67 bool                                                    SetMousePosFirstTime = true;
  68
  69 // mask for mouse buttons that are known to be down
  70 uint                                                    DownMouseButtons = 0;
  71
  72 //////////////
  73 // FUNCTION //
  74 //////////////
  75
  76 // *********************************************************************************
  77 uint GetMouseButtonsState()
  78 {
  79         return DownMouseButtons;
  80 }
  81
  82 // *********************************************************************************
  83 // Initialize the mouse
  84 bool    InitMouseWithCursor (bool hardware)
  85 {
  86         Driver->showCursor(false);
  87
  88         // Get the new mouse state
  89         MouseHardware = hardware;
  90         CViewPointer::setHWMouse( hardware );
  91
  92         if (InitMouseFirstTime)
  93         {
  94                 InitMouseFirstTime = false;
  95         }
  96         else
  97         {
  98                 if (!MouseFreeLook)
  99                 {
 100                         // Get the current mouse position
 101                         CInterfaceManager *pIm = CInterfaceManager::getInstance();
 102                         CViewPointer *vp = static_cast< CViewPointer* >( CWidgetManager::getInstance()->getPointer() );
 103                         Driver->showCursor(hardware);
 104                         if (vp)
 105                         {
 106                                 float x = (float) vp->getX();
 107                                 float y = (float) vp->getY();
 108                                 // First, hide the hardware mouse
 109                                 uint width = Driver->getWindowWidth();
 110                                 uint height = Driver->getWindowHeight();
 111                                 if (SetMousePosFirstTime)
 112                                 {
 113                                         SetMousePosFirstTime = false;
 114                                 }
 115                                 else if (width != 0 && height != 0)
 116                                 {
 117                                         nlwarning("Mouse pos %f, %f", x, y);
 118                                         Driver->setMousePos(x / width, y / height);
 119                                 }
 120                         }
 121                 }
 122         }
 123
 124         return true;
 125 }
 126
 127 // *********************************************************************************
 128 // Is mouse cursor hardware ?
 129 bool    IsMouseCursorHardware ()
 130 {
 131         return MouseHardware;
 132 }
 133
 134 // *********************************************************************************
 135 // Use this method to toggle the mouse (freelook <- cursor)
 136 void    SetMouseFreeLook ()
 137 {
 138         if (!MouseFreeLook)
 139         {
 140                 MouseFreeLook = true;
 141                 if (MouseHardware)
 142                 {
 143                         Driver->showCursor(false);
 144                 }
 145                 else
 146                 {
 147                         CInterfaceManager *im = CInterfaceManager::getInstance();
 148                         if (im)
 149                         {
 150                                 CViewPointer *pointer = static_cast< CViewPointer* >( CWidgetManager::getInstance()->getPointer() );
 151                                 if (pointer)
 152                                         pointer->show (false);
 153                         }
 154                 }
 155         }
 156 }
 157
 158 // *********************************************************************************
 159 bool IsMouseFreeLook()
 160 {
 161         return MouseFreeLook;
 162 }
 163
 164 // *********************************************************************************
 165 // Use this method to toggle the mouse (freelook -> cursor)
 166 void    SetMouseCursor (bool updatePos)
 167 {
 168         if (MouseFreeLook)
 169         {
 170                 // Get the last cursor
 171                 float x = 0.5f, y = 0.5f;
 172
 173                 // Screen size
 174                 uint width, height;
 175                 CViewRenderer::getInstance()->getScreenSize(width, height);
 176
 177                 // Update the interface pointer
 178                 CInterfaceManager *instance = CInterfaceManager::getInstance();
 179                 if (instance)
 180                 {
 181                         // Get the cursor instance
 182                         CViewPointer *cursor = static_cast< CViewPointer* >( CWidgetManager::getInstance()->getPointer() );
 183                         if (cursor)
 184                         {
 185                                 sint32 ix, iy;
 186                                 cursor->getPointerPos (ix, iy);
 187                                 if (ix != CViewPointer::InvalidCoord && iy != CViewPointer::InvalidCoord)
 188                                 {
 189                                         x = (float)ix / (float)width;
 190                                         y = (float)iy / (float)height;
 191                                 }
 192                         }
 193                 }
 194
 195                 MouseFreeLook = false;
 196
 197                 // Integer coordinates
 198                 sint ix = (sint)(x*(float)width+0.5f);
 199                 sint iy = (sint)(y*(float)height+0.5f);
 200
 201                 if (updatePos)
 202                 {
 203                         Driver->setMousePos(x, y);
 204                 }
 205
 206                 // Update the interface pointer
 207                 if (instance)
 208                 {
 209                         // Get the cursor instance
 210                         CViewPointer *cursor = static_cast< CViewPointer* >( CWidgetManager::getInstance()->getPointer() );
 211                         if (cursor)
 212                         {
 213                                 cursor->setPointerPos(ix, iy);
 214                                 cursor->setPointerDispPos(ix, iy);
 215                         }
 216                 }
 217                 CInputHandlerManager *IHM = CInputHandlerManager::getInstance ();
 218                 if (IHM)
 219                 {
 220                         IHM->resetPos (ix, iy);
 221                 }
 222
 223                 // Show the cursor
 224                 if (MouseHardware)
 225                 {
 226                         Driver->showCursor(true);
 227                 }
 228                 else
 229                 {
 230                         CInterfaceManager *im = CInterfaceManager::getInstance();
 231                         if (im)
 232                         {
 233                                 CViewPointer *pointer = static_cast< CViewPointer* >( CWidgetManager::getInstance()->getPointer() );
 234                                 if (pointer)
 235                                         pointer->show (true);
 236                         }
 237                 }
 238         }
 239 }
 240
 241 // *********************************************************************************
 242 // Use this method to set the cursor speed
 243 void    SetMouseSpeed (float speed)
 244 {
 245         MouseCursorSpeed = speed;
 246 }
 247
 248 // *********************************************************************************
 249 // Use this method to set the cursor acceleration
 250 void    SetMouseAcceleration (uint accel)
 251 {
 252         MouseCursorAcceleration = accel;
 253 }
 254
 255 // *********************************************************************************
 256 void HandleSystemCursorCapture(const CEvent &event)
 257 {
 258         static bool mouseCaptured = false;
 259
 260         // capture on first move event after button is held down or free look is activated
 261         if (event == EventMouseMoveId && !mouseCaptured && (MouseFreeLook || DownMouseButtons != 0))
 262         {
 263                 mouseCaptured = true;
 264                 Driver->setCapture(true);
 265         }
 266
 267         // release when button is released and not in free look
 268         if (mouseCaptured && !MouseFreeLook && DownMouseButtons == 0)
 269         {
 270                 mouseCaptured = false;
 271                 Driver->setCapture(false);
 272         }
 273
 274         if (event == EventMouseDownId)
 275         {
 276                 CEventMouseDown &em = (CEventMouseDown &) event;
 277                 DownMouseButtons |= em.Button & (leftButton | middleButton | rightButton);
 278
 279                 CViewPointer *cursor = static_cast< CViewPointer* >( CWidgetManager::getInstance()->getPointer() );
 280                 if (cursor)
 281                 {
 282                                 cursor->setPointerDown(em.Button == leftButton);
 283                                 cursor->setPointerMiddleDown(em.Button == middleButton);
 284                                 cursor->setPointerRightDown(em.Button == rightButton);
 285                 }
 286         }
 287
 288         if (event == EventMouseUpId)
 289         {
 290                 // if all buttons up
 291                 CEventMouseDown &em = (CEventMouseDown &) event;
 292                 DownMouseButtons &= ~(em.Button & (leftButton | middleButton | rightButton));
 293                 if (DownMouseButtons == 0)
 294                 {
 295                         CViewPointer *cursor = static_cast< CViewPointer* >( CWidgetManager::getInstance()->getPointer() );
 296                         if (cursor)
 297                         {
 298                                 cursor->setPointerDown(false);
 299                                 cursor->setPointerMiddleDown(false);
 300                                 cursor->setPointerRightDown(false);
 301                         }
 302                 }
 303         }
 304
 305         // if focus was lost then says that all buttons are up from this app viewpoint
 306         if (event == EventSetFocusId)
 307         {
 308                 DownMouseButtons = 0;
 309         }
 310 }
 311
 312 sint CNiceInputAuto::_Count = 0;
 313
 314
 315 CNiceInputAuto::CNiceInputAuto()
 316 {
 317         if (_Count == 0)
 318         {
 319                 Driver->setCursor("curs_default.tga", CRGBA::White, 0, 0x15, 0x18);
 320                 Driver->showCursor(true); // keep cursor visible in windowed mode
 321         }
 322         ++_Count;
 323 }
 324
 325 CNiceInputAuto::~CNiceInputAuto()
 326 {
 327         --_Count;
 328         nlassert(_Count >= 0);
 329         if (_Count == 0)
 330         {
 331                 InitMouseWithCursor(ClientCfg.HardwareCursor && !StereoDisplayAttached);
 332         }
 333 }