Add ResourceBrowser (#68)

* Add ResourceBrowser (stateful)

- Keep all persistent popup state in `ResourceBrowser`.
- Enable adding `StaticMesh`s through editor.

* Complete Add StaticMesh

- Upgrade Camera editor.
- Minor fixes.
- Focus keyboard on input on popup open.
- main: Ignore engine input if ImGui is using keyboard.

* Add editor::Combo

- Use in `Inspector`.

* Improve editor/common

- Store close callback (and whether to force close) in `Openable`, call it in its destructor.
- Have derived classes pass `ImGui::End*()` as the close callback.

Author: karnkaul

lib/engine/CMakeLists.txt

@@ -43,10 +43,10 @@ target_sources(${PROJECT_NAME} PRIVATE
   include/${target_prefix}/engine/editor/browse_file.hpp
   include/${target_prefix}/engine/editor/common.hpp
   include/${target_prefix}/engine/editor/drag_drop_id.hpp
-  include/${target_prefix}/engine/editor/inspect_data.hpp
   include/${target_prefix}/engine/editor/inspector.hpp
   include/${target_prefix}/engine/editor/log.hpp
   include/${target_prefix}/engine/editor/reflector.hpp
+  include/${target_prefix}/engine/editor/resource_browser.hpp
   include/${target_prefix}/engine/editor/scene_tree.hpp
 
   src/scene_renderer.cpp
@@ -57,5 +57,6 @@ target_sources(${PROJECT_NAME} PRIVATE
   src/editor/inspector.cpp
   src/editor/log.cpp
   src/editor/reflector.cpp
+  src/editor/resource_browser.cpp
   src/editor/scene_tree.cpp
 )

lib/engine/include/facade/engine/editor/common.hpp

@@ -25,17 +25,53 @@ glm::vec2 max_size(std::span<char const* const> strings);
 ///
 bool small_button_red(char const* label);
 
+///
+/// \brief Create a selectable item.
+/// \param label Label on the selectable
+/// \param selected whether this selectable should be selected
+/// \param flags ImGuiSelectableFlags (passthrough)
+/// \param size Size (passthrough)
+/// \returns true if clicked
+///
+bool selectable(char const* label, Bool selected, int flags = {}, glm::vec2 size = {});
+
+///
+/// \brief RAII Dear ImGui StyleVar stack
+///
+class StyleVar : public Pinned {
+  public:
+	explicit StyleVar(int index, glm::vec2 value) { push(index, value); }
+	explicit StyleVar(int index, float value) { push(index, value); }
+	~StyleVar();
+
+	void push(int index, glm::vec2 value);
+	void push(int index, float value);
+
+	explicit operator bool() const { return true; }
+
+  private:
+	int m_count{};
+};
+
 ///
 /// \brief Base class for RAII Dear ImGui wrappers whose widgets return a boolean on Begin()
 ///
 class Openable : public Pinned {
   public:
+	~Openable() noexcept;
+
 	bool is_open() const { return m_open; }
 	explicit operator bool() const { return is_open(); }
 
   protected:
-	Openable(bool is_open = false);
-	bool m_open;
+	using Close = void (*)();
+
+	Openable() = default;
+	Openable(bool is_open, Close close, Bool force_close = {}) : m_close(close), m_open(is_open), m_force_close(force_close) {}
+
+	Close m_close{};
+	bool m_open{};
+	bool m_force_close{};
 };
 
 ///
@@ -63,10 +99,6 @@ class Window : public Canvas {
 
 	explicit Window(char const* label, bool* open_if = {}, int flags = {});
 	Window(NotClosed<Canvas> parent, char const* label, glm::vec2 size = {}, Bool border = {}, int flags = {});
-	~Window();
-
-  private:
-	bool m_child{};
 };
 
 ///
@@ -75,7 +107,6 @@ class Window : public Canvas {
 class TreeNode : public Openable {
   public:
 	explicit TreeNode(char const* label, int flags = {});
-	~TreeNode();
 
 	static bool leaf(char const* label, int flags = {});
 };
@@ -94,7 +125,6 @@ class MenuBar : public Openable {
 class Menu : public Openable {
   public:
 	explicit Menu(NotClosed<MenuBar>, char const* label, Bool enabled = {true});
-	~Menu();
 };
 
 ///
@@ -103,7 +133,6 @@ class Menu : public Openable {
 class Window::Menu : public MenuBar {
   public:
 	explicit Menu(NotClosed<Canvas>);
-	~Menu();
 };
 
 ///
@@ -112,7 +141,6 @@ class Window::Menu : public MenuBar {
 class MainMenu : public MenuBar {
   public:
 	explicit MainMenu();
-	~MainMenu();
 };
 
 ///
@@ -121,7 +149,6 @@ class MainMenu : public MenuBar {
 class Popup : public Canvas {
   public:
 	explicit Popup(char const* id, Bool centered = {}, int flags = {}) : Popup(id, {}, {}, centered, flags) {}
-	~Popup();
 
 	static void open(char const* id);
 	static void close_current();
@@ -139,14 +166,27 @@ class Modal : public Popup {
 };
 
 ///
-/// \brief RAII Dear ImGui StyleVar stack
+/// \brief RAII Dear ImGui TabBar
 ///
-class StyleVar : public Pinned {
+class TabBar : public Openable {
   public:
-	explicit StyleVar(int index, glm::vec2 value);
-	explicit StyleVar(int index, float value);
-	~StyleVar();
+	class Item;
 
-	explicit operator bool() const { return true; }
+	explicit TabBar(char const* label, int flags = {});
+};
+
+class TabBar::Item : public Openable {
+  public:
+	explicit Item(NotClosed<TabBar>, char const* label, bool* open = {}, int flags = {});
+};
+
+///
+/// \brief RAII Dear ImGui Combo
+///
+class Combo : public Openable {
+  public:
+	explicit Combo(char const* label, char const* preview);
+
+	bool item(char const* label, Bool selected, int flags = {}, glm::vec2 size = {}) const { return selectable(label, selected, flags, size); }
 };
 } // namespace facade::editor

lib/engine/include/facade/engine/editor/inspect_data.hpp

@@ -1,6 +1,5 @@
 #pragma once
 #include <facade/engine/editor/common.hpp>
-#include <facade/engine/editor/inspect_data.hpp>
 #include <facade/scene/scene.hpp>
 
 namespace facade::editor {
@@ -10,7 +9,7 @@ namespace facade::editor {
 /// Inspectors are stateless ImGui helpers to view / edit various components, with drag-and-drop support.
 ///
 class Inspector {
-  protected:
+  public:
 	///
 	/// \brief Construct an Inspector instance.
 	///
@@ -19,6 +18,7 @@ class Inspector {
 	///
 	Inspector(NotClosed<Window> target, Scene& out_scene) : m_target(target), m_scene(out_scene), m_resources(out_scene.resources()) {}
 
+  protected:
 	NotClosed<Window> m_target;
 	Scene& m_scene;
 	SceneResources& m_resources;
@@ -68,17 +68,8 @@ class ResourceInspector : public Inspector {
 ///
 class SceneInspector : public Inspector {
   public:
-	using Data = InspectData;
-
-	SceneInspector(NotClosed<Window> target, Scene& out_scene) : Inspector(target, out_scene) {}
+	using Inspector::Inspector;
 
-	///
-	/// \brief View/edit all resources.
-	/// \param out_data Persistent data for popups
-	///
-	/// Uses ResourceInspector.
-	///
-	void resources(Data& out_data) const;
 	///
 	/// \brief Inspect the Scene's camera.
 	///

lib/engine/include/facade/engine/editor/inspector.hpp

@@ -0,0 +1,71 @@
+#pragma once
+#include <facade/engine/editor/common.hpp>
+#include <glm/vec3.hpp>
+
+namespace facade {
+class Scene;
+
+namespace editor {
+///
+/// \brief Stateful browser for resources in a scene.
+///
+/// Uses a framed TreeNode.
+///
+class ResourceBrowser {
+  public:
+	///
+	/// \brief View/edit all resources.
+	/// \param target editor Window to draw to
+	/// \param out_scene Scene whose resources to view/edit
+	///
+	/// Uses ResourceInspector.
+	///
+	void display(NotClosed<Window> target, Scene& out_scene);
+
+  private:
+	void add_mesh(bool trigger);
+	void add_material(bool trigger);
+	void add_static_mesh(bool trigger);
+
+	enum class SmType { eCube, eSphere, eCone, eCylinder, eArrow };
+
+	struct {
+		struct {
+			std::string buffer{};
+			int type{};
+		} mat{};
+		struct {
+			std::string buffer{};
+		} mesh{};
+		struct {
+			SmType type{};
+			std::string buffer{};
+			struct {
+				glm::vec3 vertex_rgb{1.0f};
+				glm::vec3 size{1.0f};
+			} cube{};
+			struct {
+				glm::vec3 vertex_rgb{1.0f};
+				float diameter{1.0f};
+				int quads_per_side{32};
+			} sphere{};
+			struct {
+				glm::vec3 vertex_rgb{1.0f};
+				float xz_diam{1.0f};
+				int xz_points{128};
+				float y_height{1.0f};
+			} conic{};
+			struct {
+				glm::vec3 vertex_rgb{1.0f};
+				float stalk_diam{0.5f};
+				float stalk_height{1.0f};
+				int xz_points{128};
+			} arrow{};
+		} static_mesh{};
+	} m_data{};
+
+	Scene* m_scene{};
+	NotClosed<Window>* m_target{};
+};
+} // namespace editor
+} // namespace facade

lib/engine/include/facade/engine/editor/resource_browser.hpp

@@ -23,46 +23,32 @@ bool small_button_red(char const* label) {
 	return ret;
 }
 
-Openable::Openable(bool is_open) : m_open(is_open) {}
+bool selectable(char const* label, Bool selected, int flags, glm::vec2 size) { return ImGui::Selectable(label, selected.value, flags, {size.x, size.y}); }
 
-Window::Window(char const* label, bool* open_if, int flags) : Canvas(ImGui::Begin(label, open_if, flags)) {}
-
-Window::Window(NotClosed<Canvas>, char const* label, glm::vec2 size, Bool border, int flags)
-	: Canvas(ImGui::BeginChild(label, {size.x, size.y}, border.value, flags)), m_child(true) {}
-
-// ImGui windows requires End() even if Begin() returned false
-Window::~Window() {
-	if (m_child) {
-		ImGui::EndChild();
-	} else {
-		ImGui::End();
+Openable::~Openable() noexcept {
+	if (m_open || m_force_close) {
+		assert(m_close);
+		(*m_close)();
 	}
 }
 
-TreeNode::TreeNode(char const* label, int flags) : Openable(ImGui::TreeNodeEx(label, flags)) {}
+Window::Window(char const* label, bool* open_if, int flags) : Canvas(ImGui::Begin(label, open_if, flags), &ImGui::End, {true}) {}
 
-TreeNode::~TreeNode() {
-	if (m_open) { ImGui::TreePop(); }
-}
+Window::Window(NotClosed<Canvas>, char const* label, glm::vec2 size, Bool border, int flags)
+	: Canvas(ImGui::BeginChild(label, {size.x, size.y}, border.value, flags), &ImGui::EndChild, {true}) {}
+
+TreeNode::TreeNode(char const* label, int flags) : Openable(ImGui::TreeNodeEx(label, flags), &ImGui::TreePop) {}
 
 bool TreeNode::leaf(char const* label, int flags) {
 	auto tn = TreeNode{label, flags | ImGuiTreeNodeFlags_Leaf};
 	return ImGui::IsItemClicked();
 }
 
-Window::Menu::Menu(NotClosed<Canvas>) : MenuBar(ImGui::BeginMenuBar()) {}
-
-Window::Menu::~Menu() {
-	if (m_open) { ImGui::EndMenuBar(); }
-}
-
-MainMenu::MainMenu() : MenuBar(ImGui::BeginMainMenuBar()) {}
+Window::Menu::Menu(NotClosed<Canvas>) : MenuBar(ImGui::BeginMenuBar(), &ImGui::EndMenuBar) {}
 
-MainMenu::~MainMenu() {
-	if (m_open) { ImGui::EndMainMenuBar(); }
-}
+MainMenu::MainMenu() : MenuBar(ImGui::BeginMainMenuBar(), &ImGui::EndMainMenuBar) {}
 
-Popup::Popup(char const* id, Bool modal, Bool closeable, Bool centered, int flags) {
+Popup::Popup(char const* id, Bool modal, Bool closeable, Bool centered, int flags) : Canvas(false, &ImGui::EndPopup) {
 	if (centered) {
 		auto const center = ImGui::GetMainViewport()->GetCenter();
 		ImGui::SetNextWindowPos(center, ImGuiCond_Appearing, ImVec2{0.5f, 0.5f});
@@ -74,21 +60,27 @@ Popup::Popup(char const* id, Bool modal, Bool closeable, Bool centered, int flag
 	}
 }
 
-Popup::~Popup() {
-	if (m_open) { ImGui::EndPopup(); }
-}
-
 void Popup::open(char const* id) { ImGui::OpenPopup(id); }
 
 void Popup::close_current() { ImGui::CloseCurrentPopup(); }
 
-Menu::Menu(NotClosed<MenuBar>, char const* label, Bool enabled) : Openable(ImGui::BeginMenu(label, enabled.value)) {}
+Menu::Menu(NotClosed<MenuBar>, char const* label, Bool enabled) : Openable(ImGui::BeginMenu(label, enabled.value), &ImGui::EndMenu) {}
 
-Menu::~Menu() {
-	if (m_open) { ImGui::EndMenu(); }
+void StyleVar::push(int index, glm::vec2 value) {
+	ImGui::PushStyleVar(index, {value.x, value.y});
+	++m_count;
 }
 
-StyleVar::StyleVar(int index, glm::vec2 value) { ImGui::PushStyleVar(index, {value.x, value.y}); }
-StyleVar::StyleVar(int index, float value) { ImGui::PushStyleVar(index, value); }
-StyleVar::~StyleVar() { ImGui::PopStyleVar(); }
+void StyleVar::push(int index, float value) {
+	ImGui::PushStyleVar(index, value);
+	++m_count;
+}
+
+StyleVar::~StyleVar() { ImGui::PopStyleVar(m_count); }
+
+TabBar::TabBar(char const* label, int flags) : Openable(ImGui::BeginTabBar(label, flags), &ImGui::EndTabBar) {}
+
+TabBar::Item::Item(NotClosed<TabBar>, char const* label, bool* open, int flags) : Openable(ImGui::BeginTabItem(label, open, flags), &ImGui::EndTabItem) {}
+
+Combo::Combo(char const* label, char const* preview) : Openable(ImGui::BeginCombo(label, preview), &ImGui::EndCombo) {}
 } // namespace facade::editor