ryzom/client/src/input.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (at your option) any later version.
   8 //
   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 Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18
  19
  20 #ifndef CL_INPUT_H
  21 #define CL_INPUT_H
  22
  23
  24 namespace NLMISC
  25 {
  26         class CEvent;
  27 }
  28
  29 /////////////
  30 // INCLUDE //
  31 /////////////
  32 // Misc
  33
  34
  35 const double FREE_LOOK_ANGLE_TO_MICKEYS = 5000;
  36
  37 //////////////
  38 // FUNCTION //
  39 //////////////
  40
  41 // Initialize the mouse
  42 bool    InitMouseWithCursor (bool hardware);
  43
  44 // Is mouse cursor hardware ?
  45 bool    IsMouseCursorHardware ();
  46
  47 // Use this method to toggle the mouse (freelook <- cursor)
  48 void    SetMouseFreeLook ();
  49
  50 // test if free look mode
  51 bool    IsMouseFreeLook();
  52
  53 // Use this method to toggle the mouse (freelook -> cursor)
  54 void    SetMouseCursor (bool updatePos = true);
  55
  56 // Use this method to set the cursor speed
  57 void    SetMouseSpeed (float speed);
  58
  59 // Use this method to set the cursor acceleration
  60 void    SetMouseAcceleration (uint accel);
  61
  62 // handle capturing of mouse on button up / button down
  63 void HandleSystemCursorCapture(const NLMISC::CEvent &event);
  64
  65 // get state of mouse button, as a bitfield formatted like NLMISC::TMouseButton (modifier keys are not included)
  66 uint GetMouseButtonsState();
  67
  68 // 'nice' the inputs : disable direct input in ctor, then re-enable if needed in dtor
  69 // useful for non-blocking loading.
  70 // NB : CNiceInputAuto maintains an internal counter, so sevral nested CNiceInputAuto's will remain nice
  71 class CNiceInputAuto
  72 {
  73 public:
  74         CNiceInputAuto();
  75         ~CNiceInputAuto();
  76 private:
  77         static sint _Count;
  78 };
  79
  80 #endif // CL_INPUT_H
  81
  82 /* End of misc.h */
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103