Search for active extruders to generate skirt/brim

CURA-12250

Author: wawanbreton

CMakeLists.txt

@@ -99,7 +99,7 @@ set(engine_SRCS # Except main.cpp.
 
         src/feature_generation/FeatureGenerator.cpp include/feature_generation/FeatureGenerator.h
         src/feature_generation/MeshFeatureGenerator.cpp include/feature_generation/MeshFeatureGenerator.h
-        src/feature_generation/SkirtBrimGenerator.cpp include/feature_generation/SkirtBrimGenerator.h
+        src/feature_generation/SkirtBrimAppender.cpp include/feature_generation/SkirtBrimAppender.h
 
         src/infill/ImageBasedDensityProvider.cpp
         src/infill/NoZigZagConnectorProcessor.cpp

doc/architecture_paths_graph.puml

@@ -69,7 +69,6 @@ package "operation_transformation" {
   }
 
   LayerPlanTravelMovesInserter -up-|> PrintOperationTransformer
-  AddPrimeTowerTransformer -up-|> PrintOperationTransformer
   MinimumLayerTimeTransformer -up-|> PrintOperationTransformer
   CoastingTransformer -up-|> PrintOperationTransformer
   BackPressureCompensationTransformer -up-|> PrintOperationTransformer
@@ -78,6 +77,8 @@ package "operation_transformation" {
   AddBedTemperatureCommandsTransformer -up-|> InsertOperationOnTimeTransformer
   AddCoolingFanCommandsTransformer -up-|> InsertOperationOnTimeTransformer
   InsertOperationOnTimeTransformer -up-|> PrintOperationTransformer
+  SkirtBrimAppender -up-|> PrintOperationTransformer
+  PrimeTowerAppender -up-|> PrintOperationTransformer
 
   LayerPlanTravelMovesInserter *-- "*" TravelMoveGenerator
   abstract TravelMoveGenerator
@@ -106,7 +107,6 @@ package "operation_transformation" {
   class AddNozzleTemperatureCommandsTransformer #paleturquoise
   class AddBedTemperatureCommandsTransformer #paleturquoise
   class AddCoolingFanCommandsTransformer #paleturquoise
-  class AddPrimeTowerTransformer #paleturquoise
   class CombingTravelMoveGenerator #paleturquoise
   class MinimumLayerTimeTransformer #paleturquoise
   class CoastingTransformer #paleturquoise
@@ -116,23 +116,22 @@ package "operation_transformation" {
   class GradualFlowSplitter #paleturquoise
   class ScarfSeamSplitter #paleturquoise
   class SmoothSpeedSplitter #paleturquoise
+  class PrimeTowerAppender #paleturquoise
 }
 
 package "feature_generation" {
   abstract FeatureGenerator {
-    {abstract} vector<FeatureExtrusion> generateFeatures(layer_index, extruder_index)
+    {abstract} generateFeatures(layer_index, extruder_plans)
   }
 
   MeshFeatureGenerator -up-|> FeatureGenerator
   NormalSupportGenerator -up-|> FeatureGenerator
   TreeSupportGenerator -up-|> FeatureGenerator
   OozeShieldGenerator -up-|> FeatureGenerator
-  SkirtBrimGenerator -up-|> FeatureGenerator
 
   class MeshFeatureGenerator #paleturquoise
   class NormalSupportGenerator #paleturquoise
   class TreeSupportGenerator #paleturquoise
   class OozeShieldGenerator #paleturquoise
-  class SkirtBrimGenerator #paleturquoise
 }
 @enduml

include/feature_generation/SkirtBrimAppender.h

@@ -0,0 +1,24 @@
+// Copyright (c) 2024 UltiMaker
+// CuraEngine is released under the terms of the AGPLv3 or higher
+
+#pragma once
+
+#include <settings/EnumSettings.h>
+
+#include "operation_transformation/PrintOperationTransformer.h"
+#include "print_operation/PrintPlan.h"
+
+namespace cura
+{
+
+enum class EPlatformAdhesion;
+
+class SkirtBrimAppender : public PrintOperationTransformer<PrintPlan>
+{
+public:
+    explicit SkirtBrimAppender();
+
+    void process(PrintPlan* print_plan) override;
+};
+
+} // namespace cura

include/feature_generation/SkirtBrimGenerator.h

@@ -16,15 +16,19 @@ class SliceMeshStorage;
 class PlanExporter;
 class LayerPlan;
 
+namespace SearchDepth
+{
+static constexpr std::optional<size_t> Full = std::nullopt;
+static constexpr std::optional<size_t> DirectChildren = 0;
+}; // namespace SearchDepth
+
 class PrintOperationSequence : public PrintOperation, public std::enable_shared_from_this<PrintOperationSequence>
 {
 public:
     enum class SearchOrder
     {
-        Forward, // Only search in direct children, forwards
-        Backward, // Only search in direct children, backwards
-        DepthFirstForward, // Search in children tree, depth-first forwards
-        DepthFirstBackward, // Search in children tree, depth-first backwards
+        Forward,
+        Backward,
     };
 
 public:
@@ -43,14 +47,23 @@ class PrintOperationSequence : public PrintOperation, public std::enable_shared_
 
     std::optional<Point3LL> findEndPosition() const override;
 
-    std::shared_ptr<PrintOperation>
-        findOperation(const std::function<bool(const std::shared_ptr<PrintOperation>&)>& search_function, const SearchOrder search_order = SearchOrder::Forward) const;
+    /*!
+     * Searches a child operation, recursively or not, forwards of backwards, given a search function
+     *
+     * @param search_function The search function that should find the matching operation
+     * @param search_order Whether we should search forwards or backwards
+     * @param max_depth The maximum depth of children to look for. 0 means only direct children, nullopt means full tree. You case use SearchDepth defines.
+     * @return The first found operation, or a null ptr if none was found
+     * @note This function can also be used to iterate over children by providing a search function that always returns false
+     */
+    std::shared_ptr<PrintOperation> findOperation(
+        const std::function<bool(const std::shared_ptr<PrintOperation>&)>& search_function,
+        const SearchOrder search_order = SearchOrder::Forward,
+        const std::optional<size_t> max_depth = SearchDepth::DirectChildren) const;
 
     template<class OperationType>
-    std::shared_ptr<OperationType> findOperationByType(const SearchOrder search_order = SearchOrder::Forward) const;
-
-    std::shared_ptr<PrintOperation>
-        findOperation(const std::vector<const PrintOperation*>& parents, const std::function<bool(const std::shared_ptr<PrintOperation>&)>& search_function) const;
+    std::shared_ptr<OperationType>
+        findOperationByType(const SearchOrder search_order = SearchOrder::Forward, const std::optional<size_t> max_depth = SearchDepth::DirectChildren) const;
 
     const std::vector<std::shared_ptr<PrintOperation>>& getOperations() const noexcept;
 
@@ -74,14 +87,15 @@ class PrintOperationSequence : public PrintOperation, public std::enable_shared_
 };
 
 template<class OperationType>
-std::shared_ptr<OperationType> PrintOperationSequence::findOperationByType(const SearchOrder search_order) const
+std::shared_ptr<OperationType> PrintOperationSequence::findOperationByType(const SearchOrder search_order, const std::optional<size_t> max_depth) const
 {
     std::shared_ptr<PrintOperation> found_operation = findOperation(
         [](const std::shared_ptr<PrintOperation>& operation)
         {
             return static_cast<bool>(std::dynamic_pointer_cast<OperationType>(operation));
         },
-        search_order);
+        search_order,
+        max_depth);
 
     if (found_operation)
     {

include/print_operation/PrintOperationSequence.h

@@ -30,7 +30,6 @@
 #include "communication/Communication.h" //To send layer view data.
 #include "feature_generation/FeatureGenerator.h"
 #include "feature_generation/MeshFeatureGenerator.h"
-#include "feature_generation/SkirtBrimGenerator.h"
 #include "geometry/LinesSet.h"
 #include "geometry/OpenPolyline.h"
 #include "geometry/PointMatrix.h"
@@ -192,7 +191,6 @@ void FffGcodeWriter::writeGCode(SliceDataStorage& storage, TimeKeeper& time_keep
     // }
 
     // Add all possible feature generators
-    feature_generators_.push_back(std::make_shared<SkirtBrimGenerator>());
     for (const std::shared_ptr<SliceMeshStorage>& mesh : storage.meshes)
     {
         feature_generators_.push_back(std::make_shared<MeshFeatureGenerator>(mesh));
@@ -223,20 +221,7 @@ void FffGcodeWriter::writeGCode(SliceDataStorage& storage, TimeKeeper& time_keep
         });
 
     // print_plan_.flush(exporter);
-    // print_plan_.applyProcessors();
-
-#warning this should be done in the PrintPlan, or something like that
-    LayerPlanTravelMovesInserter layer_plan_travel_moves_inserter;
-    ExtruderPlanScheduler order_optimizer;
-    for (const std::shared_ptr<LayerPlan>& layer_plan : print_plan_->getOperationsAs<LayerPlan>())
-    {
-        for (const std::shared_ptr<ExtruderPlan>& extruder_plan : layer_plan->getOperationsAs<ExtruderPlan>())
-        {
-            order_optimizer.process(extruder_plan.get());
-        }
-
-        layer_plan_travel_moves_inserter.process(layer_plan.get());
-    }
+    print_plan_->applyProcessors();
 
     MultiExporter exporter;
     // exporter.appendExporter(std::make_shared<ConsoleExporter>());

src/FffGcodeWriter.cpp

@@ -0,0 +1,49 @@
+// Copyright (c) 2024 UltiMaker
+// CuraEngine is released under the terms of the AGPLv3 or higher
+
+#include "feature_generation/SkirtBrimAppender.h"
+
+#include <Application.h>
+#include <Slice.h>
+#include <settings/EnumSettings.h>
+#include <settings/Settings.h>
+
+#include <range/v3/algorithm/contains.hpp>
+
+#include "print_operation/ExtruderPlan.h"
+#include "print_operation/PrintOperationPtr.h"
+
+namespace cura
+{
+
+SkirtBrimAppender::SkirtBrimAppender()
+{
+}
+
+void SkirtBrimAppender::process(PrintPlan* print_plan)
+{
+    const Settings& settings = Application::getInstance().current_slice_->scene.settings;
+    const auto adhesion_type = settings.get<EPlatformAdhesion>("adhesion_type");
+    const bool support_brim_enable = settings.get<bool>("support_brim_enable");
+
+    if (adhesion_type != EPlatformAdhesion::SKIRT && adhesion_type != EPlatformAdhesion::BRIM && ! support_brim_enable)
+    {
+        return;
+    }
+
+    // Collect actually used extruders. At this point we assume that all added extruder plans are non-empty.
+    std::set<size_t> used_extruders;
+    print_plan->findOperation(
+        [&used_extruders](const PrintOperationPtr& operation)
+        {
+            if (const auto extruder_plan = std::dynamic_pointer_cast<ExtruderPlan>(operation))
+            {
+                used_extruders.insert(extruder_plan->getExtruderNr());
+            }
+            return false;
+        },
+        PrintOperationSequence::SearchOrder::Forward,
+        1);
+}
+
+} // namespace cura

src/feature_generation/SkirtBrimAppender.cpp

@@ -53,7 +53,7 @@ void LayerPlan::write(PlanExporter& exporter) const
 
 std::optional<Point3LL> LayerPlan::findExtruderStartPosition() const
 {
-    if (const auto move_sequence = findOperationByType<ContinuousExtruderMoveSequence>(SearchOrder::DepthFirstForward))
+    if (const auto move_sequence = findOperationByType<ContinuousExtruderMoveSequence>(SearchOrder::Forward, SearchDepth::Full))
     {
         std::optional<Point3LL> start_position = move_sequence->findStartPosition();
         if (start_position.has_value())