Draft Workbench: Difference between revisions

From FreeCAD Documentation
No edit summary
(Module to Workbench renaming.)
Line 20: Line 20:


<!--T:1-->
<!--T:1-->
The [[File:Workbench_Draft.svg|32px]] [[Draft_Module|Draft Workbench]] allows you to draw simple 2D objects, and offers several tools to modify them afterwards. It also provides tools to define a working plane, a grid, and a snapping system to precisely control the position of your geometry.
The [[File:Workbench_Draft.svg|32px]] [[Draft_Workbench|Draft Workbench]] allows you to draw simple 2D objects, and offers several tools to modify them afterwards. It also provides tools to define a working plane, a grid, and a snapping system to precisely control the position of your geometry.


<!--T:29-->
<!--T:29-->
Line 127: Line 127:
* [[Image:Draft_ToggleConstructionMode.svg|32px]] [[Draft_ToggleConstructionMode|Toggle construction mode]]: switches Draft construction mode on or off.
* [[Image:Draft_ToggleConstructionMode.svg|32px]] [[Draft_ToggleConstructionMode|Toggle construction mode]]: switches Draft construction mode on or off.


* [[Image:Draft_AutoGroup.svg|32px]] [[Draft_AutoGroup|AutoGroup]]: changes the active [[Draft_Layer|Draft Layer]] or, optionally, the active [[Std_Group|Std Group]] or group-like [[Arch_Module|Arch]] object.
* [[Image:Draft_AutoGroup.svg|32px]] [[Draft_AutoGroup|AutoGroup]]: changes the active [[Draft_Layer|Draft Layer]] or, optionally, the active [[Std_Group|Std Group]] or group-like [[Arch_Workbench|Arch]] object.


== Draft annotation scale widget == <!--T:69-->
== Draft annotation scale widget == <!--T:69-->
Line 281: Line 281:


<!--T:4-->
<!--T:4-->
These are functions for opening, importing or exporting other file formats. Opening will open a new document with the contents of the file, while importing will append the contents of the file to the current document. Export will save the selected objects to a file. If nothing is selected, all objects will be exported. Be aware that the purpose of the Draft Module is to work with 2D objects, so those import routines focus only on 2D objects, and although DXF and OCA formats also support object definitions in 3D space (objects are not necessarily flat), they will not import volumetric objects such as meshes, 3D surfaces, etc., but rather lines, circles, texts or flat shapes. Currently supported file formats are:
These are functions for opening, importing or exporting other file formats. Opening will open a new document with the contents of the file, while importing will append the contents of the file to the current document. Export will save the selected objects to a file. If nothing is selected, all objects will be exported. Be aware that the purpose of the Draft Workbench is to work with 2D objects, so those import routines focus only on 2D objects, and although DXF and OCA formats also support object definitions in 3D space (objects are not necessarily flat), they will not import volumetric objects such as meshes, 3D surfaces, etc., but rather lines, circles, texts or flat shapes. Currently supported file formats are:
The Draft module provides FreeCAD with importers and exporters for the following file formats:
The Draft Workbench provides FreeCAD with importers and exporters for the following file formats:


<!--T:5-->
<!--T:5-->
* [[Draft_DXF|Autodesk .DXF]]: imports and exports [http://en.wikipedia.org/wiki/AutoCAD_DXF Drawing Exchange Format] files created with 2D CAD applications. See also [[FreeCAD_and_DXF_Import|FreeCAD and DXF Import]].
* [[Draft_DXF|Autodesk .DXF]]: imports and exports [http://en.wikipedia.org/wiki/AutoCAD_DXF Drawing Exchange Format] files created with 2D CAD applications. See also [[FreeCAD_and_DXF_Import|FreeCAD and DXF Import]].
* [[Draft_DXF|Autodesk .DWG]]: imports and exports DWG files via the DXF importer, when the [[Extra python modules#ODA Converter (previously Teigha Converter)|ODA Converter]] utility is installed. See also [[FreeCAD_and_DWG_Import|FreeCAD and DWG Import]].
* [[Draft_DXF|Autodesk .DWG]]: imports and exports DWG files via the DXF importer, when the [[Extra_python_modules#ODA_Converter_(previously_Teigha_Converter)|ODA Converter]] utility is installed. See also [[FreeCAD_and_DWG_Import|FreeCAD and DWG Import]].
* [[Draft_SVG|Scalable Vector Graphics .SVG]]: imports and exports [http://en.wikipedia.org/wiki/Scalable_Vector_Graphics Scalable Vector Graphics] files created with vector drawing applications.
* [[Draft_SVG|Scalable Vector Graphics .SVG]]: imports and exports [http://en.wikipedia.org/wiki/Scalable_Vector_Graphics Scalable Vector Graphics] files created with vector drawing applications.
* [[Draft_OCA|Open Cad format .OCA]]: imports and exports OCA/GCAD files, a potentially new [http://groups.google.com/group/open_cad_format open CAD file format].
* [[Draft_OCA|Open Cad format .OCA]]: imports and exports OCA/GCAD files, a potentially new [http://groups.google.com/group/open_cad_format open CAD file format].

Revision as of 19:51, 24 August 2021

This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.
Draft workbench icon

Introduction

The Draft Workbench allows you to draw simple 2D objects, and offers several tools to modify them afterwards. It also provides tools to define a working plane, a grid, and a snapping system to precisely control the position of your geometry.

The created 2D objects can be used for general drafting in a way similar as is done with Inkscape or Autocad. These 2D shapes can also be used as the base components of 3D objects created with other workbenches, for example, the Part and Arch Workbenches. Conversion of Draft objects to Sketches is also possible, which means that the shapes can also be used with the PartDesign Workbench for the creation of solid bodies.

FreeCAD is primarily a 3D modelling application, and thus its 2D tools aren't as advanced as in other drawing programs. If your primary goal is the production of complex 2D drawings and DXF files, and you don't need 3D modelling, you may wish to consider a dedicated software program for technical drafting such as LibreCAD, QCad, or others.

Draft Workbench Example

Drawing objects

These are tools for creating objects.

  • Line: draws a line segment between two points.
  • Polyline: draws a line made of multiple line segments (polyline).
  • Fillet: draws a fillet (rounded corner) or a chamfer (straight line) between two simple Lines. introduced in version 0.19
  • Arc: draws an arc segment from center, radius, start angle and end angle.
  • Arc 3Points: draws a circular arc segment from three points that are located in the circumference. introduced in version 0.19
  • Circle: draws a circle from center and radius.
  • Ellipse: draws an ellipse from two corner points.
  • Rectangle: draws a rectangle from two corner points.
  • Polygon: draws a regular polygon from center, radius, and number of sides.
  • BSpline: draws a B-Spline from a series of points.
  • Cubic Bezier Curve: draws a Bezier curve of third degree by dragging two points. introduced in version 0.19
  • Bezier Curve: draws a Bezier curve from a series of points.
  • Point: inserts a point object.
  • Facebinder: creates a new object from selected faces on existing objects.
  • ShapeString: inserts a compound shape representing a text string at a given point.

Annotation objects

Modifying objects

These are tools for modifying existing objects. They work on selected objects, but if no object is selected, you will be invited to select one.

Many operation tools (move, rotate, array, etc.) also work on solid objects (Part, PartDesign, Arch, etc.).

  • Move: moves objects from one location to another.
  • Rotate: rotates objects from a start angle to an end angle.
  • Scale: scales selected objects around a base point.
  • Mirror: mirrors the selected objects.
  • Offset: offsets segments of an object a certain distance.
  • Trim/Extend (Trimex): trims or extends an object.
  • Stretch: stretches the selected objects.
  • Join: joins lines together into a single wire.
  • Split: splits a wire into two at a point.
  • Upgrade: upgrades objects into a higher-level object.
  • Downgrade: downgrades objects into lower-level objects.
  • Shape 2D View: creates a 2D object which is a flattened 2D view of a 3D object.

Draft Tray

The Draft Tray allows selecting the working plane, defining style settings, toggling construction mode, and specifying the active layer or group.

Its tools are also available in the Draft → Utilities menu:

Draft annotation scale widget

With the Draft annotation scale widget the Draft annotation scale can be specified. introduced in version 0.19

Draft snap widget

The Draft snap widget can be used as an alternative for the Draft Snap toolbar. introduced in version 0.19

Draft Snap toolbar

The Draft Snap toolbar allows selecting the active snap options. The buttons belonging to active options stay depressed. For general information about snapping see: Draft Snap.

  • Toggle snap: toggles object snapping globally on or off.
  • Endpoint: snaps to the endpoints of line, arc and spline segments.
  • Midpoint: snaps to the middle point of line and arc segments.
  • Center: snaps to the center point of circles, arcs and faces, WP proxies and Building parts
  • Angle: snaps to the special cardinal points of circles and arcs, at 45° and 90°.
  • Intersection: snaps to the intersection of two line or arc segments. Hover the mouse over the two desired objects to activate their intersection snaps.
  • Perpendicular: on line and arc segments, snaps perpendicularly to the latest point.
  • Extension: snaps on an imaginary line that extends beyond the endpoints of line segments. Hover the mouse over the desired object to activate its extension snap.
  • Parallel: snaps on an imaginary line parallel to a line segment. Hover the mouse over the desired object to activate its parallel snap.
  • Special: snaps on special points defined by the object.
  • Near: snaps to the closest point or edge on the nearest object.
  • Ortho: snaps on imaginary lines that cross the last point, and extend at 0°, 45° and 90°.
  • Grid: snaps to the intersections of the grid lines, if the grid is visible.
  • Working plane: always places the snapped point on the current working plane, even if you snap to a point outside that working plane.
  • Dimensions: shows temporary X and Y dimensions while snapping.
  • Toggle grid: toggles the visibility of the grid on or off.

Draft utility tools toolbar

Additional tools

The Draft → Utilities menu contains several tools. Most of them can also be accessed from toolbars or the Draft Tray and have already been mentioned above. For the following tools this is not the case:

Additional features

  • Working plane: allows you to select a surface on which to build your shapes.
  • Snapping: place new points on special places on existing objects or on the grid.
  • Constraining: limits the cursor to horizontal or vertical movements relative to a previous point.
  • Construction mode: places created geometry objects in a dedicated group making it easier to switch them on and off.
  • Pattern: Draft objects with a face can display a hatch pattern.

Tree view context menu

The following additional options are available in the Tree view context menu:

Selection options

If there is a selection the context menu contains one additional sub-menu:

  • Utilities: a subset of the tools available in the main Draft Utilities menu.

Wire options

For a Draft Wire, Draft BSpline, Draft CubicBezCurve and Draft BezCurve this additional option is available:

  • Flatten this wire: flattens the wire based on its internal geometry. This option currently does not work properly.

Layer container options

For a Draft LayerContainer these additional options are available:

  • Merge layer duplicates: this option currently does not work.

Layer options

For a Draft Layer these additional options are available:

Working plane proxy options

For a Draft WorkingPlaneProxy these additional options are available:

  • Write objects state: updates the visibility state of objects stored in the working plane proxy.

3D view context menu

The following additional options are available in the 3D view context menu:

No-selection options

If there is no selection the context menu contains one additional sub-menu:

  • Utilities: a subset of the tools available in the main Draft Utilities menu.

Selection options

If there is a selection the context menu contains two additional sub-menus:

Obsolete tools

These commands are obsolete but still available:

These 3D view context menu options are still available when the Draft Wire, Draft BSpline, Draft CubicBezCurve or Draft BezCurve command is active but will be removed in the near future:

Preferences

  • Preferences: general preferences for the working plane and the drawing tools.
  • Import Export Preferences: preferences available for importing from and exporting to different file formats.

File formats

These are functions for opening, importing or exporting other file formats. Opening will open a new document with the contents of the file, while importing will append the contents of the file to the current document. Export will save the selected objects to a file. If nothing is selected, all objects will be exported. Be aware that the purpose of the Draft Workbench is to work with 2D objects, so those import routines focus only on 2D objects, and although DXF and OCA formats also support object definitions in 3D space (objects are not necessarily flat), they will not import volumetric objects such as meshes, 3D surfaces, etc., but rather lines, circles, texts or flat shapes. Currently supported file formats are: The Draft Workbench provides FreeCAD with importers and exporters for the following file formats:

Install importers

Unit tests

See also: Test Workbench.

To run the unit tests of the workbench execute the following from the operating system terminal.

freecad -t TestDraft

Scripting

The Draft tools can be used in macros and from the Python console by using the Draft API.

The workbench includes a module to create samples of all objects in a new document. introduced in version 0.19

Use this to test that all objects are produced correctly.

import drafttests.draft_test_objects as dto
doc = dto.create_test_file()

Inspecting the code of this module is useful to understand how to use the programming interface.

$INSTALLDIR/Mod/Draft/drafttests/draft_test_objects.py

Where $INSTALLDIR is the toplevel directory where the software was installed; for example, in Linux it may be /usr/share/freecad.

Test objects for the Draft Workbench.

Tutorials