Create menubar and more improvements

Author: mlsdpk

include/Game.h

@@ -36,9 +36,11 @@ class Game {
   void update();
   void render();
   void initGuiTheme();
-  void renderGui();
+  void renderMenuBar(ImGuiIO& io);
   void setGraphBasedPlanner(const int id);
   void setSamplingBasedPlanner(const int id);
+  void showHowToUseWindow();
+  void showAboutWindow();
 
  private:
   sf::RenderWindow* window_;
@@ -47,6 +49,10 @@ class Game {
   float dt_;
   std::stack<std::unique_ptr<State>> states_;
   std::string curr_planner_;
+  std::shared_ptr<LoggerPanel> logger_panel_;
+  bool disable_run_;
+  bool show_how_to_use_window_{false};
+  bool show_about_window_{false};
 };
 
 }  // namespace path_finding_visualizer

include/LoggerPanel.h

@@ -0,0 +1,76 @@
+#pragma once
+
+#include <imgui-SFML.h>
+#include <imgui.h>
+
+namespace path_finding_visualizer {
+
+class LoggerPanel {
+ public:
+  LoggerPanel() {
+    AutoScroll = true;
+    clear();
+  }
+
+  void clear() {
+    Buf.clear();
+    LineOffsets.clear();
+    LineOffsets.push_back(0);
+  }
+
+  void render(const char* title) {
+    if (!ImGui::Begin(title)) {
+      ImGui::End();
+      return;
+    }
+
+    ImGui::BeginChild("scrolling", ImVec2(0, 0), false,
+                      ImGuiWindowFlags_HorizontalScrollbar);
+
+    ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(0, 0));
+    const char* buf = Buf.begin();
+    const char* buf_end = Buf.end();
+    {
+      ImGuiListClipper clipper;
+      clipper.Begin(LineOffsets.Size);
+      while (clipper.Step()) {
+        for (int line_no = clipper.DisplayStart; line_no < clipper.DisplayEnd;
+             line_no++) {
+          const char* line_start = buf + LineOffsets[line_no];
+          const char* line_end = (line_no + 1 < LineOffsets.Size)
+                                     ? (buf + LineOffsets[line_no + 1] - 1)
+                                     : buf_end;
+          ImGui::TextUnformatted(line_start, line_end);
+        }
+      }
+      clipper.End();
+    }
+    ImGui::PopStyleVar();
+
+    if (AutoScroll && ImGui::GetScrollY() >= ImGui::GetScrollMaxY())
+      ImGui::SetScrollHereY(1.0f);
+
+    ImGui::EndChild();
+    ImGui::End();
+  }
+
+  void info(const std::string& msg) { AddLog("[INFO] %s\n", msg.c_str()); }
+
+ private:
+  ImGuiTextBuffer Buf;
+  ImVector<int> LineOffsets;  // Index to lines offset. We maintain this with
+                              // AddLog() calls.
+  bool AutoScroll;            // Keep scrolling if already at the bottom.
+
+  void AddLog(const char* fmt, ...) IM_FMTARGS(2) {
+    int old_size = Buf.size();
+    va_list args;
+    va_start(args, fmt);
+    Buf.appendfv(fmt, args);
+    va_end(args);
+    for (int new_size = Buf.size(); old_size < new_size; old_size++)
+      if (Buf[old_size] == '\n') LineOffsets.push_back(old_size + 1);
+  }
+};
+
+}  // namespace path_finding_visualizer

include/State.h

@@ -6,10 +6,13 @@
 #include <fstream>
 #include <iostream>
 #include <map>
+#include <memory>
 #include <stack>
 #include <string>
 #include <vector>
 
+#include "LoggerPanel.h"
+
 /*
   State Base Class
 */
@@ -20,21 +23,27 @@ class State {
  private:
  protected:
   std::stack<std::unique_ptr<State>> &states_;
-
   sf::RenderWindow *window_;
+  std::shared_ptr<LoggerPanel> logger_panel_;
   sf::Vector2i mousePositionWindow_;
   bool quit_;
+  bool is_reset_;
+  bool is_running_;
 
  public:
   // Constructor
-  State(sf::RenderWindow *window, std::stack<std::unique_ptr<State>> &states);
+  State(sf::RenderWindow *window, std::stack<std::unique_ptr<State>> &states,
+        std::shared_ptr<LoggerPanel> logger_panel);
 
   // Destructor
   virtual ~State();
 
   // Accessors
   const bool getQuit() const;
 
+  void setReset(bool is_reset) { is_reset_ = is_reset; }
+  void setRunning(bool is_running) { is_running_ = is_running; }
+
   // Functions
   virtual void checkForQuit();
   virtual void updateMousePosition();

include/States/Algorithms/GraphBased/ASTAR/ASTAR.h

@@ -21,7 +21,8 @@ struct MinimumDistanceASTAR {
 class ASTAR : public BFS {
  public:
   // Constructor
-  ASTAR(sf::RenderWindow *window, std::stack<std::unique_ptr<State>> &states);
+  ASTAR(sf::RenderWindow *window, std::stack<std::unique_ptr<State>> &states,
+        std::shared_ptr<LoggerPanel> logger_panel);
 
   // Destructor
   virtual ~ASTAR();

include/States/Algorithms/GraphBased/BFS/BFS.h

@@ -11,7 +11,8 @@ namespace graph_based {
 class BFS : public GraphBased {
  public:
   // Constructor
-  BFS(sf::RenderWindow *window, std::stack<std::unique_ptr<State>> &states);
+  BFS(sf::RenderWindow *window, std::stack<std::unique_ptr<State>> &states,
+      std::shared_ptr<LoggerPanel> logger_panel);
 
   // Destructor
   virtual ~BFS();

include/States/Algorithms/GraphBased/DFS/DFS.h

@@ -10,7 +10,8 @@ namespace graph_based {
 class DFS : public BFS {
  public:
   // Constructor
-  DFS(sf::RenderWindow *window, std::stack<std::unique_ptr<State>> &states);
+  DFS(sf::RenderWindow *window, std::stack<std::unique_ptr<State>> &states,
+      std::shared_ptr<LoggerPanel> logger_panel);
 
   // Destructor
   virtual ~DFS();

include/States/Algorithms/GraphBased/DIJKSTRA/DIJKSTRA.h

@@ -21,8 +21,8 @@ struct MinimumDistanceDIJKSTRA {
 class DIJKSTRA : public BFS {
  public:
   // Constructor
-  DIJKSTRA(sf::RenderWindow *window,
-           std::stack<std::unique_ptr<State>> &states);
+  DIJKSTRA(sf::RenderWindow *window, std::stack<std::unique_ptr<State>> &states,
+           std::shared_ptr<LoggerPanel> logger_panel);
 
   // Destructor
   virtual ~DIJKSTRA();

include/States/Algorithms/GraphBased/GraphBased.h

@@ -10,6 +10,7 @@
 #include <queue>
 #include <vector>
 
+#include "LoggerPanel.h"
 #include "MessageQueue.h"
 #include "State.h"
 #include "States/Algorithms/GraphBased/Node.h"
@@ -22,7 +23,8 @@ class GraphBased : public State {
  public:
   // Constructor
   GraphBased(sf::RenderWindow* window,
-             std::stack<std::unique_ptr<State>>& states);
+             std::stack<std::unique_ptr<State>>& states,
+             std::shared_ptr<LoggerPanel> logger_panel);
 
   // Destructor
   virtual ~GraphBased();
@@ -72,9 +74,7 @@ class GraphBased : public State {
   std::shared_ptr<MessageQueue<bool>> message_queue_;
 
   // logic flags
-  bool is_running_;
   bool is_initialized_;
-  bool is_reset_;
   bool is_solved_;
   bool disable_run_;
   bool disable_gui_parameters_;

include/States/Algorithms/SamplingBased/RRT/RRT.h

@@ -11,7 +11,8 @@ namespace sampling_based {
 class RRT : public SamplingBased {
  public:
   // Constructor
-  RRT(sf::RenderWindow *window, std::stack<std::unique_ptr<State>> &states);
+  RRT(sf::RenderWindow *window, std::stack<std::unique_ptr<State>> &states,
+      std::shared_ptr<LoggerPanel> logger_panel, const std::string &name);
 
   // Destructor
   virtual ~RRT();

include/States/Algorithms/SamplingBased/RRT_STAR/RRT_STAR.h

@@ -10,8 +10,8 @@ namespace sampling_based {
 class RRT_STAR : public RRT {
  public:
   // Constructor
-  RRT_STAR(sf::RenderWindow* window,
-           std::stack<std::unique_ptr<State>>& states);
+  RRT_STAR(sf::RenderWindow* window, std::stack<std::unique_ptr<State>>& states,
+           std::shared_ptr<LoggerPanel> logger_panel, const std::string& name);
 
   // Destructor
   virtual ~RRT_STAR();