Scene Tree (#36)

karnkaul · web-flow · commit 768080ca8c59 · 2022-10-24T08:27:01.000-07:00
* Add scene tree (prototype)

* Formalize editor::SceneTree

- Stateless: user must track `Inspectee` across calls.
- Requires existing `Window`.
diff --git a/facade-lib/CMakeLists.txt b/facade-lib/CMakeLists.txt
@@ -117,6 +117,7 @@ target_sources(${PROJECT_NAME} PRIVATE
   include/facade/scene/id.hpp
   include/facade/scene/lights.hpp
   include/facade/scene/material.hpp
+  include/facade/scene/node_data.hpp
   include/facade/scene/node.hpp
   include/facade/scene/rect.hpp
   include/facade/scene/renderer.hpp
@@ -128,6 +129,7 @@ target_sources(${PROJECT_NAME} PRIVATE
   include/facade/editor/common.hpp
   include/facade/editor/inspector.hpp
   include/facade/editor/log.hpp
+  include/facade/editor/scene_tree.hpp
 
   src/util/data_provider.cpp
   src/util/geometry.cpp
@@ -171,4 +173,5 @@ target_sources(${PROJECT_NAME} PRIVATE
   src/editor/common.cpp
   src/editor/inspector.cpp
   src/editor/log.cpp
+  src/editor/scene_tree.cpp
 )
diff --git a/facade-lib/include/facade/editor/inspector.hpp b/facade-lib/include/facade/editor/inspector.hpp
@@ -10,7 +10,7 @@ class Scene;
 
 namespace editor {
 ///
-/// \brief ImGui helper to inspect / reflect various properties
+/// \brief Stateless ImGui helper to inspect / reflect various properties
 ///
 class Inspector {
   public:
diff --git a/facade-lib/include/facade/editor/scene_tree.hpp b/facade-lib/include/facade/editor/scene_tree.hpp
@@ -0,0 +1,39 @@
+#pragma once
+#include <facade/editor/common.hpp>
+#include <facade/scene/id.hpp>
+#include <facade/util/fixed_string.hpp>
+
+namespace facade {
+class Scene;
+class Node;
+
+namespace editor {
+///
+/// \brief Target Node to inspect (driven by SceneTree)
+///
+struct Inspectee {
+	FixedString<128> name{"[Node]###Node"};
+	Id<Node> id{};
+
+	explicit operator bool() const { return id > Id<Node>{}; }
+};
+
+///
+/// \brief Stateless wrapper to display interactive scene tree and pick Nodes to inspect
+///
+class SceneTree : public Pinned {
+  public:
+	SceneTree(Scene& scene) : m_scene(scene) {}
+
+	///
+	/// \brief Render the scene tree into the passed window
+	/// \param inout Used to highlight matching Node, and set to clicked Node, if any
+	/// \returns true if inout changed during tree walk
+	///
+	bool render(NotClosed<Window>, Inspectee& inout) const;
+
+  private:
+	Scene& m_scene;
+};
+} // namespace editor
+} // namespace facade
diff --git a/facade-lib/include/facade/engine/engine.hpp b/facade-lib/include/facade/engine/engine.hpp
@@ -10,7 +10,7 @@ class Scene;
 struct Window;
 
 struct EngineCreateInfo {
-	glm::uvec2 extent{800, 800};
+	glm::uvec2 extent{1280, 800};
 	char const* title{"facade"};
 	std::uint8_t msaa_samples{2};
 	bool auto_show{false};
diff --git a/facade-lib/include/facade/scene/node.hpp b/facade-lib/include/facade/scene/node.hpp
@@ -3,6 +3,7 @@
 #include <facade/scene/transform.hpp>
 #include <facade/util/type_id.hpp>
 #include <memory>
+#include <span>
 #include <unordered_map>
 #include <vector>
 
@@ -36,8 +37,12 @@ class Node {
 
 	Id<Node> id() const { return m_id; }
 
+	std::span<Node> children() { return m_children; }
+	std::span<Node const> children() const { return m_children; }
+
 	Transform transform{};
 	std::vector<Transform> instances{};
+	std::string name{};
 
   private:
 	struct Hasher {
diff --git a/facade-lib/include/facade/scene/node_data.hpp b/facade-lib/include/facade/scene/node_data.hpp
@@ -0,0 +1,16 @@
+#pragma once
+#include <facade/scene/transform.hpp>
+#include <string>
+#include <vector>
+
+namespace facade {
+struct NodeData {
+	enum class Type { eNone, eMesh, eCamera };
+
+	std::string name{};
+	Transform transform{};
+	std::vector<std::size_t> children{};
+	std::size_t index{};
+	Type type{};
+};
+} // namespace facade
diff --git a/facade-lib/include/facade/scene/scene.hpp b/facade-lib/include/facade/scene/scene.hpp
@@ -4,6 +4,7 @@
 #include <facade/scene/lights.hpp>
 #include <facade/scene/material.hpp>
 #include <facade/scene/node.hpp>
+#include <facade/scene/node_data.hpp>
 #include <facade/scene/transform.hpp>
 #include <facade/util/enum_array.hpp>
 #include <facade/util/image.hpp>
@@ -59,6 +60,8 @@ class Scene {
 	Node* find_node(Id<Node> id);
 	Material* find_material(Id<Material> id) const;
 	Mesh const* find_mesh(Id<Mesh> id) const;
+	std::span<Node> roots() { return m_tree.roots; }
+	std::span<Node const> roots() const { return m_tree.roots; }
 
 	std::size_t camera_count() const { return m_storage.cameras.size(); }
 	bool select_camera(Id<Camera> id);
@@ -75,15 +78,6 @@ class Scene {
   private:
 	struct TreeBuilder;
 
-	struct NodeData {
-		enum class Type { eNone, eMesh, eCamera };
-
-		Transform transform{};
-		std::vector<std::size_t> children{};
-		std::size_t index{};
-		Type type{};
-	};
-
 	struct Tree {
 		struct Data {
 			std::vector<std::size_t> roots{};
diff --git a/facade-lib/include/facade/util/fixed_string.hpp b/facade-lib/include/facade/util/fixed_string.hpp
@@ -25,8 +25,8 @@ class FixedString {
 
 	template <std::size_t N>
 	void append(FixedString<N> const& rhs) {
-		auto const dsize = std::min(Capacity - m_size, rhs.m_size);
-		std::memcpy(m_buffer + m_size, rhs.m_buffer, dsize);
+		auto const dsize = std::min(Capacity - m_size, rhs.size());
+		std::memcpy(m_buffer + m_size, rhs.data(), dsize);
 		m_size += dsize;
 	}
 
diff --git a/facade-lib/src/detail/gltf.cpp b/facade-lib/src/detail/gltf.cpp
@@ -605,7 +605,7 @@ Asset Asset::parse(dj::Json const& json, DataProvider const& provider) {
 			type = camera ? Node::Type::eCamera : Node::Type::eMesh;
 			index = camera ? camera.as<std::size_t>() : mesh.as<std::size_t>();
 		}
-		ret.nodes.push_back(Node{transform(node), children(node["children"]), index, type});
+		ret.nodes.push_back(Node{node["name"].as<std::string>(), transform(node), children(node["children"]), index, type});
 	}
 
 	auto const& scenes = json["scenes"].array_view();
diff --git a/facade-lib/src/detail/gltf.hpp b/facade-lib/src/detail/gltf.hpp
@@ -1,4 +1,5 @@
 #pragma once
+#include <facade/scene/node_data.hpp>
 #include <facade/scene/transform.hpp>
 #include <facade/util/byte_buffer.hpp>
 #include <facade/util/colour_space.hpp>
@@ -126,14 +127,7 @@ struct Texture {
 	ColourSpace colour_space{ColourSpace::eSrgb};
 };
 
-struct Node {
-	enum class Type { eNone, eMesh, eCamera };
-
-	Transform transform{};
-	std::vector<std::size_t> children{};
-	std::size_t index{};
-	Type type{};
-};
+using Node = NodeData;
 
 struct Scene {
 	std::vector<std::size_t> root_nodes{};
diff --git a/facade-lib/src/editor/inspector.cpp b/facade-lib/src/editor/inspector.cpp
@@ -63,6 +63,7 @@ bool Inspector::inspect(char const* label, glm::quat& out_quat) const {
 
 bool Inspector::inspect(Transform& out_transform) const {
 	auto ret = Modified{};
+	ImGui::Separator();
 	if (auto tn = TreeNode{"Transform"}) {
 		auto vec3 = out_transform.position();
 		if (ret(inspect("Position", vec3))) { out_transform.set_position(vec3); }
@@ -117,6 +118,7 @@ bool SceneInspector::inspect(Id<Mesh> mesh_id) const {
 	auto ret = Modified{};
 	auto* mesh = m_scene.find_mesh(mesh_id);
 	if (!mesh) { return ret.value; }
+	ImGui::Separator();
 	if (auto tn = TreeNode{FixedString{"Mesh ({})", mesh_id}.c_str()})
 		for (std::size_t i = 0; i < mesh->primitives.size(); ++i) {
 			if (auto tn = TreeNode{FixedString{"Primitive {}", i}.c_str()}) {
diff --git a/facade-lib/src/editor/scene_tree.cpp b/facade-lib/src/editor/scene_tree.cpp
@@ -0,0 +1,44 @@
+#include <imgui.h>
+#include <facade/editor/scene_tree.hpp>
+#include <facade/scene/scene.hpp>
+
+namespace facade::editor {
+namespace {
+FixedString<128> node_name(Node const& node) {
+	auto ret = FixedString<128>{node.name};
+	if (ret.empty()) { ret = "(Unnamed)"; }
+	ret += FixedString{" ({})", node.id()};
+	return ret;
+}
+
+Inspectee inspect(Node const& node) {
+	auto ret = Inspectee{};
+	ret.id = node.id();
+	ret.name = node_name(node);
+	ret.name += FixedString{"###Node"};
+	return ret;
+}
+
+void walk(Node& node, Inspectee& inout) {
+	auto flags = ImGuiTreeNodeFlags_OpenOnArrow | ImGuiTreeNodeFlags_SpanAvailWidth;
+	if (node.id() == inout.id) { flags |= ImGuiTreeNodeFlags_Selected; }
+	if (node.children().empty()) { flags |= ImGuiTreeNodeFlags_Leaf; }
+	auto tn = editor::TreeNode{node_name(node).c_str(), flags};
+	if (ImGui::IsItemClicked(ImGuiMouseButton_Left)) {
+		inout = inspect(node);
+	} else if ((flags & ImGuiTreeNodeFlags_Selected) && ImGui::IsItemClicked(ImGuiMouseButton_Right)) {
+		inout = {};
+	}
+	if (tn) {
+		for (auto& child : node.children()) { walk(child, inout); }
+	}
+}
+} // namespace
+
+bool SceneTree::render(NotClosed<Window>, Inspectee& inout) const {
+	auto const in = inout.id;
+	if (!m_scene.find_node(in)) { inout = {}; }
+	for (auto& root : m_scene.roots()) { walk(root, inout); }
+	return inout.id != in;
+}
+} // namespace facade::editor
diff --git a/facade-lib/src/scene/scene.cpp b/facade-lib/src/scene/scene.cpp
@@ -109,6 +109,7 @@ struct Scene::TreeBuilder {
 
 	void add(NodeData const& child, std::vector<Node>& out_children) {
 		auto node = Node{};
+		node.name = child.name;
 		node.transform = child.transform;
 		bool set_cam{};
 		switch (child.type) {
@@ -176,9 +177,7 @@ bool Scene::load_gltf(dj::Json const& root, DataProvider const& provider) noexce
 		m_storage.textures.push_back(to_texture(m_gfx, get_sampler(texture.sampler), m_storage.images.at(texture.source), texture));
 	}
 
-	for (auto& node : asset.nodes) {
-		m_storage.data.nodes.push_back(NodeData{node.transform, std::move(node.children), node.index, static_cast<NodeData::Type>(node.type)});
-	}
+	m_storage.data.nodes = std::move(asset.nodes);
 	for (auto& scene : asset.scenes) { m_storage.data.trees.push_back(Tree::Data{.roots = std::move(scene.root_nodes)}); }
 
 	return load(asset.start_scene);
diff --git a/src/main.cpp b/src/main.cpp
@@ -19,6 +19,7 @@
 
 #include <facade/editor/inspector.hpp>
 #include <facade/editor/log.hpp>
+#include <facade/editor/scene_tree.hpp>
 
 #include <bin/shaders.hpp>
 
@@ -118,20 +119,17 @@ static constexpr auto test_json_v = R"(
 
 struct MainMenu {
 	struct {
-		bool inspector{};
 		bool stats{};
+		bool tree{};
 	} windows{};
 
 	editor::Log log{};
+	struct {
+		FixedString<128> name{};
+		Id<Node> id{};
+	} inspecting{};
 
-	void inspector(Scene& scene) {
-		ImGui::SetNextWindowSize({250.0f, 100.0f}, ImGuiCond_Once);
-		if (auto window = editor::Window{"Node", &windows.inspector}) {
-			static auto s_input = int{};
-			ImGui::InputInt("Id", &s_input);
-			editor::SceneInspector{window, scene}.inspect(Id<Node>{static_cast<std::size_t>(s_input)});
-		}
-	}
+	editor::Inspectee inspectee{};
 
 	static constexpr std::string_view vsync_status(vk::PresentModeKHR const mode) {
 		switch (mode) {
@@ -160,6 +158,13 @@ struct MainMenu {
 		logger::info("Requesting present mode: [{}]", present_mode_str(next_mode));
 	}
 
+	void inspector(Scene& scene) {
+		bool show = true;
+		ImGui::SetNextWindowSize({400.0f, 400.0f}, ImGuiCond_Once);
+		if (auto window = editor::Window{inspectee.name.c_str(), &show}) { editor::SceneInspector{window, scene}.inspect(inspectee.id); }
+		if (!show) { inspectee = {}; }
+	}
+
 	void stats(Engine const& engine, float const dt) {
 		ImGui::SetNextWindowSize({200.0f, 200.0f}, ImGuiCond_Once);
 		if (auto window = editor::Window{"Frame Stats", &windows.stats}) {
@@ -175,22 +180,58 @@ struct MainMenu {
 		}
 	}
 
+	void tree(Scene& scene) {
+		ImGui::SetNextWindowSize({250.0f, 350.0f}, ImGuiCond_Once);
+		if (auto window = editor::Window{"Scene", &windows.tree}) { editor::SceneTree{scene}.render(window, inspectee); }
+	}
+
+	static FixedString<128> node_name(Node const& node) {
+		auto ret = FixedString<128>{node.name};
+		if (ret.empty()) { ret = "(Unnamed)"; }
+		ret += FixedString{" ({})", node.id()};
+		return ret;
+	}
+
+	void mark_inspect(Node const& node) {
+		inspecting.id = node.id();
+		inspecting.name = node_name(node);
+		inspecting.name += FixedString{"###Node"};
+	}
+
+	void uninspect() { inspecting = {.name = "[Node]###Node"}; }
+
+	void walk(Node& node) {
+		auto flags = ImGuiTreeNodeFlags_OpenOnArrow | ImGuiTreeNodeFlags_SpanAvailWidth;
+		if (node.id() == inspecting.id) { flags |= ImGuiTreeNodeFlags_Selected; }
+		if (node.children().empty()) { flags |= ImGuiTreeNodeFlags_Leaf; }
+		auto tn = editor::TreeNode{node_name(node).c_str(), flags};
+		if (ImGui::IsItemClicked(ImGuiMouseButton_Left)) {
+			mark_inspect(node);
+		} else if (ImGui::IsItemClicked(ImGuiMouseButton_Right)) {
+			uninspect();
+		}
+		if (tn) {
+			for (auto& child : node.children()) { walk(child); }
+		}
+	}
+
 	void display(Engine& engine, Scene& scene, float const dt) {
 		if (auto main = editor::MainMenu{}) {
 			if (auto file = editor::Menu{main, "File"}) {
 				ImGui::Separator();
 				if (ImGui::MenuItem("Exit")) { engine.request_stop(); }
 			}
 			if (auto window = editor::Menu{main, "Window"}) {
-				if (ImGui::MenuItem("Inspect")) { windows.inspector = true; }
+				if (ImGui::MenuItem("Tree")) { windows.tree = true; }
 				if (ImGui::MenuItem("Stats")) { windows.stats = true; }
 				if (ImGui::MenuItem("Log")) { log.show = true; }
 				ImGui::Separator();
 				if (ImGui::MenuItem("Close All")) { windows = {}; }
 			}
 		}
 
-		if (windows.inspector) { inspector(scene); }
+		if (windows.tree) { tree(scene); }
+		if (inspectee) { inspector(scene); }
 		if (windows.stats) { stats(engine, dt); }
 		if (log.show) { log.render(); }
 	}

Original file line number	Diff line number	Diff line change
`@@ -25,8 +25,8 @@ class FixedString {`
`25`	`25`
`26`	`26`	`template <std::size_t N>`
`27`	`27`	`void append(FixedString<N> const& rhs) {`
`28`		`- auto const dsize = std::min(Capacity - m_size, rhs.m_size);`
`29`		`- std::memcpy(m_buffer + m_size, rhs.m_buffer, dsize);`
	`28`	`+ auto const dsize = std::min(Capacity - m_size, rhs.size());`
	`29`	`+ std::memcpy(m_buffer + m_size, rhs.data(), dsize);`
`30`	`30`	`m_size += dsize;`
`31`	`31`	`}`
`32`	`32`
Original file line number	Diff line number	Diff line change
`@@ -605,7 +605,7 @@ Asset Asset::parse(dj::Json const& json, DataProvider const& provider) {`
`605`	`605`	`type = camera ? Node::Type::eCamera : Node::Type::eMesh;`
`606`	`606`	`index = camera ? camera.as<std::size_t>() : mesh.as<std::size_t>();`
`607`	`607`	`}`
`608`		`- ret.nodes.push_back(Node{transform(node), children(node["children"]), index, type});`
	`608`	`+ ret.nodes.push_back(Node{node["name"].as<std::string>(), transform(node), children(node["children"]), index, type});`
`609`	`609`	`}`
`610`	`610`
`611`	`611`	`auto const& scenes = json["scenes"].array_view();`