Complete documentation and figure out missing files

CURA-11978

Author: wawanbreton

CMakeLists.txt

@@ -163,7 +163,6 @@ set(engine_SRCS # Except main.cpp.
         src/utils/scoring/ExclusionAreaScoringCriterion.cpp
         src/utils/scoring/RandomScoringCriterion.cpp
 
-        src/geometry/Point2D.cpp
         src/geometry/Point2LL.cpp
         src/geometry/Point3LL.cpp
         src/geometry/Polygon.cpp

include/LayerPlan.h

@@ -85,11 +85,6 @@ class LayerPlan : public NoCopy
     {
         Duration z_hop; //!< The duration of the Z hop start and end
         Duration travel; //!< The duration of the full travel
-
-        inline Duration totalDuration() const
-        {
-            return travel + 2.0 * z_hop;
-        }
     };
 
     enum class TravelRetractionState
@@ -835,6 +830,7 @@ class LayerPlan : public NoCopy
      *  @param position The position to move to. The Z coordinate is an offset to the current layer position
      *  @param speed The actual used speed
      *  @param path_z_offset The global path Z offset to be applied
+     *  @param retract_distance The absolute retraction distance to be reached during this travel move, or nullopt to leave it unchanged
      *  @note This function is to be used when dealing with 3D coordinates. If you have 2D coordinates, just call gcode.writeTravel()
      */
     void writeTravelRelativeZ(

include/TravelAntiOozing.h

@@ -0,0 +1,30 @@
+// Copyright (c) 2023 UltiMaker
+// CuraEngine is released under the terms of the AGPLv3 or higher
+
+#ifndef TRAVELANTIOOZING_H
+#define TRAVELANTIOOZING_H
+
+#include "geometry/Point2LL.h"
+#include "settings/types/Ratio.h"
+
+namespace cura
+{
+
+struct ZHopAntiOozing
+{
+    double amount{ 0 }; //!< The absolute amount of retracted material (in mm) to be reached while the nozzle is moved up/down
+    Ratio ratio; //!< The ratio of the full z-hop move that contains a retract/prime
+};
+
+struct TravelAntiOozing
+{
+    double amount_while_still{ 0 }; //!< The absolute amount of retracted material (in mm) to be reached while the nozzle is still
+    ZHopAntiOozing z_hop; //!< The amount and ratio of retracted material to be processed during z-hop move
+    double amount_while_travel{ 0 }; //!< The absolute amount of retracted material (in mm) to be reached while the nozzle is travelling
+    Point2LL segment_split_position; //!< The intermediate position on the last/first segment that contains a retract/prime, where it should actually stop/start
+    std::vector<double> amount_by_segment; //!< For each intermediate segment containing a retraction/prime, this is the absolute amount to be reached at the end of the segment
+};
+
+} // namespace cura
+
+#endif /* TRAVELANTIOOZING_H */

include/gcodeExport.h

@@ -118,10 +118,13 @@ class GCodeExport : public NoCopy
 
     struct RetractionAmounts
     {
-        double old_e{ 0.0 };
-        double new_e{ 0.0 };
-        double diff_e{ 0.0 };
+        double old_e{ 0.0 }; // The previous absolute retraction amount
+        double new_e{ 0.0 }; // The new absolute retraction amount
+        double diff_e{ 0.0 }; // The difference between the new and previous amount, which is to be processed
 
+        /*!
+         * Indicates whether this retraction actually has something to process
+         */
         inline bool has_retraction() const
         {
             return std::abs(diff_e) >= 0.000001;
@@ -373,6 +376,7 @@ class GCodeExport : public NoCopy
      *
      * \param p location to go to
      * \param speed movement speed
+     *  \param retract_distance The absolute retraction distance to be reached during this travel, or nullopt to leave it unchanged
      */
     void writeTravel(const Point3LL& p, const Velocity& speed, const std::optional<double> retract_distance = std::nullopt);
 
@@ -438,7 +442,7 @@ class GCodeExport : public NoCopy
      * \param y build plate y
      * \param z build plate z
      * \param speed movement speed
-     * \param retract_distance The retract disance to be reached during this travel, or nullopt to leave it unchanged
+     * \param retract_distance The absolute retraction distance to be reached during this travel, or nullopt to leave it unchanged
      */
     void writeTravel(const coord_t x, const coord_t y, const coord_t z, const Velocity& speed, const std::optional<double> retract_distance = std::nullopt);
 

src/LayerPlan.cpp

@@ -5,7 +5,6 @@
 
 #include <algorithm>
 #include <cstring>
-#include <geometry/Point2D.h>
 #include <numeric>
 #include <optional>