User hub: Difference between revisions

From FreeCAD Documentation
(macros are relatively small snippets of Python code)
(Marked this version for translation)
 
(75 intermediate revisions by 18 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{TOCright}}
[[Image:User_hub.png|64px]]
[[Image:User_hub.png|64px]]
----
----
<translate>
<translate>
<!--T:1-->
[[Image:Crystal_Clear_app_display.png|right|150]]


<!--T:2-->
<!--T:2-->
Line 10: Line 9:


<!--T:3-->
<!--T:3-->
These pages are in continuous development, so there may be missing or outdated information. If you cannot find the information that you need, don't hesitate to ask in the [http://forum.freecadweb.org FreeCAD forum].
FreeCAD is in continuous development, so there may be missing or outdated information. If you cannot find the information that you need, don't hesitate to ask in the [https://forum.freecadweb.org FreeCAD forum].


<!--T:21-->
<!--T:21-->
If you'd like to contribute to FreeCAD, see the [[Help FreeCAD|Help FreeCAD]] page. If you'd like to edit this wiki, request a wiki account with editor permissions [https://forum.freecadweb.org/viewtopic.php?f=21&t=6830 in the forum], and read the [[WikiPages|WikiPages]] for the general guidelines that you should follow.
If you'd like to contribute to FreeCAD, please [[donate|donate]], and see the [[Help_FreeCAD|Help FreeCAD]] page for other ways to contribute. If you'd like to edit this wiki, request a wiki account with editor permissions [https://forum.freecadweb.org/viewtopic.php?f=21&t=6830 in the forum], and read the [[WikiPages|WikiPages]] for the general guidelines that you should follow.


<!--T:22-->
<!--T:22-->
If you would like to know how FreeCAD started years ago visit the [[History|History]] page.
If you would like to know how FreeCAD started years ago visit the [[History|History]] page.


</translate>
__NOTOC__

<translate>
== Using FreeCAD == <!--T:5-->
== Using FreeCAD == <!--T:5-->


Line 28: Line 23:
<!--T:7-->
<!--T:7-->
* [[About FreeCAD|Application Overview]]: A general overview of FreeCAD
* [[About FreeCAD|Application Overview]]: A general overview of FreeCAD
* [[Installing|Installing]]: How to install FreeCAD on [[Install on Windows|Windows]], [[Install on Unix|Unix/Linux]] and [[Install on Mac|Mac]]
* Installing: How to install FreeCAD on [[Installing_on_Windows|Windows]], [[Installing_on_Linux|Linux]] and [[Installing_on_Mac|Mac]]
* [[Installing Helpfile|Installing help files]]: how to install the offline documentation which is based on this wiki.
* [[Installing_additional_components|Installing additional components]]: how to install additional third-party components that can work together with FreeCAD.
* [[Getting started|Getting started]]: A quick overview of the available tools
* [[Getting started|Getting started]]: A quick overview of the available tools
* [[FAQ|FAQ]]: Frequently asked questions
* [[Frequently_asked_questions|FAQ]]: Frequently asked questions
* [[Tutorials|Tutorials]] covering different parts of FreeCAD
* [[Tutorials|Tutorials]] covering different parts of FreeCAD


===Basic Application=== <!--T:8-->
====Migrating from other software?==== <!--T:64-->


<!--T:9-->
<!--T:41-->
* [[Workarounds|Workarounds]]
* [[Interface|Interface]]: the FreeCAD interface is composed of various graphical elements on the screen.
* [[Migrating_to_FreeCAD_from_Fusion360|Migrating to FreeCAD from Fusion360]]
** [[3D view|3D view]]: the area where 2D and 3D geometry is drawn.
* [[Migrating_to_FreeCAD_from_OnShape|Migrating to FreeCAD from OnShape]]
** [[Combo view|Combo view]]: the panel that contains the [[tree view|tree view]], the [[task panel|task panel]], and the [[property editor|property editor]].
* [[Migrating_to_FreeCAD_from_SolidWorks|Migrating to FreeCAD from SolidWorks]]
** [[Tree view|Tree view]]: the element that shows all objects in the document and their parametric history.
* [[Migrating_to_FreeCAD_from_Revit|Migrating to FreeCAD from Revit]]
** [[Task panel|Task panel]]: the panel that shows different actions and options depending on the drawing tool selected.
* [https://yorik.uncreated.net/blog/2020-010-freecad-bim-guide FreeCAD BIM migration guide]
** [[Property editor|Property editor]]: the place where object properties are modified.
* [[BIM_application_compatibility_table|BIM applications compatibility table]]
** [[Selection view|Selection view]]: the panel that shows elements that are currently selected.
** [[Report view|Report view]]: the text box that shows different messages from the application and its tools.
** [[Python console|Python console]]: the editor that allows you to run [[Python|Python]] code interactively, and see results in the 3D view.
** [[DAG view|DAG view]]: an alternative to the tree view, which shows the relationships between different objects in the document through a graph.
** [[Interface Customization|Interface Customization]]: how to configure the toolbars with custom tools.


===Basic application=== <!--T:8-->
* [[Mouse Model|Mouse navigation]]: the different types of using the mouse or trackpad to navigate in the 3D view.

<!--T:9-->
* [[Interface|Interface]]: the FreeCAD interface is composed of various graphical elements on the screen, including the [[3D_view|3D view]], the [[Tree_view|tree view]], the [[Property_editor|property editor]], the [[Task_panel|task panel]], and the [[Python_console|Python console]].
* [[Mouse_navigation|Mouse navigation]]: the different types of using the mouse or trackpad to navigate in the 3D view.
* [[Selection_methods|Selection methods]]: the different methods of selecting objects in the software.
* [[Object_name|Objects naming]]: FreeCAD objects have a read-only {{incode|Name}} that uniquely identifies them, and a {{incode|Label}} which is user editable.
* [[Preferences_Editor|Preferences Editor]]: the system that allows you to control many properties of the base system and of the individual workbenches.
* [[Preferences_Editor|Preferences Editor]]: the system that allows you to control many properties of the base system and of the individual workbenches.
* [[Workbenches|Workbenches]]: how the FreeCAD interface is organized
* [[Import_Export|File formats]]: the different file formats that FreeCAD can read and write.
* [[Import_Export|File formats]]: the different file formats that FreeCAD can read and write.


===Workbenches=== <!--T:10-->
===Workbenches=== <!--T:10-->
These are the base workbenches bundled with every installation of FreeCAD:


<!--T:11-->
<!--T:33-->
[[Workbenches|Workbenches]] are collections of tools used for specific tasks. These are the base workbenches bundled with every FreeCAD installation:
* [[Image:Workbench_Arch.svg|24px]] Use the [[Arch Module|Arch Workbench]] to work with architectural elements.
* [[Image:Workbench_Complete.svg|24px]] The [[Complete_Workbench|Complete Workbench]] holds all commands and features from all the modules and workbenches which met certain quality criteria.
* [[Image:Workbench_Draft.svg|24px]] The [[Draft Module|Draft Workbench]] contains 2D tools and basic 2D and 3D CAD operations.
* [[Image:Workbench_Drawing.svg|24px]] Use the [[Drawing Module|Drawing Workbench]] to display your 3D work on a 2D sheet.
* [[Image:Workbench_FEM.svg|24px]] The [[FEM Module|FEM Workbench]] provides a [https://en.wikipedia.org/wiki/Finite_element_method Finite Element Analysis] (FEA) workflow.


<!--T:26-->
<!--T:42-->
<!--Please keep this list consistent with Online_Help_Toc and Workbenches-->
* [[Image:Workbench_Image.svg|24px]] Use the [[Image Module|Image Workbench]] to work with bitmap images.
* [[Image:Workbench_Inspection.svg|24px]] The [[Inspection Workbench|Inspection Workbench]] provides specific tools for examination of shapes. It is still in development.
* [[Image:Freecad.svg|32px]] [[Std_Base|Standard tools]]. These commands and tools are present in all workbenches.
* [[Image:Workbench_Mesh.svg|24px]] Use the [[Mesh Module|Mesh Workbench]] to work with triangulated meshes.
* [[Image:Workbench_OpenSCAD.svg|24px]] The [[OpenSCAD Module|OpenSCAD Workbench]] for interoperability with OpenSCAD and repairing Constructive Solid Geometry (CSG) model history.
* [[Image:Workbench_Part.svg|24px]] Use the [[Part Module|Part Workbench]] to work with CAD parts.


<!--T:27-->
<!--T:43-->
* [[Image:Workbench_PartDesign.svg|24px]] Use the [[PartDesign Workbench|Part Design Workbench]] to build Part shapes from sketches.
* [[Image:Workbench_Arch.svg|32px]] The [[Arch_Workbench|Arch Workbench]] for working with architectural elements.
* [[Image:Workbench_Path.svg|24px]] Use the [[Path_Workbench|Path Workbench]] to produce G-Code instructions. It is still in a stage of development. Only basic functions in 0.16
* [[Image:Workbench_Plot.svg|24px]] Use the [[Plot Module|Plot Workbench]] to edit and save output plots created from other modules and tools.
* [[Image:Workbench_Points.svg|24px]] Use the [[Points_Module|Points Workbench]] to work with point clouds.
* [[Image:Workbench_Raytracing.svg|24px]] Use the [[Raytracing Module|Raytracing Workbench]] to work with ray-tracing (rendering)


<!--T:28-->
<!--T:65-->
* [[Image:Workbench_CAM.svg|32px]] The [[CAM_Workbench|CAM Workbench]] is used to produce G-Code instructions. This workbench was called "Path Workbench" in {{VersionMinus|0.21}}.
* [[Image:Workbench_Reverse_Engineering.svg|24px]] The [[Reverse Engineering Workbench|Reverse Engineering Workbench]] is intended to give you specific tools to convert shapes/solids/meshes into parametric FreeCAD-compatible features. It is still in development.
* [[Image:Workbench_Robot.svg|24px]] Use the [[Robot_Workbench|Robot Workbench]] to study robot movements.
* [[Image:Workbench_Ship.svg|24px]] The [[Ship Workbench|Ship Workbench]] FreeCAD-Ship works over Ship entities, that must be created on top of provided geometry.
* [[Image:Workbench_Sketcher.svg|24px]] Use the [[Sketcher Module|Sketcher Workbench]] to work with geometry-constrained sketches.
* [[Image:Workbench_Spreadsheet.svg|24px]] Use the [[Spreadsheet Module|Spreadsheet Workbench]] to create and manipulating spreadsheet data.


<!--T:29-->
<!--T:44-->
* [[Image:Workbench_Start.svg|24px]] The [[Start_Workbench|Start Center Workbench]] allows you to quickly jump to the most common workbenches.
* [[Image:Workbench_Draft.svg|32px]] The [[Draft_Workbench|Draft Workbench]] contains 2D tools and basic 2D and 3D CAD operations.

* [[Image:Workbench_Surface.svg|24px]] The [[Surface_Module|Surface Module]] the Surface workbench provides tools to create and modify surfaces.
<!--T:45-->
* [[Image:Workbench_TechDraw.svg|24px]] The [[TechDraw Module|TechDraw Workbench]] is the more advanced and feature-rich successor of [[Drawing Module|Drawing]]
* [[Image:Workbench_Test.svg|24px]] The [[Testing|Test Framework Workbench]] is for debugging FreeCAD.
* [[Image:Workbench_FEM.svg|32px]] The [[FEM_Workbench|FEM Workbench]] provides Finite Element Analysis (FEA) workflow.

* [[Image:Workbench_Web.svg|24px]] The [[Web Workbench|Web Workbench]] provides you with a browser window instead of the 3D-View within FreeCAD.
<!--T:47-->
* [[Image:Workbench_Inspection.svg|32px]] The [[Inspection_Workbench|Inspection Workbench]] is made to give you specific tools for examination of shapes. Still in the early stages of development.

<!--T:48-->
* [[Image:Workbench_Mesh.svg|32px]] The [[Mesh_Workbench|Mesh Workbench]] for working with triangulated meshes.

<!--T:49-->
* [[Image:Workbench_OpenSCAD.svg|32px]] The [[OpenSCAD_Workbench|OpenSCAD Workbench]] for interoperability with OpenSCAD and repairing [[Constructive_solid_geometry|constructive solid geometry]] (CSG) model history.

<!--T:50-->
* [[Image:Workbench_Part.svg|32px]] The [[Part_Workbench|Part Workbench]] for working with geometric primitives and boolean operations.

<!--T:51-->
* [[Image:Workbench_PartDesign.svg|32px]] The [[PartDesign_Workbench|Part Design Workbench]] for building Part shapes from sketches.

<!--T:53-->
* [[Image:Workbench_Points.svg|32px]] The [[Points_Workbench|Points Workbench]] for working with point clouds.

<!--T:55-->
* [[Image:Workbench_Reverse_Engineering.svg|32px]] The [[Reverse_Engineering_Workbench|Reverse Engineering Workbench]] is intended to provide specific tools to convert shapes/solids/meshes into parametric FreeCAD-compatible features.

<!--T:56-->
* [[Image:Workbench_Robot.svg|32px]] The [[Robot_Workbench|Robot Workbench]] for studying robot movements. Currently unmaintained.

<!--T:57-->
* [[Image:Workbench_Sketcher.svg|32px]] The [[Sketcher_Workbench|Sketcher Workbench]] for working with geometry-constrained sketches.

<!--T:58-->
* [[Image:Workbench_Spreadsheet.svg|32px]] The [[Spreadsheet_Workbench|Spreadsheet Workbench]] for creating and manipulating spreadsheet data.

<!--T:59-->
* [[Image:Workbench_Start.svg|32px]] The [[Start_Workbench|Start Workbench]] allows you to quickly jump to one of the most common workbenches.

<!--T:60-->
* [[Image:Workbench_Surface.svg|32px]] The [[Surface_Workbench|Surface Workbench]] provides tools to create and modify surfaces. It is similar to the [[Part_Builder|Part Builder]] Face from edges option.

<!--T:61-->
* [[Image:Workbench_TechDraw.svg|32px]] The [[TechDraw_Workbench|TechDraw Workbench]] for producing technical drawings from 3D models.

<!--T:62-->
* [[Image:Workbench_Test.svg|32px]] The [[Testing|Test Framework Workbench]] is for debugging FreeCAD.

<!--T:63-->
* [[Image:Workbench_Web.svg|32px]] The [[Web_Workbench|Web Workbench]] provides you with a browser window instead of the [[3D view|3D view]] within FreeCAD.


===Macros=== <!--T:24-->
===Macros=== <!--T:24-->


<!--T:35-->
[[Macros|macros]] are relatively small snippets of [[Python|Python]] code that perform a simple or complex task that is not available in the base FreeCAD system.
[[Macros|Macros]] are relatively small snippets of [[Python|Python]] code that perform a simple or a complex task that is not available in the base FreeCAD system.


<!--T:36-->
Power users have written various [[macros|macros]] to enhance FreeCAD with more capabilities.
Power users have written various [[macros|macros]] to enhance FreeCAD with more capabilities.


<!--T:32-->
<!--T:32-->
Since FreeCAD 0.17, many macros can be installed using the [[Std AddonMgr|Addon Manager]]. For a list of the macros refer to the [[macros recipes|macros recipes]] page. For manual installation see [[How to install macros|How to install macros]].
Since FreeCAD 0.17, many macros can be installed using the [[Std_AddonMgr|Addon Manager]]. For a list of the macros refer to the [[Macros_recipes|Macros recipes]] page. For manual installation see [[How_to_install_macros|How to install macros]].


===External Workbenches=== <!--T:23-->
===External workbenches=== <!--T:23-->


<!--T:37-->
When many macros or functions are put together, and are organized in toolbars and menus, they can become a new workbench.
When many macros or functions are developed together, and are organized in toolbars and menus, they can become a new workbench.


<!--T:38-->
[[External_workbenches|External workbenches]] are collections of functions that are not part of the base FreeCAD system, usually developed by experienced users, and targeting a particular need.
[[External_workbenches|External workbenches]] are collections of functions that are not part of the base FreeCAD system, usually developed by experienced users, and targeting a particular need.


<!--T:31-->
<!--T:31-->
Since FreeCAD 0.17, many workbenches can be installed using the [[Std AddonMgr|Addon Manager]]. For manual installation see [[How to install additional workbenches|How to install additional workbenches]].
Since FreeCAD 0.17, many workbenches can be installed using the [[Std_AddonMgr|Addon Manager]]. For manual installation see [[How_to_install_additional_workbenches|How to install additional workbenches]].


==Reference== <!--T:12-->
==Reference== <!--T:12-->


<!--T:13-->
<!--T:13-->
* [[List of Commands|Commands Reference]]: A complete list of the available FreeCAD commands.
* [[List_of_Commands|Commands Reference]]: A complete list of the available FreeCAD commands.


== Online Help == <!--T:14-->
== Online Help == <!--T:14-->
Line 128: Line 158:


<!--T:18-->
<!--T:18-->
* The [[Power users hub|Power users hub]] is the place to go if you would like to see more advanced use of FreeCAD
* The [[Power_users_hub|Power users hub]] is the place to go if you would like to see more advanced use of FreeCAD
* The [[FreeCAD Community Portal|FreeCAD Community Portal]] lists projects made by community members around FreeCAD.
* The [[FreeCAD_Community_Portal|FreeCAD Community Portal]] lists projects made by community members around FreeCAD.
* Don't understand a term or phrase as used in FreeCAD? Try the [[Glossary|Glossary]] page.
* Don't understand a term or phrase as used in FreeCAD? Try the [[Glossary|Glossary]] page.

<!--T:30-->
{{Userdocnavi}}

<!--T:20-->
[[Category:Hubs]]
[[Category:User Documentation]]





</translate>
</translate>
{{Userdocnavi{{#translation:}}}}
[[Category:Hubs{{#translation:}}]]

Latest revision as of 09:09, 18 March 2024


This is the main help area for newcomers to FreeCAD.

FreeCAD is in continuous development, so there may be missing or outdated information. If you cannot find the information that you need, don't hesitate to ask in the FreeCAD forum.

If you'd like to contribute to FreeCAD, please donate, and see the Help FreeCAD page for other ways to contribute. If you'd like to edit this wiki, request a wiki account with editor permissions in the forum, and read the WikiPages for the general guidelines that you should follow.

If you would like to know how FreeCAD started years ago visit the History page.

Using FreeCAD

Introduction

Migrating from other software?

Basic application

Workbenches

Workbenches are collections of tools used for specific tasks. These are the base workbenches bundled with every FreeCAD installation:

  • Standard tools. These commands and tools are present in all workbenches.
  • The CAM Workbench is used to produce G-Code instructions. This workbench was called "Path Workbench" in version 0.21 and below.
  • The FEM Workbench provides Finite Element Analysis (FEA) workflow.
  • The Inspection Workbench is made to give you specific tools for examination of shapes. Still in the early stages of development.
  • The Part Workbench for working with geometric primitives and boolean operations.
  • The Reverse Engineering Workbench is intended to provide specific tools to convert shapes/solids/meshes into parametric FreeCAD-compatible features.
  • The Start Workbench allows you to quickly jump to one of the most common workbenches.

Macros

Macros are relatively small snippets of Python code that perform a simple or a complex task that is not available in the base FreeCAD system.

Power users have written various macros to enhance FreeCAD with more capabilities.

Since FreeCAD 0.17, many macros can be installed using the Addon Manager. For a list of the macros refer to the Macros recipes page. For manual installation see How to install macros.

External workbenches

When many macros or functions are developed together, and are organized in toolbars and menus, they can become a new workbench.

External workbenches are collections of functions that are not part of the base FreeCAD system, usually developed by experienced users, and targeting a particular need.

Since FreeCAD 0.17, many workbenches can be installed using the Addon Manager. For manual installation see How to install additional workbenches.

Reference

Online Help

This is the official FreeCAD online help. Please note that the whole online help system is currently being reworked. It will be used to generate a .CHM file, that will be distributed with the binary packages of FreeCAD. At the moment the online help summarizes some of the most complete sections of this wiki.

More

  • The Power users hub is the place to go if you would like to see more advanced use of FreeCAD
  • The FreeCAD Community Portal lists projects made by community members around FreeCAD.
  • Don't understand a term or phrase as used in FreeCAD? Try the Glossary page.