Changeset 12377

Timestamp:

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

Author:

tkuonen

Message:

Improve MouseAPI
Add Comments
Cleanup

Location:

code/branches/MouseAPI_FS19

Files:

• data/gui/layouts/MouseAPICursor.layout (deleted)
• data/gui/scripts/MouseAPICursor.lua (deleted)
• data/levels/MouseAPIExample.oxw (modified) (3 diffs)
• data/overlays/MouseCursor.oxo (modified) (1 diff)
• src/modules/MouseAPI/mouseapi.cc (modified) (8 diffs)
• src/modules/MouseAPI/mouseapi.h (modified) (5 diffs)
• src/modules/MouseAPI/mouseapicursor.cc (modified) (3 diffs)
• src/modules/MouseAPI/mouseapicursor.h (modified) (3 diffs)
• src/modules/MouseAPI/mousegametype.cc (modified) (3 diffs)
• src/modules/MouseAPI/mousegametype.h (modified) (1 diff)
• src/modules/MouseAPIExample/mouseapiexample.h (modified) (1 diff)

code/branches/MouseAPI_FS19/data/levels/MouseAPIExample.oxw

@@ -10 +10 @@
   include("HUDTemplates3.oxo")
   include("MouseCursor.oxo")
-  include("tetrisHUD.oxo")
   include("templates/lodInformation.oxt")
-?>
-
-<?lua
-  include("templates/spaceshipEscort.oxt")
 ?>
 
@@ -23 +18 @@
     <Template link=lodtemplate_default />
   </templates>
+  <!--<?lua include("includes/notifications.oxi") ?>-->
 
   <Scene
@@ -51 +47 @@
 </MouseAPIExample>
 
-<!--<MouseAPICursor></MouseAPICursor>
-<MouseCursor></MouseCursor>-->
   </Scene>
 </Level>

code/branches/MouseAPI_FS19/data/overlays/MouseCursor.oxo

@@ -1 +1 @@
 <Template name="MouseCursor">
 <OverlayGroup name = "MouseCursorGroup" scale = "1, 1">
-    <MouseAPICursor name="cursor" position = "0, 0" size="0.03, 0.03" cursorShape="cursor.png"></MouseAPICursor>
+    <MouseAPICursor name="cursor" position = "0, 0" size="0.03, 0.03" cursorShape="cursor.png" cursorColor="1,0,1"></MouseAPICursor>
 </OverlayGroup>
 </Template>

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

@@ -1 +1 @@
 #include "mouseapi.h"
-
-#if OGRE_VERSION >= 0x010900
-#   include <Overlay/OgreOverlayManager.h>
-#   include <Overlay/OgrePanelOverlayElement.h>
-#else
-#   include <OgreOverlayManager.h>
-#   include <OgrePanelOverlayElement.h>
-#endif
-
-#include "util/StringUtils.h"
 
 namespace orxonox{
@@ -27 +17 @@
         if(InputManager::exists())
         {
-            //cam = CameraManager::getInstance().getActiveCamera()->getOgreCamera();
             state = InputManager::getInstance().createInputState("MouseAPI",true,true,99);
             state->setMouseExclusive(false);//does this work
             state->setMouseHandler(this);
+            gameInputActivated = false;
             state->setKeyHandler(KeyBinderManager::getInstance().getDefaultAsHandler());
             InputManager::getInstance().enterState("guiMouseOnly");
             InputManager::getInstance().enterState("MouseAPI");
             InputManager::getInstance().setMouseExclusive("game",false);
-            //InputManager::getInstance().setMouseExclusive("guiMouseOnly",false);
-            //InputManager::getInstance().getState("game")->
-        }
-        //GUIManager::getInstance().showGUI("MouseAPICursor", true);//Display a mouse cursor by displaying a empty menu
-        /*cursor = static_cast<Ogre::PanelOverlayElement*>(Ogre::OverlayManager::getSingleton()
-                                                               .createOverlayElement("Panel", "MouseAPI_cursor_" + getUniqueNumberString()));
-        cursor->setMaterialName("Orxonox/RadarMarker");//todo: better material
-        cursor->setPosition(0,0);
-        cursor->setDimensions(0.1,0.1);
-        Ogre::Overlay* overlay = Ogre::OverlayManager::getSingleton().create( "MouseAPI_cursor_" + getUniqueNumberString() );
-        overlay->show();*/
-        //this->overlay_->add2D(this->cursor);
+        }
     }
 
@@ -55 +34 @@
     if(active)
     {
-        GUIManager::getInstance().showGUI("MouseAPICursor", true);
         active = false;
         if(InputManager::exists())
@@ -66 +44 @@
         clickEvents.clear();
         scrollEvents.clear();
+        gameInputActivated=false;
     }
 }
@@ -76 +55 @@
 void MouseAPI::buttonPressed(MouseButtonCode::ByEnum button)
 {
-    cam = CameraManager::getInstance().getActiveCamera()->getOgreCamera();//todo: trycatch
+    cam = CameraManager::getInstance().getActiveCamera()->getOgreCamera();
     Ogre::Viewport *vp = GraphicsManager::getInstance().getViewport();
     int mouseposX = InputManager::getInstance().getMousePosition().first;
@@ -94 +73 @@
 void MouseAPI::mouseMoved(IntVector2 abs, IntVector2 rel, IntVector2 clippingSize)
 {
-    //mousePos = abs;
 }
 
 void MouseAPI::tick(float dt)
 {
-    if(active)
-    {
-        InputManager::getInstance().leaveState("game");//hack: todo: crate 2nd input state with prioritz 98 for cegui(cursor)
-        //GUIManager::getInstance().showGUI("MouseAPICursor", false);//hack todo: only if gui not shown & evt better if not in mouse mooved
+    if(active && !gameInputActivated)
+    {
+        InputManager::getInstance().leaveState("game");
     }
 
@@ -239 +216 @@
 }
 
-//returns relative Position of the Mouse
 Vector2 MouseAPI::getMousePosition()
 {
@@ -246 +222 @@
 }
 
-}
+void MouseAPI::activateGameInput()
+{
+    gameInputActivated = true;
+    state->setKeyHandler(nullptr);
+}
+
+void MouseAPI::deactivateGameInput()
+{
+    gameInputActivated = false;
+    state->setKeyHandler(KeyBinderManager::getInstance().getDefaultAsHandler());
+}
+
+}

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();
 };
 }

code/branches/MouseAPI_FS19/src/modules/MouseAPI/mouseapicursor.cc

@@ -10 +10 @@
     cursor = static_cast<Ogre::PanelOverlayElement*>(Ogre::OverlayManager::getSingleton()
                                                           .createOverlayElement("Panel", "MouseAPI_cursor_" + getUniqueNumberString()));
-    cursor->setMaterialName(TextureGenerator::getMaterialName(
-                                      cursorname, Ogre::ColourValue::White));
-
+    updateCursor();
     overlay_->add2D(this->cursor);
     scale(Vector2(0.03,0.03));
@@ -22 +20 @@
     if(running)
         MouseAPI::getInstance().deactivate();
+    if(this->isInitialized())
+        Ogre::OverlayManager::getSingleton().destroyOverlayElement(this->cursor);
 }
 
@@ -30 +30 @@
     SUPER(MouseAPICursor, XMLPort, xmlelement, mode);
     XMLPortParam(MouseAPICursor, "cursorShape", setCursorName, getCursorName,xmlelement, mode);
-    //XMLPortParam(MouseAPICursor, "cursorColor", setCursorColor, getCursorColor,xmlelement, mode);//TODO: ColoValue::setAsARGB()
+    XMLPortParam(MouseAPICursor, "cursorColor", setCursorColor, getCursorColor,xmlelement, mode);
 }
 

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

@@ -2 +2 @@
 #define MOUSEAPICURSOR_H
 #include <overlays/OrxonoxOverlay.h>
-#include "core/CoreIncludes.h"
-#include "tools/interfaces/Tickable.h"
-#include "overlays/OverlayGroup.h"
+#include <core/CoreIncludes.h>
+#include <tools/interfaces/Tickable.h>
 #include "mouseapi.h"
-#include "core/XMLPort.h"
-
+#include <core/XMLPort.h>
 
 #if OGRE_VERSION >= 0x010900
@@ -17 +15 @@
 #endif
 
-#include "tools/TextureGenerator.h"
-#include "util/StringUtils.h"
+#include <tools/TextureGenerator.h>
+#include <util/StringUtils.h>
 
 namespace orxonox{
@@ -25 +23 @@
 {
 private:
+    //Pointer to the cursor overlay
     Ogre::PanelOverlayElement* cursor;
+    //Is Cursor activated?
     bool running = false;
+    //Name of the image-file used as the cursor shape
     std::string cursorname = "cursor.png";
+    //Color of the cursor
+    Vector3 color = {1,1,1};
 public:
     MouseAPICursor(Context* context);
     ~MouseAPICursor();
+    //Update cursor position
     virtual void tick(float dt) override;
+    //XMLPort: ability to set cursor shape & color
     virtual void XMLPort(ticpp::Element &xmlelement, XMLPort::Mode mode) override;
+    //Update cursol look (shape & color)
+    inline void updateCursor(){
+        cursor->setMaterialName(TextureGenerator::getMaterialName(
+                                                      cursorname, Ogre::ColourValue(color[0],color[1],color[2],1)));
+    }
     inline void setCursorName(const std::string& name)
     {
         cursorname = name;
-        cursor->setMaterialName(TextureGenerator::getMaterialName(
-                                                      cursorname, Ogre::ColourValue::White));
+        updateCursor();
     }
     inline std::string getCursorName(void) const
     {
         return cursorname;
+    }
+    inline void setCursorColor(const Vector3& cl)
+    {
+        color = cl;
+        updateCursor();
+    }
+    inline Vector3 getCursorColor(void) const
+    {
+        return color;
     }
 

code/branches/MouseAPI_FS19/src/modules/MouseAPI/mousegametype.cc

@@ -8 +8 @@
     player_ =nullptr;
 
+    //Activate the Mouse Cursor
     this->setHUDTemplate("MouseCursor");
 
@@ -14 +15 @@
 void MouseGametype::start()
 {
-    bool temp = this->bForceSpawn_;
-    this->bForceSpawn_ = true;
-
-    // Call start for the parent class.
     Gametype::start();
-
-    // Reset the variable.
-    this->bForceSpawn_ = temp;
-
 }
 
@@ -37 +30 @@
 {
     assert(player);
-
+    //Only Spawn once
     if(this->player_ == nullptr)
     {

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

@@ -1 +1 @@
 #ifndef MOUSEGAMETYPE_H
 #define MOUSEGAMETYPE_H
-#include "gametypes/Gametype.h"
-#include "core/CoreIncludes.h"
-#include "infos/PlayerInfo.h"
+#include <gametypes/Gametype.h>
+#include <core/CoreIncludes.h>
+#include <infos/PlayerInfo.h>
 #include <core/input/InputState.h>
-#include "core/GUIManager.h"
+#include <core/GUIManager.h>
 
 namespace orxonox

code/branches/MouseAPI_FS19/src/modules/MouseAPIExample/mouseapiexample.h

@@ -2 +2 @@
 #define MOUSEAPIEXAMPLE_H
 
-#include "core/XMLPort.h"
-#include "MouseAPI/mouseapi.h"
-#include "core/CoreIncludes.h"
-#include "worldentities/ControllableEntity.h"
+#include <core/XMLPort.h>
+#include <MouseAPI/mouseapi.h>
+#include <core/CoreIncludes.h>
+#include <worldentities/ControllableEntity.h>
 #include <list>