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

Timestamp:

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

Author:

tkuonen

Message:

Improve MouseAPI
Add Comments
Cleanup

File:

• code/branches/MouseAPI_FS19/src/modules/MouseAPI/mouseapicursor.h (modified) (3 diffs)

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