updated code organization, started working on opengl 3d visualization

rxdu · Nov 2, 2024 · c39c283 · c39c283
1 parent 318a070
commit c39c283
Show file tree

Hide file tree

Showing 38 changed files with 277 additions and 47 deletions.
diff --git a/docs/opengl/opengl_coordinate_frames.png b/docs/opengl/opengl_coordinate_frames.png
diff --git a/docs/opengl/orthographic_projection.png b/docs/opengl/orthographic_projection.png
diff --git a/docs/opengl/perspective_projection.png b/docs/opengl/perspective_projection.png
diff --git a/src/app/panels/main_docking_panel.cpp b/src/app/panels/main_docking_panel.cpp
@@ -19,8 +19,8 @@ MainDockingPanel::MainDockingPanel(std::string name) : Panel(name) {
   this->SetNoTitleBar(true);
   this->SetNoBackground(true);
 
-  gl_scene_widget_.SetNoMove(true);
-  gl_scene_widget_.SetWindowNoTabBar();
+  gl_widget_.SetNoMove(true);
+  gl_widget_.SetWindowNoTabBar();
 }
 
 void MainDockingPanel::Draw() {
@@ -42,7 +42,7 @@ void MainDockingPanel::Draw() {
 
       ImGui::DockBuilderDockWindow(config_panel_.GetName().c_str(),
                                    config_panel_node_);
-      ImGui::DockBuilderDockWindow(gl_scene_widget_.GetName().c_str(),
+      ImGui::DockBuilderDockWindow(gl_widget_.GetName().c_str(),
                                    gl_scene_widget_node_);
       ImGui::DockBuilderDockWindow(console_panel_.GetName().c_str(),
                                    console_panel_node_);
@@ -57,7 +57,7 @@ void MainDockingPanel::Draw() {
   // draw child panels
   if (config_panel_.IsVisible()) config_panel_.Draw();
   if (console_panel_.IsVisible()) console_panel_.Draw();
-  if (gl_scene_widget_.IsVisible()) gl_scene_widget_.Draw();
+  if (gl_widget_.IsVisible()) gl_widget_.Draw();
 
   End();
 }

diff --git a/src/app/panels/main_docking_panel.hpp b/src/app/panels/main_docking_panel.hpp
@@ -27,7 +27,6 @@ class MainDockingPanel : public Panel {
   void ChangeDebugPanelVisibility(bool visible);
 
  private:
-
   bool layout_initialized_ = false;
   ImGuiID dockspace_id_;
 
@@ -37,7 +36,7 @@ class MainDockingPanel : public Panel {
 
   ConfigPanel config_panel_{"Config"};
   ConsolePanel console_panel_{"Console"};
-  GlSceneWidget gl_scene_widget_{"Scene"};
+  GlWidget gl_widget_{"Scene"};
 };
 }  // namespace quickviz
 

diff --git a/src/imview/CMakeLists.txt b/src/imview/CMakeLists.txt
@@ -37,12 +37,14 @@ add_library(imview
     src/component/shader.cpp
     src/component/shader_program.cpp
     src/component/frame_buffer.cpp
+    # opengl primitives
+    src/primitive/grid.cpp
     # data buffer
-    src/buffer/buffer_registry.cpp
-    src/buffer/scrolling_plot_buffer.cpp
+    src/component/buffer/buffer_registry.cpp
+    src/component/buffer/scrolling_plot_buffer.cpp
     # event handling
-    src/event/event_dispatcher.cpp
-    src/event/async_event_dispatcher.cpp
+    src/component/event/event_dispatcher.cpp
+    src/component/event/async_event_dispatcher.cpp
 )
 target_link_libraries(imview PUBLIC imcore
     PkgConfig::Cairo PkgConfig::Fontconfig

diff --git a/...nclude/imview/buffer/buffer_interface.hpp → ...iew/component/buffer/buffer_interface.hpp b/...nclude/imview/buffer/buffer_interface.hpp → ...iew/component/buffer/buffer_interface.hpp
diff --git a/...include/imview/buffer/buffer_registry.hpp → ...view/component/buffer/buffer_registry.hpp b/...include/imview/buffer/buffer_registry.hpp → ...view/component/buffer/buffer_registry.hpp
@@ -14,7 +14,7 @@
 #include <unordered_map>
 #include <stdexcept>
 
-#include "imview/buffer/buffer_interface.hpp"
+#include "imview/component/buffer/buffer_interface.hpp"
 
 namespace quickviz {
 class BufferRegistry {

diff --git a/...w/include/imview/buffer/double_buffer.hpp → ...imview/component/buffer/double_buffer.hpp b/...w/include/imview/buffer/double_buffer.hpp → ...imview/component/buffer/double_buffer.hpp
@@ -13,7 +13,7 @@
 #include <atomic>
 #include <condition_variable>
 
-#include "imview/buffer/buffer_interface.hpp"
+#include "imview/component/buffer/buffer_interface.hpp"
 
 namespace quickviz {
 template <typename T>

diff --git a/...iew/include/imview/buffer/ring_buffer.hpp → ...e/imview/component/buffer/ring_buffer.hpp b/...iew/include/imview/buffer/ring_buffer.hpp → ...e/imview/component/buffer/ring_buffer.hpp
@@ -64,7 +64,7 @@
 #include <vector>
 #include <iostream>
 
-#include "imview/buffer/buffer_interface.hpp"
+#include "imview/component/buffer/buffer_interface.hpp"
 
 namespace quickviz {
 template <typename T = uint8_t, std::size_t N = 1024>

diff --git a/...e/imview/buffer/scrolling_plot_buffer.hpp → ...omponent/buffer/scrolling_plot_buffer.hpp b/...e/imview/buffer/scrolling_plot_buffer.hpp → ...omponent/buffer/scrolling_plot_buffer.hpp
diff --git a/...e/imview/event/async_event_dispatcher.hpp → ...omponent/event/async_event_dispatcher.hpp b/...e/imview/event/async_event_dispatcher.hpp → ...omponent/event/async_event_dispatcher.hpp
@@ -18,8 +18,8 @@
 #include <queue>
 #include <atomic>
 
-#include "imview/event/event.hpp"
-#include "imview/event/thread_safe_queue.hpp"
+#include "imview/component/event/event.hpp"
+#include "imview/component/event/thread_safe_queue.hpp"
 
 namespace quickviz {
 class AsyncEventDispatcher {

diff --git a/...lude/imview/event/async_event_emitter.hpp → ...w/component/event/async_event_emitter.hpp b/...lude/imview/event/async_event_emitter.hpp → ...w/component/event/async_event_emitter.hpp
@@ -8,7 +8,7 @@
 #ifndef QUICKVIZ_EVENT_ASYNC_EMITTER_HPP
 #define QUICKVIZ_EVENT_ASYNC_EMITTER_HPP
 
-#include "imview/event/async_event_dispatcher.hpp"
+#include "imview/component/event/async_event_dispatcher.hpp"
 
 namespace quickviz {
 class AsyncEventEmitter {

diff --git a/src/imview/include/imview/event/event.hpp → .../include/imview/component/event/event.hpp b/src/imview/include/imview/event/event.hpp → .../include/imview/component/event/event.hpp
diff --git a/...include/imview/event/event_dispatcher.hpp → ...view/component/event/event_dispatcher.hpp b/...include/imview/event/event_dispatcher.hpp → ...view/component/event/event_dispatcher.hpp
@@ -15,7 +15,7 @@
 #include <functional>
 #include <unordered_map>
 
-#include "imview/event/event.hpp"
+#include "imview/component/event/event.hpp"
 
 namespace quickviz {
 class EventDispatcher {

diff --git a/...ew/include/imview/event/event_emitter.hpp → .../imview/component/event/event_emitter.hpp b/...ew/include/imview/event/event_emitter.hpp → .../imview/component/event/event_emitter.hpp
@@ -8,7 +8,7 @@
 #ifndef QUICKVIZ_EVENT_EMITTER_HPP
 #define QUICKVIZ_EVENT_EMITTER_HPP
 
-#include "imview/event/event_dispatcher.hpp"
+#include "imview/component/event/event_dispatcher.hpp"
 
 namespace quickviz {
 class EventEmitter {

diff --git a/...nclude/imview/event/thread_safe_queue.hpp → ...iew/component/event/thread_safe_queue.hpp b/...nclude/imview/event/thread_safe_queue.hpp → ...iew/component/event/thread_safe_queue.hpp
diff --git a/src/imview/include/imview/component/shader.hpp b/src/imview/include/imview/component/shader.hpp
@@ -23,6 +23,7 @@ class Shader {
   };
 
  public:
+  Shader(const char* source_code, Type type);
   Shader(const std::string& source_file, Type type);
   ~Shader();
 
@@ -36,7 +37,7 @@ class Shader {
   uint32_t GetShaderID() const { return shader_id_; }
 
  private:
-  std::string LoadSourceFile(const std::string& file_path);
+  void CreateShader();
 
   std::string source_file_;
   Type type_;

diff --git a/src/imview/include/imview/primitive/grid.hpp b/src/imview/include/imview/primitive/grid.hpp
@@ -0,0 +1,41 @@
+/*
+ * @file grid.hpp
+ * @date 11/2/24
+ * @brief
+ *
+ * @copyright Copyright (c) 2024 Ruixiang Du (rdu)
+ */
+
+#ifndef QUICKVIZ_GRID_HPP
+#define QUICKVIZ_GRID_HPP
+
+#include <glm/glm.hpp>
+
+#include <vector>
+
+#include "imview/component/shader_program.hpp"
+
+namespace quickviz {
+class Grid {
+ public:
+  Grid(float grid_size = 10.0f, float spacing = 1.0f,
+       glm::vec3 color = glm::vec3(0.5f, 0.5f, 0.5f));
+  ~Grid();
+
+  void Initialize();
+  void Draw(const glm::mat4& projection, const glm::mat4& view);
+
+ private:
+  void GenerateGrid();
+
+  float grid_size_;
+  float spacing_;
+  glm::vec3 color_;
+  uint32_t vao_;
+  uint32_t vbo_;
+  std::vector<glm::vec3> vertices_;
+  ShaderProgram shader_;
+};
+}  // namespace quickviz
+
+#endif  // QUICKVIZ_GRID_HPP
diff --git a/src/imview/include/imview/viewer.hpp b/src/imview/include/imview/viewer.hpp
@@ -45,6 +45,7 @@ class Viewer : public Window {
   void Show();
 
  protected:
+  void SetupOpenGL();
   void ClearBackground();
   void CreateNewImGuiFrame();
   void RenderImGuiFrame();

diff --git a/src/imview/include/imview/widget/buffered_cv_image_widget.hpp b/src/imview/include/imview/widget/buffered_cv_image_widget.hpp
@@ -12,7 +12,7 @@
 #include <functional>
 
 #include "imview/panel.hpp"
-#include "imview/buffer/buffer_registry.hpp"
+#include "imview/component/buffer/buffer_registry.hpp"
 
 #include "glad/glad.h"
 

diff --git a/src/imview/include/imview/widget/rt_line_plot_widget.hpp b/src/imview/include/imview/widget/rt_line_plot_widget.hpp
@@ -13,8 +13,8 @@
 #include <unordered_map>
 
 #include "imview/panel.hpp"
-#include "imview/buffer/buffer_registry.hpp"
-#include "imview/buffer/scrolling_plot_buffer.hpp"
+#include "imview/component/buffer/buffer_registry.hpp"
+#include "imview/component/buffer/scrolling_plot_buffer.hpp"
 
 namespace quickviz {
 class RtLinePlotWidget : public Panel {

diff --git a/src/imview/src/buffer/buffer_registry.cpp → .../src/component/buffer/buffer_registry.cpp b/src/imview/src/buffer/buffer_registry.cpp → .../src/component/buffer/buffer_registry.cpp
@@ -8,7 +8,7 @@
 
 #include <stdexcept>
 
-#include "imview/buffer/buffer_registry.hpp"
+#include "imview/component/buffer/buffer_registry.hpp"
 
 namespace quickviz {
 BufferRegistry& BufferRegistry::GetInstance() {

diff --git a/...view/src/buffer/scrolling_plot_buffer.cpp → ...omponent/buffer/scrolling_plot_buffer.cpp b/...view/src/buffer/scrolling_plot_buffer.cpp → ...omponent/buffer/scrolling_plot_buffer.cpp
@@ -7,7 +7,7 @@
  * Copyright (c) 2021 Ruixiang Du (rdu)
  */
 
-#include "imview/buffer/scrolling_plot_buffer.hpp"
+#include "imview/component/buffer/scrolling_plot_buffer.hpp"
 
 #include <cmath>
 

diff --git a/...view/src/event/async_event_dispatcher.cpp → ...omponent/event/async_event_dispatcher.cpp b/...view/src/event/async_event_dispatcher.cpp → ...omponent/event/async_event_dispatcher.cpp
@@ -6,7 +6,7 @@
  * @copyright Copyright (c) 2024 Ruixiang Du (rdu)
  */
 
-#include "imview/event/async_event_dispatcher.hpp"
+#include "imview/component/event/async_event_dispatcher.hpp"
 
 namespace quickviz {
 AsyncEventDispatcher& AsyncEventDispatcher::GetInstance() {

diff --git a/src/imview/src/event/event_dispatcher.cpp → .../src/component/event/event_dispatcher.cpp b/src/imview/src/event/event_dispatcher.cpp → .../src/component/event/event_dispatcher.cpp
@@ -6,7 +6,7 @@
  * @copyright Copyright (c) 2024 Ruixiang Du (rdu)
  */
 
-#include "imview/event/event_dispatcher.hpp"
+#include "imview/component/event/event_dispatcher.hpp"
 
 namespace quickviz {
 EventDispatcher& EventDispatcher::GetInstance() {

diff --git a/src/imview/src/component/shader.cpp b/src/imview/src/component/shader.cpp
@@ -32,9 +32,29 @@ std::string LoadShaderSource(const std::string& file_path) {
 }
 }  // namespace
 
+Shader::Shader(const char* source_code, Type type)
+    : source_code_(source_code), type_(type) {
+  if (source_code == nullptr) {
+    std::cout << "ERROR::SHADER::INVALID_SOURCE_CODE" << std::endl;
+  }
+  CreateShader();
+}
+
 Shader::Shader(const std::string& source_file, Shader::Type type)
     : source_file_(source_file), type_(type) {
   source_code_ = LoadShaderSource(source_file_);
+
+  CreateShader();
+}
+
+Shader::~Shader() { glDeleteShader(shader_id_); }
+
+void Shader::CreateShader() {
+  if (source_code_.empty()) {
+    std::cout << "ERROR::SHADER::INVALID_SOURCE_FILE" << std::endl;
+    throw std::invalid_argument("Invalid shader source file");
+  }
+
   if (type_ == Shader::Type::kVertex)
     shader_id_ = glCreateShader(GL_VERTEX_SHADER);
   else if (type_ == Shader::Type::kFragment)
@@ -43,8 +63,6 @@ Shader::Shader(const std::string& source_file, Shader::Type type)
   glShaderSource(shader_id_, 1, &code, NULL);
 }
 
-Shader::~Shader() { glDeleteShader(shader_id_); }
-
 void Shader::Print() const {
   std::cout << "Shader source file: " << source_file_ << std::endl;
   std::cout << "Shader type: " << static_cast<int>(type_) << std::endl;
@@ -68,8 +86,4 @@ bool Shader::Compile() {
   }
   return success;
 }
-
-std::string Shader::LoadSourceFile(const std::string& file_path) {
-  return std::string();
-}
 }  // namespace quickviz