User hub: Difference between revisions

From FreeCAD Documentation
(macros are relatively small snippets of Python code)
(Changed text of Part and PartDesign, and various details like links, full stops.)
Line 50: Line 50:
* [[Mouse Model|Mouse navigation]]: the different types of using the mouse or trackpad to navigate in the 3D view.
* [[Mouse Model|Mouse navigation]]: the different types of using the mouse or trackpad to navigate in the 3D view.
* [[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-->

[[Workbenches|Workbenches]] are collections of tools that are used for a relatively specific task.

These are the base workbenches bundled with every installation of FreeCAD:
These are the base workbenches bundled with every installation of FreeCAD:


Line 67: Line 69:
* [[Image:Workbench_Inspection.svg|24px]] The [[Inspection Workbench|Inspection Workbench]] provides specific tools for examination of shapes. It is still in development.
* [[Image:Workbench_Inspection.svg|24px]] The [[Inspection Workbench|Inspection Workbench]] provides specific tools for examination of shapes. It is still in development.
* [[Image:Workbench_Mesh.svg|24px]] Use the [[Mesh Module|Mesh Workbench]] to work with triangulated meshes.
* [[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_OpenSCAD.svg|24px]] The [[OpenSCAD Module|OpenSCAD Workbench]] for interoperability with OpenSCAD and repairing [[constructive solid geometry|constructive solid geometry]] (CSG) model history.
* [[Image:Workbench_Part.svg|24px]] Use the [[Part Module|Part Workbench]] to work with CAD parts.
* [[Image:Workbench_Part.svg|24px]] Use the [[Part Module|Part Workbench]] to design solids with [[constructive solid geometry|constructive solid geometry]] (CSG) workflow.


<!--T:27-->
<!--T:27-->
* [[Image:Workbench_PartDesign.svg|24px]] Use the [[PartDesign Workbench|Part Design Workbench]] to build Part shapes from sketches.
* [[Image:Workbench_PartDesign.svg|24px]] Use the [[PartDesign Workbench|PartDesign Workbench]] to build solids from sketches and parametric operations in what is called [[feature editing|feature editing]] workflow.
* [[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_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_Plot.svg|24px]] Use the [[Plot Module|Plot Workbench]] to edit and save output plots created from other workbenches and tools.
* [[Image:Workbench_Points.svg|24px]] Use the [[Points_Module|Points Workbench]] to work with point clouds.
* [[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)
* [[Image:Workbench_Raytracing.svg|24px]] Use the [[Raytracing Module|Raytracing Workbench]] to work with rendering and ray-tracing.


<!--T:28-->
<!--T:28-->
Line 87: Line 89:
* [[Image:Workbench_Start.svg|24px]] The [[Start_Workbench|Start Center Workbench]] allows you to quickly jump to the most common workbenches.
* [[Image:Workbench_Start.svg|24px]] The [[Start_Workbench|Start Center Workbench]] allows you to quickly jump to the most common workbenches.
* [[Image:Workbench_Surface.svg|24px]] The [[Surface_Module|Surface Module]] the Surface workbench provides tools to create and modify surfaces.
* [[Image:Workbench_Surface.svg|24px]] The [[Surface_Module|Surface Module]] the Surface workbench provides tools to create and modify surfaces.
* [[Image:Workbench_TechDraw.svg|24px]] The [[TechDraw Module|TechDraw Workbench]] is the more advanced and feature-rich successor of [[Drawing Module|Drawing]]
* [[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_Test.svg|24px]] The [[Testing|Test Framework Workbench]] is for debugging FreeCAD.
* [[Image:Workbench_Web.svg|24px]] The [[Web Workbench|Web Workbench]] provides you with a browser window instead of the 3D-View within FreeCAD.
* [[Image:Workbench_Web.svg|24px]] The [[Web Workbench|Web Workbench]] provides you with a browser window instead of the 3D-View within FreeCAD.
Line 93: Line 95:
===Macros=== <!--T:24-->
===Macros=== <!--T:24-->


[[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.


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.
Line 100: Line 102:
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-->


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.


[[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.

Revision as of 02:52, 28 September 2019


150
150

This is the main help area for newcomers to FreeCAD.

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 FreeCAD forum.

If you'd like to contribute to FreeCAD, see the Help FreeCAD page. 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

Basic Application

  • Interface: the FreeCAD interface is composed of various graphical elements on the screen.
    • 3D view: the area where 2D and 3D geometry is drawn.
    • Combo view: the panel that contains the tree view, the task panel, and the property editor.
    • Tree view: the element that shows all objects in the document and their parametric history.
    • Task panel: the panel that shows different actions and options depending on the drawing tool selected.
    • Property editor: the place where object properties are modified.
    • Selection view: the panel that shows elements that are currently selected.
    • Report view: the text box that shows different messages from the application and its tools.
    • Python console: the editor that allows you to run Python code interactively, and see results in the 3D view.
    • DAG view: an alternative to the tree view, which shows the relationships between different objects in the document through a graph.
    • Interface Customization: how to configure the toolbars with custom tools.
  • Mouse navigation: the different types of using the mouse or trackpad to navigate in the 3D view.
  • Preferences Editor: the system that allows you to control many properties of the base system and of the individual workbenches.
  • File formats: the different file formats that FreeCAD can read and write.

Workbenches

Workbenches are collections of tools that are used for a relatively specific task.

These are the base workbenches bundled with every installation of FreeCAD:

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.