c8b0706a1d
All checks were successful
Build and Test / build (pull_request) Successful in 32m17s
Copy QuickNav and ZTools source trees into reference/ for developer reference during the UI/UX rework. These are plain directories (not submodules) and are not included in the build. - reference/quicknav/ — QuickNav addon source - reference/ztools/ — ZTools addon source Part of the UI/UX rework preparation. See #346.
368 lines
14 KiB
Python
368 lines
14 KiB
Python
# ztools Workbench for FreeCAD 1.0+
|
|
# Extended PartDesign replacement with velocity-focused tools
|
|
|
|
import FreeCAD as App
|
|
import FreeCADGui as Gui
|
|
|
|
|
|
class ZToolsWorkbench(Gui.Workbench):
|
|
"""Extended PartDesign workbench with velocity-focused tools."""
|
|
|
|
MenuText = "ztools"
|
|
ToolTip = "Extended PartDesign replacement for faster CAD workflows"
|
|
|
|
# Catppuccin Mocha themed icon
|
|
Icon = """
|
|
/* XPM */
|
|
static char * ztools_xpm[] = {
|
|
"16 16 5 1",
|
|
" c None",
|
|
". c #313244",
|
|
"+ c #cba6f7",
|
|
"@ c #94e2d5",
|
|
"# c #45475a",
|
|
" ",
|
|
" ############ ",
|
|
" #..........# ",
|
|
" #.++++++++.# ",
|
|
" #.+......+.# ",
|
|
" #.....+++..# ",
|
|
" #....++....# ",
|
|
" #...++.....# ",
|
|
" #..++......# ",
|
|
" #.++.......# ",
|
|
" #.++++++++@# ",
|
|
" #..........# ",
|
|
" ############ ",
|
|
" ",
|
|
" ",
|
|
" "};
|
|
"""
|
|
|
|
def Initialize(self):
|
|
"""Called on workbench first activation."""
|
|
# Load PartDesign and Sketcher workbenches to register their commands
|
|
# We need to actually activate them briefly to ensure commands are registered
|
|
# Activate dependent workbenches so their commands are registered.
|
|
# Use activateWorkbench() instead of calling Initialize() directly,
|
|
# since direct calls skip the C++ __Workbench__ injection step.
|
|
# Wrap each individually so one failure doesn't block the rest.
|
|
wb_list = Gui.listWorkbenches()
|
|
current_wb = Gui.activeWorkbench()
|
|
for wb_name in (
|
|
"PartDesignWorkbench",
|
|
"SketcherWorkbench",
|
|
"AssemblyWorkbench",
|
|
"SpreadsheetWorkbench",
|
|
):
|
|
if wb_name in wb_list:
|
|
try:
|
|
Gui.activateWorkbench(wb_name)
|
|
except Exception as e:
|
|
App.Console.PrintWarning(f"Could not initialize {wb_name}: {e}\n")
|
|
# Restore ztools as the active workbench
|
|
try:
|
|
Gui.activateWorkbench("ZToolsWorkbench")
|
|
except Exception:
|
|
pass
|
|
|
|
# Command imports moved to module scope (after Gui.addWorkbench) so they
|
|
# are available before Initialize() runs. See end of file.
|
|
|
|
# =====================================================================
|
|
# PartDesign Structure Tools
|
|
# =====================================================================
|
|
self.structure_tools = [
|
|
"PartDesign_Body",
|
|
"PartDesign_NewSketch",
|
|
]
|
|
|
|
# =====================================================================
|
|
# PartDesign Reference Geometry (Datums)
|
|
# =====================================================================
|
|
self.partdesign_datum_tools = [
|
|
"PartDesign_Plane",
|
|
"PartDesign_Line",
|
|
"PartDesign_Point",
|
|
"PartDesign_CoordinateSystem",
|
|
"PartDesign_ShapeBinder",
|
|
"PartDesign_SubShapeBinder",
|
|
"PartDesign_Clone",
|
|
]
|
|
|
|
# =====================================================================
|
|
# PartDesign Additive Features
|
|
# =====================================================================
|
|
self.additive_tools = [
|
|
"PartDesign_Pad",
|
|
"PartDesign_Revolution",
|
|
"PartDesign_AdditiveLoft",
|
|
"PartDesign_AdditivePipe",
|
|
"PartDesign_AdditiveHelix",
|
|
]
|
|
|
|
# =====================================================================
|
|
# PartDesign Additive Primitives (compound command with dropdown)
|
|
# =====================================================================
|
|
self.additive_primitives = [
|
|
"PartDesign_CompPrimitiveAdditive",
|
|
]
|
|
|
|
# =====================================================================
|
|
# PartDesign Subtractive Features
|
|
# =====================================================================
|
|
self.subtractive_tools = [
|
|
"PartDesign_Pocket",
|
|
"PartDesign_Hole",
|
|
"PartDesign_Groove",
|
|
"PartDesign_SubtractiveLoft",
|
|
"PartDesign_SubtractivePipe",
|
|
"PartDesign_SubtractiveHelix",
|
|
]
|
|
|
|
# =====================================================================
|
|
# PartDesign Subtractive Primitives (compound command with dropdown)
|
|
# =====================================================================
|
|
self.subtractive_primitives = [
|
|
"PartDesign_CompPrimitiveSubtractive",
|
|
]
|
|
|
|
# =====================================================================
|
|
# PartDesign Transformation Features (Patterns)
|
|
# =====================================================================
|
|
self.transformation_tools = [
|
|
"PartDesign_Mirrored",
|
|
"PartDesign_LinearPattern",
|
|
"PartDesign_PolarPattern",
|
|
"PartDesign_MultiTransform",
|
|
]
|
|
|
|
# =====================================================================
|
|
# PartDesign Dress-Up Features
|
|
# =====================================================================
|
|
self.dressup_tools = [
|
|
"PartDesign_Fillet",
|
|
"PartDesign_Chamfer",
|
|
"PartDesign_Draft",
|
|
"PartDesign_Thickness",
|
|
]
|
|
|
|
# =====================================================================
|
|
# PartDesign Boolean Operations
|
|
# =====================================================================
|
|
self.boolean_tools = [
|
|
"PartDesign_Boolean",
|
|
]
|
|
|
|
# =====================================================================
|
|
# Sketcher Tools (commonly used with PartDesign)
|
|
# =====================================================================
|
|
self.sketcher_tools = [
|
|
"Sketcher_NewSketch",
|
|
"Sketcher_EditSketch",
|
|
"Sketcher_MapSketch",
|
|
"Sketcher_ValidateSketch",
|
|
]
|
|
|
|
# =====================================================================
|
|
# ZTools Custom Tools
|
|
# =====================================================================
|
|
self.ztools_datum_tools = [
|
|
"ZTools_DatumCreator",
|
|
"ZTools_DatumManager",
|
|
]
|
|
|
|
self.ztools_pattern_tools = [
|
|
"ZTools_RotatedLinearPattern",
|
|
]
|
|
|
|
self.ztools_pocket_tools = [
|
|
"ZTools_EnhancedPocket",
|
|
]
|
|
|
|
# =====================================================================
|
|
# Assembly Workbench Tools (FreeCAD 1.0+)
|
|
# =====================================================================
|
|
self.assembly_structure_tools = [
|
|
"Assembly_CreateAssembly",
|
|
"Assembly_InsertLink",
|
|
"Assembly_InsertNewPart",
|
|
]
|
|
|
|
self.assembly_joint_tools = [
|
|
"Assembly_CreateJointFixed",
|
|
"Assembly_CreateJointRevolute",
|
|
"Assembly_CreateJointCylindrical",
|
|
"Assembly_CreateJointSlider",
|
|
"Assembly_CreateJointBall",
|
|
"Assembly_CreateJointDistance",
|
|
"Assembly_CreateJointParallel",
|
|
"Assembly_CreateJointPerpendicular",
|
|
"Assembly_CreateJointAngle",
|
|
"Assembly_CreateJointRackPinion",
|
|
"Assembly_CreateJointScrew",
|
|
"Assembly_CreateJointGears",
|
|
"Assembly_CreateJointBelt",
|
|
]
|
|
|
|
self.assembly_management_tools = [
|
|
"Assembly_ToggleGrounded",
|
|
"Assembly_SolveAssembly",
|
|
"Assembly_CreateView",
|
|
"Assembly_CreateBom",
|
|
"Assembly_ExportASMT",
|
|
]
|
|
|
|
# =====================================================================
|
|
# ZTools Assembly Pattern Tools
|
|
# =====================================================================
|
|
self.ztools_assembly_tools = [
|
|
"ZTools_AssemblyLinearPattern",
|
|
"ZTools_AssemblyPolarPattern",
|
|
]
|
|
|
|
# =====================================================================
|
|
# Spreadsheet Workbench Tools
|
|
# =====================================================================
|
|
self.spreadsheet_tools = [
|
|
"Spreadsheet_CreateSheet",
|
|
"Spreadsheet_Import",
|
|
"Spreadsheet_Export",
|
|
"Spreadsheet_SetAlias",
|
|
"Spreadsheet_MergeCells",
|
|
"Spreadsheet_SplitCell",
|
|
]
|
|
|
|
# =====================================================================
|
|
# ZTools Spreadsheet Formatting Tools
|
|
# =====================================================================
|
|
self.ztools_spreadsheet_tools = [
|
|
"ZTools_SpreadsheetStyleBold",
|
|
"ZTools_SpreadsheetStyleItalic",
|
|
"ZTools_SpreadsheetStyleUnderline",
|
|
"ZTools_SpreadsheetAlignLeft",
|
|
"ZTools_SpreadsheetAlignCenter",
|
|
"ZTools_SpreadsheetAlignRight",
|
|
"ZTools_SpreadsheetBgColor",
|
|
"ZTools_SpreadsheetTextColor",
|
|
"ZTools_SpreadsheetQuickAlias",
|
|
]
|
|
|
|
# =====================================================================
|
|
# Append Toolbars
|
|
# =====================================================================
|
|
self.appendToolbar("Structure", self.structure_tools)
|
|
self.appendToolbar("Sketcher", self.sketcher_tools)
|
|
self.appendToolbar("Datums", self.partdesign_datum_tools)
|
|
self.appendToolbar("Additive", self.additive_tools + self.additive_primitives)
|
|
self.appendToolbar(
|
|
"Subtractive", self.subtractive_tools + self.subtractive_primitives
|
|
)
|
|
self.appendToolbar("Transformations", self.transformation_tools)
|
|
self.appendToolbar("Dress-Up", self.dressup_tools)
|
|
self.appendToolbar("Boolean", self.boolean_tools)
|
|
self.appendToolbar("Assembly", self.assembly_structure_tools)
|
|
self.appendToolbar("Assembly Joints", self.assembly_joint_tools)
|
|
self.appendToolbar("Assembly Management", self.assembly_management_tools)
|
|
self.appendToolbar("ztools Datums", self.ztools_datum_tools)
|
|
self.appendToolbar("ztools Patterns", self.ztools_pattern_tools)
|
|
self.appendToolbar("ztools Features", self.ztools_pocket_tools)
|
|
self.appendToolbar("ztools Assembly", self.ztools_assembly_tools)
|
|
self.appendToolbar("Spreadsheet", self.spreadsheet_tools)
|
|
self.appendToolbar("ztools Spreadsheet", self.ztools_spreadsheet_tools)
|
|
|
|
# =====================================================================
|
|
# Append Menus
|
|
# =====================================================================
|
|
self.appendMenu("Structure", self.structure_tools)
|
|
self.appendMenu("Sketch", self.sketcher_tools)
|
|
self.appendMenu(["PartDesign", "Datums"], self.partdesign_datum_tools)
|
|
self.appendMenu(
|
|
["PartDesign", "Additive"], self.additive_tools + self.additive_primitives
|
|
)
|
|
self.appendMenu(
|
|
["PartDesign", "Subtractive"],
|
|
self.subtractive_tools + self.subtractive_primitives,
|
|
)
|
|
self.appendMenu(["PartDesign", "Transformations"], self.transformation_tools)
|
|
self.appendMenu(["PartDesign", "Dress-Up"], self.dressup_tools)
|
|
self.appendMenu(["PartDesign", "Boolean"], self.boolean_tools)
|
|
self.appendMenu(["Assembly", "Structure"], self.assembly_structure_tools)
|
|
self.appendMenu(["Assembly", "Joints"], self.assembly_joint_tools)
|
|
self.appendMenu(["Assembly", "Management"], self.assembly_management_tools)
|
|
self.appendMenu(["Spreadsheet", "Edit"], self.spreadsheet_tools)
|
|
self.appendMenu(["Spreadsheet", "Format"], self.ztools_spreadsheet_tools)
|
|
self.appendMenu(
|
|
"ztools",
|
|
self.ztools_datum_tools
|
|
+ self.ztools_pattern_tools
|
|
+ self.ztools_pocket_tools
|
|
+ self.ztools_assembly_tools
|
|
+ self.ztools_spreadsheet_tools,
|
|
)
|
|
|
|
App.Console.PrintMessage("ztools workbench initialized\n")
|
|
|
|
def Activated(self):
|
|
"""Called when workbench is activated."""
|
|
App.Console.PrintMessage("ztools workbench activated\n")
|
|
|
|
def Deactivated(self):
|
|
"""Called when workbench is deactivated."""
|
|
pass
|
|
|
|
def GetClassName(self):
|
|
return "Gui::PythonWorkbench"
|
|
|
|
|
|
Gui.addWorkbench(ZToolsWorkbench())
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Eager command registration
|
|
# ---------------------------------------------------------------------------
|
|
# Import command modules at module scope so Gui.addCommand() calls run before
|
|
# any workbench activates. This ensures the PartDesign manipulator can
|
|
# reference them regardless of workbench activation order (#52).
|
|
|
|
from ztools.commands import (
|
|
assembly_pattern_commands,
|
|
datum_commands,
|
|
pattern_commands,
|
|
pocket_commands,
|
|
spreadsheet_commands,
|
|
)
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# WorkbenchManipulator: inject ZTools commands into PartDesign workbench
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
class _ZToolsPartDesignManipulator:
|
|
"""Adds ZTools commands to PartDesign toolbars and menus."""
|
|
|
|
def modifyToolBars(self):
|
|
return [
|
|
{"append": "ZTools_DatumCreator", "toolBar": "Part Design Helper Features"},
|
|
{"append": "ZTools_DatumManager", "toolBar": "Part Design Helper Features"},
|
|
{
|
|
"append": "ZTools_EnhancedPocket",
|
|
"toolBar": "Part Design Modeling Features",
|
|
},
|
|
{
|
|
"append": "ZTools_RotatedLinearPattern",
|
|
"toolBar": "Part Design Transformation Features",
|
|
},
|
|
]
|
|
|
|
def modifyMenuBar(self):
|
|
return [
|
|
{"append": "ZTools_DatumCreator", "menuItem": "PartDesign_Body"},
|
|
{"append": "ZTools_DatumManager", "menuItem": "PartDesign_Body"},
|
|
{"append": "ZTools_EnhancedPocket", "menuItem": "PartDesign_Body"},
|
|
{"append": "ZTools_RotatedLinearPattern", "menuItem": "PartDesign_Body"},
|
|
]
|
|
|
|
|
|
Gui.addWorkbenchManipulator(_ZToolsPartDesignManipulator())
|