Add build progress tracking feature

Author: adepierre

emscripten/shell_index.html

@@ -115,6 +115,8 @@ <h3 class="app-name">Changelog</h3>
                 "There are two kinds of splitters: one for which all outputs are equal, and one for which they are independent",
                 "An invalid link for a sink will be displayed in orange",
                 "You can set values using complex expressions such as (7.2 - 4.8) + 2 / (4/3 - 1/3)",
+                "You can track your build progress by clicking the checkbox on the top right corner of craft nodes",
+                "A craft node marked as built will be displayed with a green border",
             ];
 
             document.getElementById("tip").textContent = "Tip: " + tips[Math.floor(Math.random() * tips.length)];

ficsit-companion/include/app.hpp

@@ -103,7 +103,7 @@ class App
 
 private:
     /// @brief Used in saved files to track when format change. Used to update files saved with previous versions
-    static constexpr int SAVE_VERSION = 3;
+    static constexpr int SAVE_VERSION = 4;
 
     /// @brief Window id used for the Add Node popup
     static constexpr std::string_view add_node_popup_id = "Add Node";
@@ -125,6 +125,8 @@ class App
         /// @brief If true, will display power info with equal clocks on all machines in a node
         /// If false, it will compute the power for N machines at 100% + an underclocked machine
         bool power_equal_clocks = true;
+        /// @brief If true, build progress bar and checkbox on craft nodes will not be displayed
+        bool hide_build_progress = false;
     } settings;
 
     /// @brief All nodes currently in the graph view

ficsit-companion/include/node.hpp

@@ -93,6 +93,8 @@ struct CraftNode : public PoweredNode
     const Recipe* recipe;
     /// @brief Technically it could be just an int, but FractionalNumber already has all string operations
     FractionalNumber num_somersloop;
+    /// @brief Custom boolean that can be used to track progress on factory building
+    bool built;
 };
 
 struct GroupNode : public PoweredNode
@@ -108,6 +110,7 @@ struct GroupNode : public PoweredNode
     virtual bool HasVariablePower() const override;
     virtual void ComputePowerUsage() override;
     void PropagateRateToSubnodes();
+    void SetBuiltState(const bool b);
 
 private:
     void CreateInsOuts(const std::function<unsigned long long int()>& id_generator);
@@ -124,6 +127,7 @@ struct GroupNode : public PoweredNode
     /// @brief Cached value to avoid looping through all the nodes everytime
     bool variable_power;
     std::map<std::string, FractionalNumber> total_machines;
+    std::map<std::string, FractionalNumber> built_machines;
     std::map<std::string, std::map<const Recipe*, FractionalNumber>> detailed_machines;
     std::map<const Recipe*, FractionalNumber> detailed_power_same_clock;
     std::map<const Recipe*, FractionalNumber> detailed_power_last_underclock;

ficsit-companion/src/app.cpp

@@ -157,7 +157,7 @@ void App::LoadSettings()
 #else
     settings.hide_spoilers = false;
 #endif
-    settings.hide_somersloop = json.contains("hide_somersloop") && json["hide_somersloop"].get<bool>(); // default true
+    settings.hide_somersloop = json.contains("hide_somersloop") && json["hide_somersloop"].get<bool>(); // default false
     settings.unlocked_alts = {};
 
     for (const auto& r : Data::Recipes())
@@ -168,6 +168,8 @@ void App::LoadSettings()
         }
     }
 
+    settings.hide_build_progress = !json.contains("hide_build_progress") || json["hide_build_progress"].get<bool>(); // default true
+
     if (!content.has_value())
     {
         SaveSettings();
@@ -190,6 +192,8 @@ void App::SaveSettings() const
     }
     serialized["unlocked_alts"] = unlocked;
 
+    serialized["hide_build_progress"] = settings.hide_build_progress;
+
     SaveFile(settings_file.data(), serialized.Dump());
 }
 
@@ -1259,6 +1263,7 @@ void App::Render()
     ax::NodeEditor::SetCurrentEditor(context);
     ax::NodeEditor::PushStyleColor(ax::NodeEditor::StyleColor_Flow, ImColor(1.0f, 1.0f, 0.0f));
     ax::NodeEditor::PushStyleColor(ax::NodeEditor::StyleColor_FlowMarker, ImColor(1.0f, 1.0f, 0.0f));
+    ax::NodeEditor::PushStyleVar(ax::NodeEditor::StyleVar_SelectedNodeBorderWidth, 5.0f);
 
     ImGui::BeginChild("#left_panel", ImVec2(0.2f * ImGui::GetWindowSize().x, 0.0f), false, ImGuiWindowFlags_HorizontalScrollbar | ImGuiWindowFlags_NoNavInputs);
     RenderLeftPanel();
@@ -1297,6 +1302,7 @@ void App::Render()
     CustomKeyControl();
 
     ax::NodeEditor::End();
+    ax::NodeEditor::PopStyleVar();
     ax::NodeEditor::PopStyleColor();
     ax::NodeEditor::PopStyleColor();
 
@@ -1578,6 +1584,33 @@ void App::RenderLeftPanel()
             "If set, the power per node will be calculated assuming all machines are set at the same clock value\n"
             "Otherwise, it will be calculated with machines at 100% and one last machine underclocked");
     }
+    if (ImGui::Checkbox("Hide build progress", &settings.hide_build_progress))
+    {
+        SaveSettings();
+    }
+    if (ImGui::IsItemHovered(ImGuiHoveredFlags_AllowWhenDisabled))
+    {
+        ImGui::SetTooltip("%s", "If set, build checkmark on craft nodes and overall progress bars won't be displayed");
+    }
+    if (!settings.hide_build_progress)
+    {
+        ImGui::SameLine();
+        if (ImGui::Button("Reset progress"))
+        {
+            for (auto& n : nodes)
+            {
+                if (n->IsCraft())
+                {
+                    static_cast<CraftNode*>(n.get())->built = false;
+                }
+                else if (n->IsGroup())
+                {
+                    static_cast<GroupNode*>(n.get())->SetBuiltState(false);
+                }
+            }
+        }
+    }
+
 
     if (ImGui::Button("Unlock all alt recipes"))
     {
@@ -1612,6 +1645,9 @@ void App::RenderLeftPanel()
     std::map<const Item*, FractionalNumber, ItemPtrCompare> outputs;
     std::map<const Item*, FractionalNumber, ItemPtrCompare> intermediates;
     std::map<std::string, FractionalNumber> total_machines;
+    FractionalNumber all_machines;
+    std::map<std::string, FractionalNumber> built_machines;
+    FractionalNumber all_built_machines;
     std::map<std::string, std::map<const Recipe*, FractionalNumber, RecipePtrCompare>> detailed_machines;
     FractionalNumber total_sink_points;
     std::map<const Item*, FractionalNumber> detailed_sink_points;
@@ -1635,7 +1671,10 @@ void App::RenderLeftPanel()
 
             const CraftNode* node = static_cast<const CraftNode*>(n.get());
             total_machines[node->recipe->building->name] += node->current_rate;
+            all_machines += node->current_rate;
             detailed_machines[node->recipe->building->name][node->recipe] += node->current_rate;
+            built_machines[node->recipe->building->name] += node->built ? node->current_rate : 0;
+            all_built_machines += node->built ? node->current_rate : 0;
             total_power += settings.power_equal_clocks ? node->same_clock_power : node->last_underclock_power;
             detailed_power[node->recipe] += settings.power_equal_clocks ? node->same_clock_power : node->last_underclock_power;
             has_variable_power |= node->recipe->building->variable_power;
@@ -1658,6 +1697,12 @@ void App::RenderLeftPanel()
             for (const auto& [k, v] : node->total_machines)
             {
                 total_machines[k] += v;
+                all_machines += v;
+            }
+            for (const auto& [k, v] : node->built_machines)
+            {
+                built_machines[k] += v;
+                all_built_machines += v;
             }
             for (const auto& [k, v] : node->detailed_machines)
             {
@@ -1700,6 +1745,46 @@ void App::RenderLeftPanel()
         }
     }
 
+    if (!settings.hide_build_progress)
+    {
+        ImGui::SeparatorText("Build Progress");
+
+        // Progress bar color
+        ImGui::PushStyleColor(ImGuiCol_::ImGuiCol_PlotHistogram, ImVec4(0, 0.5, 0, 1));
+        // No visible color change when hovered/click
+        ImGui::PushStyleColor(ImGuiCol_::ImGuiCol_HeaderHovered, ImVec4(0, 0, 0, 0));
+        ImGui::PushStyleColor(ImGuiCol_::ImGuiCol_HeaderActive, ImVec4(0, 0, 0, 0));
+        const bool display_build_details = ImGui::TreeNodeEx("##build_progress", ImGuiTreeNodeFlags_FramePadding | ImGuiTreeNodeFlags_SpanAvailWidth);
+        ImGui::PopStyleColor();
+        ImGui::PopStyleColor();
+
+        // Displayed over the TreeNodeEx element (same line)
+        ImGui::SameLine();
+        ImGui::ProgressBar(all_machines.GetNumerator() == 0 ? 0.0f : static_cast<float>((all_built_machines / all_machines).GetValue()));
+        float max_machine_name_width = 0.0f;
+        for (auto& [machine, f] : built_machines)
+        {
+            max_machine_name_width = std::max(max_machine_name_width, ImGui::CalcTextSize(machine.c_str()).x);
+        }
+        // Detailed list of recipes if the tree node is open
+        if (display_build_details)
+        {
+            ImGui::Indent();
+            for (auto& [machine, f] : built_machines)
+            {
+                ImGui::TextUnformatted(machine.c_str());
+                ImGui::SameLine();
+                ImGui::Dummy(ImVec2(max_machine_name_width - ImGui::CalcTextSize(machine.c_str()).x, 0.0f));
+                ImGui::SameLine();
+                ImGui::ProgressBar((f / total_machines[machine]).GetValue());
+            }
+
+            ImGui::Unindent();
+            ImGui::TreePop();
+        }
+        ImGui::PopStyleColor();
+    }
+
     ImGui::SeparatorText(has_variable_power ? "Average Power Consumption" : "Power Consumption");
     if (total_power.GetNumerator() != 0)
     {
@@ -1996,6 +2081,14 @@ void App::RenderNodes()
             ax::NodeEditor::PushStyleColor(ax::NodeEditor::StyleColor_NodeBorder, ImColor(255, 0, 0));
             node_pushed_style += 1;
         }
+        if (!settings.hide_build_progress && (
+            (node->IsCraft() && static_cast<CraftNode*>(node.get())->built) ||
+            (node->IsGroup() && static_cast<GroupNode*>(node.get())->built_machines == static_cast<GroupNode*>(node.get())->total_machines)
+        ))
+        {
+            ax::NodeEditor::PushStyleColor(ax::NodeEditor::StyleColor_NodeBorder, ImColor(0, 255, 0));
+            node_pushed_style += 1;
+        }
         ax::NodeEditor::BeginNode(node->id);
         ImGui::PushID(node->id.AsPointer());
         ImGui::BeginVertical("node");
@@ -2005,7 +2098,18 @@ void App::RenderNodes()
                 switch (node->GetKind())
                 {
                 case Node::Kind::Craft:
-                    ImGui::TextUnformatted(static_cast<CraftNode*>(node.get())->recipe->display_name.c_str());
+                {
+                    CraftNode* craft_node = static_cast<CraftNode*>(node.get());
+                    ImGui::Spring(1.0f);
+                    ImGui::TextUnformatted(craft_node->recipe->display_name.c_str());
+                    ImGui::Spring(1.0f);
+                    if (!settings.hide_build_progress)
+                    {
+                        ImGui::PushStyleVar(ImGuiStyleVar_::ImGuiStyleVar_FramePadding, ImVec2(0, 0));
+                        ImGui::Checkbox("##craft_built", &craft_node->built);
+                        ImGui::PopStyleVar();
+                    }
+                }
                     break;
                 case Node::Kind::Merger:
                     ImGui::TextUnformatted("Merger");
@@ -2021,11 +2125,23 @@ void App::RenderNodes()
                     break;
                 case Node::Kind::Group:
                 {
+                    GroupNode* group_node = static_cast<GroupNode*>(node.get());
+                    ImGui::Spring(1.0f);
                     ImGui::TextUnformatted("Group");
                     ImGui::Spring(0.0f);
-                    std::string& name = static_cast<GroupNode*>(node.get())->name;
-                    ImGui::SetNextItemWidth(std::max(ImGui::CalcTextSize(name.c_str()).x, ImGui::CalcTextSize("Name...").x) + ImGui::GetStyle().FramePadding.x * 4.0f);
-                    ImGui::InputTextWithHint("##name", "Name...", &name);
+                    ImGui::SetNextItemWidth(std::max(ImGui::CalcTextSize(group_node->name.c_str()).x, ImGui::CalcTextSize("Name...").x) + ImGui::GetStyle().FramePadding.x * 4.0f);
+                    ImGui::InputTextWithHint("##name", "Name...", &group_node->name);
+                    ImGui::Spring(1.0f);
+                    if (!settings.hide_build_progress)
+                    {
+                        ImGui::PushStyleVar(ImGuiStyleVar_::ImGuiStyleVar_FramePadding, ImVec2(0, 0));
+                        bool is_built = group_node->built_machines == group_node->total_machines;
+                        if (ImGui::Checkbox("##group_built", &is_built))
+                        {
+                            group_node->SetBuiltState(is_built);
+                        }
+                        ImGui::PopStyleVar();
+                    }
                     break;
                 }
                 }

ficsit-companion/src/node.cpp

@@ -138,7 +138,7 @@ Json::Value PoweredNode::Serialize() const
 }
 
 CraftNode::CraftNode(const ax::NodeEditor::NodeId id, const Recipe* recipe, const std::function<unsigned long long int()>& id_generator) :
-    PoweredNode(id), num_somersloop(0)
+    PoweredNode(id), num_somersloop(0), built(false)
 {
     ChangeRecipe(recipe, id_generator);
 }
@@ -160,7 +160,7 @@ CraftNode::CraftNode(const ax::NodeEditor::NodeId id, const std::function<unsign
     }
     else
     {
-        throw std::runtime_error("Unknown recip when loading craft node");
+        throw std::runtime_error("Unknown recipe when loading craft node");
     }
 
     num_somersloop = FractionalNumber(serialized["num_somersloop"].get<long long int>());
@@ -173,6 +173,7 @@ CraftNode::CraftNode(const ax::NodeEditor::NodeId id, const std::function<unsign
     {
         p->current_rate = p->base_rate * current_rate * (1 + num_somersloop * recipe->building->somersloop_mult);
     }
+    built = serialized["built"].get<bool>();
 }
 
 CraftNode::~CraftNode()
@@ -191,6 +192,7 @@ Json::Value CraftNode::Serialize() const
 
     node["recipe"] = recipe->name;
     node["num_somersloop"] = num_somersloop.GetNumerator();
+    node["built"] = built;
 
     return node;
 }
@@ -509,6 +511,22 @@ void GroupNode::PropagateRateToSubnodes()
     }
 }
 
+void GroupNode::SetBuiltState(const bool b)
+{
+    for (size_t i = 0; i < nodes.size(); ++i)
+    {
+        if (nodes[i]->IsCraft())
+        {
+            static_cast<CraftNode*>(nodes[i].get())->built = b;
+        }
+        else if (nodes[i]->IsGroup())
+        {
+            static_cast<GroupNode*>(nodes[i].get())->SetBuiltState(b);
+        }
+    }
+    UpdateDetails();
+}
+
 void GroupNode::CreateInsOuts(const std::function<unsigned long long int()>& id_generator)
 {
     inputs.clear();
@@ -601,6 +619,7 @@ void GroupNode::CreateInsOuts(const std::function<unsigned long long int()>& id_
 void GroupNode::UpdateDetails()
 {
     total_machines = {};
+    built_machines = {};
     detailed_machines = {};
     detailed_power_same_clock = {};
     detailed_power_last_underclock = {};
@@ -611,6 +630,7 @@ void GroupNode::UpdateDetails()
         {
             const CraftNode* node = static_cast<const CraftNode*>(n.get());
             total_machines[node->recipe->building->name] += node->current_rate;
+            built_machines[node->recipe->building->name] += node->built ? node->current_rate : 0;
             detailed_machines[node->recipe->building->name][node->recipe] += node->current_rate;
             detailed_power_same_clock[node->recipe] += node->same_clock_power;
             detailed_power_last_underclock[node->recipe] += node->last_underclock_power;
@@ -622,6 +642,10 @@ void GroupNode::UpdateDetails()
             {
                 total_machines[k] += v;
             }
+            for (const auto& [k, v] : node->built_machines)
+            {
+                built_machines[k] += v;
+            }
             for (const auto& [k, v] : node->detailed_machines)
             {
                 for (const auto& [k2, v2] : v)