b0e901bab6
* Implement hints for arc * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Change hint text to lower case per comments and style guide * Sketcher: Add input hint to Point tool Adds a structured input hint ("🖱 pick point location") to the Point tool using Gui::InputHint. Hint appears immediately upon tool activation and uses the new `%1` icon injection pattern with MouseLeft. * Sketcher: Add structured input hints for Polyline (LineSet) tool - Adds context-sensitive input hints to the Polyline (LineSet) tool using Gui::InputHint. - Shows "pick first point" and "pick next point" with MouseLeft, and "right-click to finish" with MouseRight, updating as the tool state changes. - Hints appear in the status area to guide users through polyline creation. * Cleanup 'using' and short form of syntax per PR comment * Cleanup 'using' and short form of syntax per PR comment * Add Escape Key to cancel hints * Add MouseRight to cancel hint * MouseRight and Escape Key hints for all states * Sketcher: Add context-sensitive input hints to Line tool - Implements updateHints() for DrawSketchHandlerLine to show "pick first point" and "pick second point" actions with appropriate mouse icons. - Hints update dynamically based on tool state for improved user guidance. * Sketcher: Add context-sensitive input hints to Circle tool - Implements updateHints() for DrawSketchHandlerCircle to show appropriate hints for center and 3-rim construction methods. - Hints update dynamically based on tool state to guide user actions. * Remove cancel hints per PR/Discord feedback discussion * Sketcher: Refine Arc tool input hints for construction method - updateHints() now explicitly distinguishes between Center and ThreeRim construction methods. - Shows accurate context-sensitive hints for both arc creation modes. - Removes generic else for future-proofing and clarity. * Remove cancel hints per Discord discussion * Refactor to use using and short form of class names per PR feedback * Sketcher: Refactor Polygon tool to use new input hints mechanism - Replaces legacy getToolHints() with updateHints() following the modern pattern by @kadet - Ensures consistent, context-sensitive hints for Polygon tool, matching Arc, Line, and Circle tools - Removes cancel hints per maintainer feedback * Sketcher: Refactor Circle tool to use new input hints mechanism - Implements updateHints() for DrawSketchHandlerCircle - Provides context-sensitive hints for both center and 3-rim construction methods - Ensures consistency with Arc, Line, and Polygon tools * Sketcher: Update Rectangle tool to use new input hints mechanism - Implements updateHints() for DrawSketchHandlerRectangle - Provides context-sensitive hints for all supported rectangle construction methods - Ensures consistency with Arc, Line, Circle, and Polygon tools Note: All rectangle construction modes are supported and can be cycled after tool activation, even if not all are directly shown in the UI. * Sketcher: Refactor Slot tool to use new input hints mechanism - Implements updateHints() for DrawSketchHandlerSlot - Provides context-sensitive hints for all slot drawing steps - Ensures consistency with other Sketcher tools * Sketcher: Refactor Arc Slot tool to use new input hints mechanism - Implements updateHints() for DrawSketchHandlerArcSlot - Provides context-sensitive hints for both ArcSlot and RectangleSlot construction methods - Ensures consistency with other Sketcher tools * Sketcher: Refactor B-spline tool to use new input hints mechanism - Implements updateHints() for DrawSketchHandlerBSpline - Provides context-sensitive hints for all B-spline drawing steps - Ensures consistency with other Sketcher tools * Sketcher: Refactor Arc of Parabola tool to use new input hints mechanism - Implements updateHints() for DrawSketchHandlerArcOfParabola - Provides context-sensitive hints for each step of arc of parabola creation - Ensures consistency with other Sketcher tools * Sketcher: Refactor Arc of Ellipse tool to use new input hints mechanism - Implements updateHints() for DrawSketchHandlerArcOfEllipse - Provides context-sensitive hints for each step of arc of ellipse creation - Ensures consistency with other Sketcher tools * Sketcher: Add input hints to Arc of Hyperbola tool - Implements updateHints() for DrawSketchHandlerArcOfHyperbola - Provides context-sensitive hints for each step of arc of hyperbola creation - Ensures consistency with other Sketcher tools - Note: This only adds hints to the existing tool code; no refactor to controller/state machine pattern * Sketcher: Add M key hint to polyline tool - Adds a hint for the M key ("change mode") in the polyline (lineset) tool when drawing subsequent segments. - Improves discoverability of cycling segment/transition modes while drawing. * Merge branch 'sketcher-hints-circle' into sketcher-hints-all-drawing-tools * Restore updateHints() for Circle from sketcher-hints-circle branch * Refactor Sketcher tools to use getToolHints() for input hints (most tools updated, a few pending fine-tuning) * Sketcher: Ensure input hints update after every state change in LineSet tool - Explicitly call updateHint() after all Mode/state transitions in DrawSketchHandlerLineSet. - Fixes missing or stale input hints when using the polyline/lineset tool with custom state machine. - Brings hint update behavior in line with other Sketcher drawing tools. * Sketcher: Refactor Slot tool to use new input hints mechanism * Call updateHint() after setting mode * Sketcher: Add getToolHints() override to Rectangle handler for unified input hints - Revert inccorect previous inadvertent deletions (reverted to main) - Implements getToolHints() in DrawSketchHandlerRectangle to provide context-sensitive input hints. - Brings Rectangle tool in line with other Sketcher handlers using the standard input hint system. - No changes to controller or parameter adaptation logic. * Sketcher: Remove redundant 'click' from Point tool hint text - Change '%1 click to place a point' to '%1 place a point' - Mouse cursor already indicates clicking is needed - Makes hint text more concise and focused on the action * - Change remove implied 'click to finish" to just 'finish' - Mouse cursor already indicates clicking is needed - Makes hint text more concise and focused on the action" * Refactor all handlers to modern compact enum pattern per PR feedback - Use 'using enum Gui::InputHint::UserInput;' for cleaner enum usage - Direct return statements instead of intermediate variables - QObject::tr() for concise translation calls - Consistent modern pattern across all handlers - Improved readability and maintainability - Also implmemented getToolHints() in ArcSlot. * Add M key hint functionality to tools with multiple construction methods: - Circle: Center ↔ 3-point modes - Arc: Center ↔ 3-point modes - Rectangle: Diagonal → Center → 3-corner → Center+2-corner modes - Line: Point+length+angle → Point+width+height → 2-point modes - B-Spline: Control points ↔ Knots modes (+ construction-method-aware hints) Features: - Add 'M switch mode' hints to make mode switching discoverable - Add doConstructionMethodChanged() template specializations to update hints - Use generic 'switch mode' text for initial implementation (vs specific mode names) - Maintain consistent hint patterns across all tools - Preserve existing functionality while adding discoverability Users can now press M to cycle through construction methods in any multi-mode drawing tool and see the mode switching option in the hints panel. This first implementation uses generic 'switch mode' hint to avoid the complexity of tracking mode cycles with drop downs, etc. This would be where integrating hints into the underlying state machine might help * Per PR review feedback, replace repeated inline 'switch mode' hint definitions with const variables: - Define 'const InputHint switchModeHint' once per tool function - Use variable reference in all hint lists instead of inline creation - Reduces code duplication from 30+ repetitions to 5 clean definitions Affected tools: Circle, Arc, Rectangle, Line, B-Spline Improves maintainability - hint text changes only need updates in one location per tool. Follows DRY principle and reviewer feedback. No functional changes - same hints displayed to users. * Per PR feedback, remove repetitive 'arc slot' prefix from hint messages: - 'pick arc slot center' → 'pick slot center' - 'pick arc slot radius' → 'pick slot radius' - 'pick arc slot angle' → 'pick slot angle' - 'pick arc slot width' → 'pick slot width' Context is already clear from the active tool. Follows reviewer feedback to make hints more concise and less verbose. Improves readability while maintaining clarity * per PR feedback, Change 'change mode' to 'switch mode' to match all other drawing tools. * remove hanging Claude * per PR review, restore accidentally deleted Rectangle adaptParameters method Add back DSHRectangleController::adaptParameters template specialization that was accidentally removed during manual file reconstruction. This method handles parameter updates during Rectangle tool interaction, including checkbox synchronization for M key mode switching and proper state management when transitioning between construction methods. Without this method, mode switching leaves the tool in an inconsistent state with misaligned parameters and out-of-sync checkboxes. Addresses reviewer feedback - this functionality should not be removed. * Clean up placeholder comment per PR review feedback * Refactor Arc hints to declarative data-driven architecture Inspired by early feedback regarding separation of code and data, this refactors the Arc tool hints from functional logic to a pure declarative table-driven system. Key improvements: - Pure data-driven hint lookup via static table - Complete separation of hint data from control logic - Elimination of nested if/switch complexity - Establishes reusable pattern for other drawing tools - Maintains identical functionality with a cleaner architecture This creates a scalable template that other sketcher tools and workbenches can adopt, demonstrating proper usage of the InputHint framework through declarative configuration rather than imperative code." * Convert Point tool to declarative hint system Apply the proven declarative pattern to Point tool: - Replace functional getToolHints() with table lookup - Single state tool demonstrates pattern scalability - Maintains identical functionality with cleaner architecture * Convert Line tool to declarative hint system Apply declarative pattern to Line tool with 3 construction methods: - OnePointLengthAngle, OnePointWidthHeight, TwoPoints - All method/state combinations properly handled - Maintains identical functionality with cleaner architecture * Refine Arc tool declarative hints - address maintainer feedback - Use camelCase naming convention (switchModeHint, getArcHintTable) - Move tr() calls to runtime to fix translation caching issues - Preserve declarative table structure with runtime generation - Add structure comments for maintainability - Maintains identical functionality with cleaner implementation * Refine Point tool declarative hints - address feedback - Use camelCase naming (getPointHintTable) - Move tr() calls to runtime to fix translation issues - Preserve simple declarative structure - Point tool has no construction methods, keeps single-state simplicity * Refine Line tool declarative hints - address feedback - Use camelCase naming (switchModeHint, getLineHintTable) - Move tr() calls to runtime to fix translation issues - Preserve declarative table structure with 3 construction methods - Maintains all functionality for OnePointLengthAngle, OnePointWidthHeight, TwoPoints modes * Convert Arc of Ellipse to declarative hint system - Replace functional switch statement with declarative table approach - Use camelCase naming and runtime tr() calls - Maintains 4-state workflow: center, axis, start, end points - Consistent with refined declarative pattern used in Arc/Point/Line tools * Convert Circle to declarative hint system - Replace nested if/switch statements with declarative table approach - Use camelCase naming and runtime tr() calls - Support both Center and ThreeRim construction methods - Maintains all state transitions: center/rim points - Consistent with refined declarative pattern * Convert Polygon to declarative hint system - Replace switch statement with declarative table approach - Use camelCase naming and runtime tr() calls - Simple 2-state tool: center selection and rotation/size - Preserves polygon-specific hints (U/J keys for side count) - Consistent with refined declarative pattern * Convert Slot to declarative hint system - Replace switch statement with declarative table approach - Use camelCase naming and runtime tr() calls - Simple 3-state tool: start point, end point, radius - Consistent with refined declarative pattern * Convert Arc Slot to declarative hint system - Replace switch statement with declarative table approach - Use camelCase naming and runtime tr() calls - 4-state tool: center, radius, angle, width - Consistent with refined declarative pattern * Convert Arc of Hyperbola to declarative hint system - Replace switch statement with declarative table approach - Use camelCase naming and runtime tr() calls - 4-state tool: center, axis, start point, end point - Consistent with refined declarative pattern * Convert Parabola to declarative hint system - Replace switch statement with declarative table approach - Use camelCase naming and runtime tr() calls - 4-state tool: focus point, axis, starting point, end point - Consistent with refined declarative pattern * Convert B-spline to declarative hint system - Replace nested if/switch statements with declarative table approach - Use camelCase naming and runtime tr() calls - Support both ControlPoints and Knots construction methods - Preserves special finish functionality (MouseRight) - Consistent with refined declarative pattern * Convert Ellipse to declarative hint system - Replace nested if/switch statements with declarative table approach - Use camelCase naming and runtime tr() calls - Support both Center and ThreeRim construction methods - 3-state workflow for each method - Consistent with refined declarative pattern * Convert LineSet to declarative hint system - Replace switch statement with declarative table approach - Use camelCase naming and runtime tr() calls - 2-mode tool: first point, then multi-point with finish/switch - Preserves finish and mode switching functionality - Consistent with refined declarative pattern * Convert Rectangle to declarative hint system - Replace nested switch statements with declarative table approach - Use camelCase naming and runtime tr() calls - Support all 4 construction methods: Diagonal, CenterAndCorner, ThreePoints, CenterAnd3Points - Each method has 4-state workflow with switch mode functionality - Consistent with refined declarative pattern --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Your own 3D parametric modeler
Website • Documentation • Forum • Bug tracker • Git repository • Blog
Overview
-
Freedom to build what you want FreeCAD is an open-source parametric 3D modeler made primarily to design real-life objects of any size. Parametric modeling allows you to easily modify your design by going back into your model history to change its parameters.
-
Create 3D from 2D and back FreeCAD lets you to sketch geometry constrained 2D shapes and use them as a base to build other objects. It contains many components to adjust dimensions or extract design details from 3D models to create high quality production-ready drawings.
-
Designed for your needs FreeCAD is designed to fit a wide range of uses including product design, mechanical engineering and architecture, whether you are a hobbyist, programmer, experienced CAD user, student or teacher.
-
Cross platform FreeCAD runs on Windows, macOS and Linux operating systems.
-
Underlying technology
- OpenCASCADE A powerful geometry kernel, the most important component of FreeCAD
- Coin3D library Open Inventor-compliant 3D scene representation model
- Python FreeCAD offers a broad Python API
- Qt Graphical user interface built with Qt
Installing
Precompiled packages for stable releases are available for Windows, macOS and Linux on the Releases page.
On most Linux distributions, FreeCAD is also directly installable from the software center application.
For development releases visit the weekly-builds page.
Other options are described on the wiki Download page.
Compiling
FreeCAD requires several dependencies to correctly compile for development and production builds. The following pages contain updated build instructions for their respective platforms:
Reporting Issues
To report an issue please:
- Consider posting to the Forum, Discord channel, or Reddit to verify the issue;
- Search the existing issues for potential duplicates;
- Use the most updated stable or development versions of FreeCAD;
- Post version info from
Help > About FreeCAD > Copy to clipboard; - Restart FreeCAD in safe mode
Help > Restart in safe modeand try to reproduce the issue again. If the issue is resolved it can be fixed by deleting the FreeCAD config files. - Start recording a macro
Macro > Macro recording...and repeat all steps. Stop recording after the issue occurs and upload the saved macro or copy the macro code in the issue; - Post a Step-By-Step explanation on how to recreate the issue;
- Upload an example file (FCStd as ZIP file) to demonstrate the problem;
For more details see:
Note
The FPA offers developers the opportunity to apply for a grant to work on projects of their choosing. Check jobs and funding to know more.
Usage & Getting Help
The FreeCAD wiki contains documentation on general FreeCAD usage, Python scripting, and development. View these pages for more information:
The FreeCAD forum is a great place to find help and solve specific problems when learning to use FreeCAD.
This project receives generous infrastructure support from
and KiCad Services Corp.