Changeset 12377 for code/branches/MouseAPI_FS19/src/modules/MouseAPI/mouseapi.h

Timestamp:

May 16, 2019, 2:27:40 PM (5 years ago)

Author:

tkuonen

Message:

Improve MouseAPI
Add Comments
Cleanup

File:

• code/branches/MouseAPI_FS19/src/modules/MouseAPI/mouseapi.h (modified) (5 diffs)

code/branches/MouseAPI_FS19/src/modules/MouseAPI/mouseapi.h

@@ -2 +2 @@
 #define MOUSEAPI_H
 
-#include "OrxonoxPrereqs.h"
-#include "util/OgreForwardRefs.h"
-#include "graphics/Camera.h"
+#include <OrxonoxPrereqs.h>
+#include <util/OgreForwardRefs.h>
+#include <graphics/Camera.h>
 #include <util/Math.h>
 #include <list>
@@ -13 +13 @@
 #include <OgreCamera.h>
 #include <OgreViewport.h>
-#include "CameraManager.h"
+#include <CameraManager.h>
 #include <functional>
-#include "core/GUIManager.h"
-#include "core/input/KeyBinderManager.h"
-#include "tools/interfaces/Tickable.h"
-#include "core/singleton/ScopedSingletonIncludes.h"
+#include <core/GUIManager.h>
+#include <core/input/KeyBinderManager.h>
+#include <tools/interfaces/Tickable.h>
+#include <core/singleton/ScopedSingletonIncludes.h>
 
 /* this class implements a basic mouse-api
@@ -35 +35 @@
  * to make it work, one has to add mouseapi in LINK_LIBRARIES in the file CMakeLists.txt of the level
  * see CMakeLists.txt in MouseAPIExample
+ *
+ * MouseAPI: C++ API to access Mouse
+ * MouseGametype: Enable Mouse Cursor & Prevent that each click kills Player if no spaceship is used
+ * MouseAPICursor: Internal API which implements cursor. Usable from custom Gametype (not necessary if MouseGametype is used):
+ *                 add "this->setHUDTemplate("MouseCursor");" in constructor of Gametype. (Or by inheritance)
  */
 
@@ -96 +101 @@
     bool active = false;
 
-    Ogre::PanelOverlayElement* cursor;
+    //true => allow ship-controller to get mouse input; Default: false; Gets reset after each transition from deactivated to activated
+    bool gameInputActivated = false;
+
 
 public:
@@ -240 +247 @@
      */
     void deactivate();
+
+    /*
+     * allow ship-controller to get mouse input
+     */
+    void activateGameInput();
+
+    /*
+     * do not allow ship-controller to get mouse input
+     * This is the default. This gets set after each transition from deactivated to activated
+     */
+    void deactivateGameInput();
 };
 }