main.cpp comments updated

main/main.cpp

@@ -1,8 +1,8 @@
 
 #include <iostream>
 #include <Fl/Fl.H>
-#include <FL/Fl_Box.H>
+#include <Fl/Fl_Box.H>
-#include <FL/Fl_Timer.H>
+#include <Fl/Fl_Output.H>
 #include <FL/Fl_Window.H>
 #include <FL/fl_draw.H>
 
@@ -10,130 +10,185 @@
 #define window_height 600
 #define window_width 800
 
-/**************************************[[l***************************************/
+//Statusbar**************************************/
-/* This class provides a view to copy the offscreen surface to */
-
-//Pixel ist ein neue Class fuer ein Pixel
-class Pixel : public Fl_Widget {
-    Fl_Color color;
-    //Pixel zu malen, x,y sind fuer die Postion in Window.w,h ist width und height.color ist die Farbe von Pixel
-    void draw() {
-        fl_draw_box(FL_FLAT_BOX, x(), y(), w(), h(), color);
-    }
 
+/** The class inherits a char *text from the Fl_Box. It also shows the window-resolution and the mouse-position.
+ * @param text: A pointer to a char-array, that can contain a text like a status or whatever you want.
+ * @parameter x: The mouse-position on the x-axis.
+ * @parameter y: The mouse-position on the y-axis:
+ * @parameter w: The width of a single pixel,
+ * @parameter h: The height of a single pixel.
+ */
+class Statusbar: public Fl_Box {
+    char *text;
 public:
-    //Konstruktor
+    /** The constructor of Statusbar has to get additional parameters.
-    Pixel(int x, int y, int w, int h) :
+      * @param x: The mouse-position on the x-axis.
-            Fl_Widget(x, y, w, h, 0) {}
+      * @param y: The mouse-position on the y-axis:
-    //die Farbe von Pixel einstellen
+      * @param w: The width of a single pixel,
-    void set_color(int RGB){
+      * @param h: The height of a single pixel.
-        this->color = fl_rgb_color((uchar) ((RGB & 0xff000000) >> 24), (uchar) ((RGB & 0xff0000) >> 16),
+      */
-                                   (uchar) ((RGB & 0xff00) >> 8));
+    Statusbar(int x, int y, int w, int h, char *text) :
+            Fl_Box(x, y, w, h,text) {
+        this->text = text;
+    };
+    void set_text(char *text) {
+        this->text = text;
+    }
+    //An exampel to show, how the content of the text can be changed.
+    void change_text(){
+        if(text=="status0")
+            set_text("status1");
+        else
+            set_text("status0");
+    }
+    //This function refreshes the statusbar
+    void refresh_label(){
+        this->label(text);
     }
 };
 
+//Image**************************************/
+/** The Image-class draws the bitmap that it get from the Shared Memory.
+ * @param *buf: A pointer to the bitmap, that the image-class has to draw. Three chars are needed to get the RGB-value of a pixel, so the size equals window_height * window_width * 3.
+ */
 
+class Image : public Fl_Widget {
+    uchar *buf;
+
+    //Function to draw a bitmap
+    void draw() {
+        fl_draw_image(buf, x(), y(), w(), h());
+    }
+    /** The constructor of the image class, get additional
+    * @param x: The mouse-position on the x-axis.
+    * @param y: The mouse-position on the y-axis:
+    * @param w: The width of a single pixel,
+    * @param h: The height of a single pixel.
+     */
+
+public:
+    /*Constructor*/
+    Image(int x, int y, int w, int h) :
+            Fl_Widget(x, y, w, h, 0) {
+        buf = new uchar[w * h * 3];
+        /*Just an example.*/
+        for (int i = 0; i < h; i++) {
+            for (int j = 0; j < w; j++) {
+                buf[(j + (i * w)) * 3 + 1] = 0xff;
+            }
+        }
+    }
+/*A function to change the colors of the image-class. The colors are changing in this order: green, blue, red*/
+    void change_color() {
+        for (int j = 1; j < w() * h() * 3; j++) {
+            if (buf[j] == 0xff) {
+                buf[j] = 0;
+                buf[j - 1] = 0xff;
+            }
+        }
+        if (buf[2] == 0xff)
+            buf[w() * h() * 3 - 1] = 0xff;
+    }
+};
+
+//My_Window*************************************/
+/** The My_Windows-class generates a window, within the window it recognizes the curretn mouse-position.
+ * It also recognizes if a button is pushed on the keyboard or the mouse. Furthermore the class depict the
+ * content of the Image-class and provides functions to refresh it.
+ * @parame x The mouse-position on the x-axis.
+ * @parame y The mouse-position on the y-axis.
+ * @parame button The button that was pushed last.
+ */
 class My_Window : public Fl_Window {
     int x, y, button;
-    int (*color_map)[window_width][window_height];
+
-    Pixel* pixels[window_width][window_height];
+    /*Function to handle the input*/
-    int c=0xff000000;
-    //die Inputs von Maus und Tastatur behandln
     int handle(int e) {
         switch (e) {
-            //Druck vom Maus behandln
+            /*Mousebutton*/
             case FL_PUSH:
-                if(Fl::event_button()==FL_LEFT_MOUSE){
+                if (Fl::event_button() == FL_LEFT_MOUSE) {
                     std::cout << "Mouse:left" << std::endl;
-                }else if(Fl::event_button()==FL_RIGHT_MOUSE){
+                } else if (Fl::event_button() == FL_RIGHT_MOUSE) {
                     std::cout << "Mouse:right" << std::endl;
-                }else{
+                } else {
                     std::cout << "Mouse:middle" << std::endl;
                 }
                 return 1;
-            //Druck und Bewegung vom Maus behandln
+                /*Mousebutton and movement*/
             case FL_DRAG:
                 x = Fl::event_x();
                 y = Fl::event_y();
                 std::cout << "Postion X:" << x << " Postion Y:" << y << std::endl;
-                if(Fl::event_button()==FL_LEFT_MOUSE){
+                if (Fl::event_button() == FL_LEFT_MOUSE) {
                     std::cout << "Mouse:left" << std::endl;
-                }else if(Fl::event_button()==FL_RIGHT_MOUSE){
+                } else if (Fl::event_button() == FL_RIGHT_MOUSE) {
                     std::cout << "Mouse:right" << std::endl;
-                }else{
+                } else {
                     std::cout << "Mouse:middle" << std::endl;
                 }
                 return 1;
-            //Bewegung vom Maus behandln
+                /*Mousemovement*/
             case FL_MOVE:
                 x = Fl::event_x();
                 y = Fl::event_y();
                 std::cout << "Postion X:" << x << " Postion Y:" << y << std::endl;
                 return 1;
-            //Druck von der Tastator behandln
+                /*keyboardbutton*/
             case FL_KEYBOARD:
                 button = Fl::event_button();
                 std::cout << "Keyboard:" << (unsigned short) button << std::endl;
                 return 1;
-           // case FL_:
         }
 
     }
 
 public:
-    //Konstruktor
+    /*Constructor*/
-    My_Window(int x, int y, const char *l, int (*color_map)[window_width][window_height]) : Fl_Window(x, y, l) {
+    My_Window(int x, int y, const char *l) : Fl_Window(x, y, l) {}
-        this->color_map = color_map;
-        for (int i = 0; i < window_width; i++) {
-            for (int j = 0; j < window_height; j++) {
-                pixels[i][j]=new Pixel(i,j,1,1);
-            }
-        }
-    }
-    //Window akualisieren, refresh
-    int draw_bild() {
-        for (int i = 0; i < window_width; i++) {
-            for (int j = 0; j < window_height; j++) {
-                pixels[i][j]->set_color((*color_map)[i][j]);
-                pixels[i][j]->redraw();
-            }
-        }
-    }
 };
 
-//draw_bild() wird regelmaessig anrufen
+/*Functions to refresh the image.*/
-void refresh(void* pointer){
+void refresh_image(void *pointer) {
-    ((My_Window*)pointer)->draw_bild();
+    ((Image *) pointer)->redraw();
-    Fl::repeat_timeout(0.5, refresh,pointer);
+    Fl::repeat_timeout(0.5, refresh_image, pointer);//nach 0.5 sec refresh_bild(pointer) anrufen. Here pointer ist wie ein Parameter
-}
-//die Farbe von Pixels regekmaessig aendern
-void change_color(void* pointer){
-    int (*color_map)[window_width][window_height];
-    color_map = (typeof(color_map))(pointer);
-    for (int i = 0; i < 100; i++) {
-        for (int j = 0; j < 100; j++) {
-            (*color_map)[i][j] ^= 0xffff0000;
-        }
-    }
-
-    Fl::repeat_timeout(1, change_color,pointer);
 }
 
+void change_color(void *pointer) {
+    ((Image *) pointer)->change_color();
+    Fl::repeat_timeout(1, change_color, pointer);
+}
+
+void refresh_statusbar(void *pointer) {
+    ((Statusbar **) pointer)[0]->refresh_label();
+    Fl::repeat_timeout(0.5, refresh_statusbar, pointer);
+}
+
+void change_status(void *pointer) {
+    ((Status_Leiste **) pointer)[0]->change_text();
+    Fl::repeat_timeout(1, change_status, pointer);
+}
+
+//main*************************************/
+/**
+ * The main function initializes all needed classes and executes the functions.
+ */
 int main(int argc, char **argv) {
-
+    My_Window *window = new My_Window(window_width, window_height, "example");
-    int color_map[window_width][window_height];
+    Status_Leiste *status[5];
-
-    for (int i = 0; i < 100; i++) {
-        for (int j = 0; j < 100; j++) {
-            color_map[i][j] = 0xff000000;
-        }
-    }
-    My_Window *window = new My_Window(window_width, window_height, "example", &color_map);
     window->begin();
-    Fl::repeat_timeout(0.5, refresh,window);//refresh anrufen nach 0.5 sec
+    Bild *bild = new Bild(0, 30, window_width, window_height - 30);
-    Fl::repeat_timeout(1,change_color, &color_map);// change_color anrufen nach 1 sec
+    status[0] = new Status_Leiste(0, 0, 60, 30, "status0");
-
+    status[1] = new Status_Leiste(60, 0, 60, 30, "status1");
+    status[2] = new Status_Leiste(120, 0, 60, 30, "status2");
+    status[3] = new Status_Leiste(180, 0, 60, 30, "status3");
+    status[4] = new Status_Leiste(240, 0, 60, 30, "status4");
+    Fl::repeat_timeout(0.5, refresh_bild, bild);
+    Fl::repeat_timeout(1, change_color, bild);
+    Fl::repeat_timeout(0.5, refresh_status_leiste, status);
+    Fl::repeat_timeout(1, change_status, status);
     window->end();
     window->show(argc, argv);
     return Fl::run();
-} // main
+}main