feat: Add Parametric Hatch Generator macro #199

chopinregis · 2025-07-13T07:07:14Z

This pull request adds the Hatch Generator, a new parametric tool for creating complex 2D hatch patterns on Part faces.

Author: @chopinregis
Source Repository: https://github.com/chopinregis/FreeCAD-Parametric-Hatch-Generator

Features:

Creates a fully parametric Part::FeaturePython object for hatches.
Includes a library of over 100 built-in patterns.
Supports custom objects for patterns, multiple base objects, and subtractions.
Provides extensive randomization and variation controls.
Includes a comprehensive GUI for easy creation and previewing.

Dependencies:

An optional dependency on scipy is required to use the "Voronoi" and "VoronoiMesh" patterns. The macro functions without it but will print a warning if a user selects those patterns.

This macro is structured as a multi-file addon with a package.xml for integration with the Addon Manager.

for more information, see https://pre-commit.ci

chennes · 2025-07-13T07:12:43Z

If you have a package.xml file you don't want to add your macro to this repo, you want to have your own repo that the Addon Manager pulls it in from. Is this work already hosted in a git host someplace?

chennes · 2025-07-13T08:18:24Z

See: FreeCAD/FreeCAD-addons#394

galou

The only requested changes are:

put the macro into the ParametricObjectCreation directory
remove package.xml

galou · 2025-07-17T07:36:26Z

HatchGenerator/HatchGenerator.FCMacro

This file should be ParametricObjectCreation/HatchGenerator.FCMacro.

galou · 2025-07-17T07:38:52Z

HatchGenerator/HatchGenerator.FCMacro

+__Communication__ = 'https://forum.freecad.org/viewtopic.php?p=806176#p806176'
+# The __Files__ tag in the main macro is not strictly needed when using package.xml,
+# but it's good practice to list dependencies.
+__Files__ = 'Freecad_Hatch_Generator.py;HatchGenerator_Icon.svg;package.xml'


__Files__ = 'HatchGenerator.svg,hatch_generator/hatch_generator.py' (adapt if needed).

galou · 2025-07-17T07:39:56Z

HatchGenerator/Freecad_Hatch_Generator.py

Rename to hatch_generator/hatch_generator.py.

galou · 2025-07-17T07:42:43Z

HatchGenerator/HatchGenerator.FCMacro

+"""
+
+# The name of the module to import MUST match the library filename.
+import Freecad_Hatch_Generator


from hatch_generator.hatch_generator import runHatchGeneratorDialog runHatchGeneratorDialog()

galou · 2025-07-17T07:43:11Z

HatchGenerator/HatchGenerator.FCMacro

+It imports the main logic from the library file and launches the GUI.
+"""
+
+# The name of the module to import MUST match the library filename.


Remove the comment, this is a general Python knowledge.

galou · 2025-07-17T08:42:00Z

HatchGenerator/Freecad_Hatch_Generator.py

+            return
+
+        # 2) Create a brand new parametric object
+        tempName = "TempHatchParamObj"


Why not create a temporary document for this (tmp_doc = FreeCAD.newDocument(hidden=True, temp=True) and FreeCAD.closeDocument(tmp_doc.Name))?

galou · 2025-07-17T08:44:03Z

HatchGenerator/Freecad_Hatch_Generator.py

+        tempHatch.BaseObjects = selectedBaseObjs
+
+        # Pattern source:
+        if self.patternSourceCombo.currentIndex() == 0:


Explain the magic number 0.

galou · 2025-07-17T08:46:02Z

HatchGenerator/Freecad_Hatch_Generator.py

+        # If "HatchPreview" (or HatchPreview001 etc.) already exist, remove them
+        preview_existing = [obj for obj in doc.Objects if obj.Name.startswith("HatchPreview")]
+        idx = 0
+        while doc.getObject(previewName):


Limit idx to avoid an infinite loop.

galou · 2025-07-17T08:47:18Z

HatchGenerator/Freecad_Hatch_Generator.py

+            self.doc.recompute()
+            FreeCAD.ActiveDocument.commitTransaction()
+
+            QtWidgets.QMessageBox.information(


A FreeCAD.Console.PrintMessage should be sufficient on success.

galou · 2025-07-17T08:47:57Z

HatchGenerator/Freecad_Hatch_Generator.py

+            )
+
+        except Exception as e:
+            FreeCAD.ActiveDocument.abortTransaction()


Are nested transactions avoided?

chopinregis · 2025-07-19T13:48:19Z

If you have a package.xml file you don't want to add your macro to this repo, you want to have your own repo that the Addon Manager pulls it in from. Is this work already hosted in a git host someplace?

Thanks for the comment @chennes but i'm still still new to how github pull requests are made and they are still a bit quite confusing to me to properply understand all and the right order of things.

chennes · 2025-07-28T14:11:49Z

Thanks for the comment @chennes but i'm still still new to how github pull requests are made and they are still a bit quite confusing to me to properply understand all and the right order of things.

For including a macro into the FreeCAD macros listing you have three mutually-exclusive options:

Submit the macro and its auxilliary files to this repo (do not include a package.xml file, you can list your aux files in the __Files__ global at the top of your macro (see this example)
Add your macro to the FreeCAD wiki (see this example)
Host the macro in your own git repo, with a package.xml file. See this PR to the FreeCAD-Addons repo that would do that for your macro.

No matter which option you choose, you should first address @galou 's code review comments above.

chopinregis · 2025-07-29T00:18:04Z

No matter which option you choose, you should first address @galou 's code review comments above.

Okay thank you, let me review his comments.

chopinregis · 2025-07-29T00:27:51Z

So @chennes when i see a request change, that's the next step to do? i've seen the comments @galou made, quite pertinent ones indeed and i thank him for that, but i'm not so sure what to do from here, like should i open the code on my personal repo and make his suggested changes from there? or should i make the changes he suggestes on the freecadmacro repo?

chennes · 2025-07-29T01:47:18Z

@chopinregis because your PR has not yet been merged, what you should do is continue working on your add-hatch-generator branch. Any change that you push to that branch will be reflected as part of this PR. So if your plan is to continue with Option 1 as I listed them above, that's your process. Just keep editing this branch, committing the changes to your local copy and then pushing to the remote. Let me know if you need the actual git commands for doing those things.

chopinregis and others added 3 commits July 13, 2025 02:56

Create package.xml

e7e4491

Added HatchGenerator.FCMacro

549d4de

[pre-commit.ci] auto fixes from pre-commit.com hooks

c89b33b

for more information, see https://pre-commit.ci

galou requested changes Jul 17, 2025

View reviewed changes

feat: Add Parametric Hatch Generator macro #199

Are you sure you want to change the base?

feat: Add Parametric Hatch Generator macro #199

Uh oh!

Conversation

chopinregis commented Jul 13, 2025

Uh oh!

chennes commented Jul 13, 2025

Uh oh!

chennes commented Jul 13, 2025

Uh oh!

galou left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chopinregis commented Jul 19, 2025

Uh oh!

chennes commented Jul 28, 2025

Uh oh!

chopinregis commented Jul 29, 2025

Uh oh!

chopinregis commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chennes commented Jul 29, 2025

Uh oh!

Uh oh!

chopinregis commented Jul 29, 2025 •

edited

Loading