Merge pull request #133 from graelo/feat/ecobin-scoop

Add scoop functionality to EcoBin classes

Author: Stu142

freecad/gridfinity_workbench/feature_construction.py

@@ -1,5 +1,7 @@
 """Module containing gridfinity feature constructions."""
 
+from __future__ import annotations
+
 import math
 from typing import Literal
 
@@ -187,8 +189,24 @@ def scoop_properties(obj: fc.DocumentObject, *, scoop_default: bool) -> None:
     ).Scoop = scoop_default
 
 
-def make_scoop(obj: fc.DocumentObject) -> Part.Shape:
-    """Create scoop."""
+def make_scoop(
+    obj: fc.DocumentObject,
+    *,
+    usable_height: None | fc.Units.Quantity = None,
+) -> Part.Shape:
+    """Create scoop.
+
+    Args:
+        obj: The object onto which to add the scoop.
+        usable_height: Override the obj's UsableHeight value (for EcoBins).
+
+    EcoBins are constructed in such a way that when the scoop is added, the
+    proper usable height (for correct geometry) has to be provided separately.
+
+    """
+    if usable_height is None:
+        usable_height = obj.UsableHeight
+
     scooprad1 = obj.ScoopRadius + unitmm
     scooprad2 = obj.ScoopRadius + unitmm
     scooprad3 = obj.ScoopRadius + unitmm
@@ -203,8 +221,8 @@ def make_scoop(obj: fc.DocumentObject) -> Part.Shape:
         scooprad1 = xdivscoop - unitmm
     if obj.ScoopRadius > xcomp_w and obj.xDividers > 0:
         scooprad2 = xcomp_w - 2 * unitmm
-    if obj.ScoopRadius > obj.UsableHeight > 0:
-        scooprad3 = obj.UsableHeight - obj.LabelShelfStackingOffset
+    if obj.ScoopRadius > usable_height > 0:
+        scooprad3 = usable_height - obj.LabelShelfStackingOffset
 
     scooprad = min(obj.ScoopRadius, scooprad1, scooprad2, scooprad3)
 
@@ -214,17 +232,17 @@ def make_scoop(obj: fc.DocumentObject) -> Part.Shape:
     v1 = fc.Vector(
         obj.xTotalWidth + obj.Clearance - obj.WallThickness,
         0,
-        -obj.UsableHeight + scooprad,
+        -usable_height + scooprad,
     )
     v2 = fc.Vector(
         obj.xTotalWidth + obj.Clearance - obj.WallThickness,
         0,
-        -obj.UsableHeight,
+        -usable_height,  # type: ignore[arg-type]
     )
     v3 = fc.Vector(
         obj.xTotalWidth + obj.Clearance - obj.WallThickness - scooprad,
         0,
-        -obj.UsableHeight,
+        -usable_height,  # type: ignore[arg-type]
     )
 
     l1 = Part.LineSegment(v1, v2)
@@ -237,7 +255,7 @@ def make_scoop(obj: fc.DocumentObject) -> Part.Shape:
         - scooprad
         + scooprad * math.sin(math.pi / 4),
         0,
-        -obj.UsableHeight + scooprad - scooprad * math.sin(math.pi / 4),
+        -usable_height + scooprad - scooprad * math.sin(math.pi / 4),
     )
 
     c1 = Part.Arc(v1, vc1, v3)
@@ -268,7 +286,7 @@ def make_scoop(obj: fc.DocumentObject) -> Part.Shape:
         scoopbox = Part.makeBox(
             stacking_lip_offset.Value,
             obj.yTotalWidth - obj.WallThickness * 2,
-            obj.UsableHeight,
+            usable_height,  # type: ignore[arg-type]
             fc.Vector(
                 obj.xTotalWidth + obj.Clearance - obj.WallThickness,
                 obj.Clearance + obj.WallThickness,
@@ -280,7 +298,7 @@ def make_scoop(obj: fc.DocumentObject) -> Part.Shape:
         edges = [
             edge
             for edge in funcfuse.Edges
-            if abs(edge.Vertexes[0].Z - edge.Vertexes[1].Z) == obj.UsableHeight
+            if abs(edge.Vertexes[0].Z - edge.Vertexes[1].Z) == usable_height
             and edge.Vertexes[0].X == edge.Vertexes[1].X
         ]
 

freecad/gridfinity_workbench/features.py

@@ -270,6 +270,7 @@ def __init__(self, obj: fc.DocumentObject) -> None:
         feat.bin_base_values_properties(obj)
         feat.label_shelf_properties(obj, label_style_default="Standard")
         feat.eco_compartments_properties(obj)
+        feat.scoop_properties(obj, scoop_default=False)
 
         obj.setExpression("UsableHeight", "TotalHeight - HeightUnitValue")
 
@@ -309,7 +310,17 @@ def generate_gridfinity_shape(self, obj: fc.DocumentObject) -> Part.Shape:
         compartment_solid = face.extrude(
             fc.Vector(0, 0, obj.TotalHeight - obj.BaseProfileHeight - obj.BaseWallThickness),
         )
-        fuse_total = fuse_total.cut(feat.make_eco_compartments(obj, layout, compartment_solid))
+
+        # First cut eco compartments to create the interior spaces
+        eco_compartments = feat.make_eco_compartments(obj, layout, compartment_solid)
+        fuse_total = fuse_total.cut(eco_compartments)
+
+        # Now add scoop, but only where eco compartments exist (reversed logic)
+        if obj.Scoop:
+            scoop = feat.make_scoop(obj, usable_height=obj.TotalHeight - obj.BaseWallThickness)
+            # Only add scoop where compartments exist - use intersection to constrain
+            scoop_constrained = scoop.common(eco_compartments)
+            fuse_total = fuse_total.fuse(scoop_constrained)
 
         if obj.ScrewHoles or obj.MagnetHoles:
             fuse_total = fuse_total.cut(feat.make_bin_bottom_holes(obj, layout))
@@ -602,6 +613,7 @@ def __init__(self, obj: fc.DocumentObject, layout: list[list[bool]]) -> None:
         feat.bin_base_values_properties(obj)
         feat.label_shelf_properties(obj, label_style_default="Off")
         feat.eco_compartments_properties(obj)
+        feat.scoop_properties(obj, scoop_default=False)
 
         obj.Proxy = self
 
@@ -657,11 +669,19 @@ def generate_gridfinity_shape(self, obj: fc.DocumentObject) -> Part.Shape:
             inside_wall_solid_full_height,
             obj.BinOuterRadius - obj.WallThickness,
         )
+        # First cut eco compartments to create the interior spaces
         compartments = feat.make_eco_compartments(obj, layout, compartments_solid)
         inside_wall_negative = cut_outside_shape(obj, inside_wall_solid_full_height)
         compartments = compartments.cut(inside_wall_negative)
         fuse_total = fuse_total.cut(compartments)
 
+        # Now add scoop, but only where eco compartments exist (reversed logic)
+        if obj.Scoop:
+            scoop = feat.make_scoop(obj, usable_height=obj.TotalHeight - obj.BaseWallThickness)
+            # Only add scoop where compartments exist - use intersection to constrain
+            scoop_constrained = scoop.common(compartments)
+            fuse_total = fuse_total.fuse(scoop_constrained)
+
         if obj.LabelShelfStyle != "Off":
             label_shelf = feat.make_label_shelf(obj, "eco")
             label_shelf = label_shelf.cut(inside_wall_negative)

freecad/gridfinity_workbench/utils.py

@@ -9,7 +9,7 @@
 import math
 from typing import TYPE_CHECKING
 
-import FreeCAD as fc  # noqa:N813
+import FreeCAD as fc  # noqa: N813
 import FreeCADGui as fcg  # noqa: N813
 import Part
 

freecad/gridfinity_workbench/version.py

@@ -1,3 +1,3 @@
 """Module containing version information."""
 
-__version__ = "0.12.2"
+__version__ = "0.12.3"

package.xml

@@ -5,9 +5,9 @@
 
   <description>This Workbench will generate several variations of parametric Gridfinity bins and baseplates that can be easily customized. </description>
 
-  <version>0.12.2</version>
+  <version>0.12.3</version>
 
-  <date>2026-02-28</date>
+  <date>2026-03-03</date>
 
   <license file="LICENSE">lgpl-2.1-or-later</license>
 

pyproject.toml

@@ -33,3 +33,6 @@ ignore = ["ANN003", "EM101", "EM102", "RET504", "TRY003", "S101", "SIM300"]
 # PT009  - pytest-unittest-assertion: we use unittest framework, not pytest
 "**/tests/*" = ["INP001", "D100", "D101", "D102", "PT027", "PT009"]
 "freecad/gridfinity_workbench/test_gridfinity.py" = ["D100", "D101", "D102", "PT027", "PT009"]
+
+[tool.ruff.lint.isort]
+known-third-party = ["FreeCAD", "FreeCADGui", "Part"]