Draft Workbench: Difference between revisions

From FreeCAD Documentation
(Fixed Draft_ToggleGrid link.)
(231 intermediate revisions by 22 users not shown)
Line 1: Line 1:
<languages/>
The draft Module is a work-in-progress and quite experimental module made to add basic 2d drawing functionality to FreeCAD. It is written entirely in python, and is also intended to showcase how far you can extend FreeCAD entirely in python, without even touching the source code. This module is currently developed outside of the main FreeCAD development structure.
<translate>
<!--T:32-->
{{Docnav
|[[Arch Workbench|Arch Workbench]]
|[[Drawing Workbench|Drawing Workbench]]
|IconL=Workbench_Arch.svg
|IconR=Workbench_Drawing.svg
}}


<!--T:38-->
Currently it is not really usable for production work, but already contains a couple of working basic functions. Feel free to test, and give us a feedback on the discussion page!
[[Image:Workbench_Draft.svg|thumb|128px|Draft workbench icon]]


</translate>
I also maintain a workplan of the whole thing [http://yorik.orgfree.com/scripts/FreeCAD-draft.html here].
{{TOCright}}
<translate>


== Introduction == <!--T:68-->
==Installation==


<!--T:1-->
The draft Module is currently not part of the FreeCAD package, so you'll need to download it from here:
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.
http://yorik.orgfree.com/scripts/Draft.zip
The zipfile here above contains just a "draft" directory. To install the module, simply place that directory into the "Mod" directory of FreeCAD.


<!--T:29-->
Please note that the draft module requires two specific python modules to be installed and working on your system, PyQt4 and Pyvy. Instructions for installing or compiling these modules can be found on the [[extra python modules]] page.
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 [[File:Workbench_Part.svg|32px]] [[Part_Workbench|Part]] and [[File:Workbench_Arch.svg|32px]] [[Arch_Workbench|Arch Workbenches]]. Conversion of Draft objects to [[File:Workbench_Sketcher.svg|32px]] [[Sketcher_Workbench|Sketches]] is also possible, which means that the shapes can also be used with the [[File:Workbench_PartDesign.svg|32px]] [[PartDesign_Workbench|PartDesign Workbench]] for the creation of solid bodies.


<!--T:30-->
==General use==
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|DXF]] files, and you don't need 3D modelling, you may wish to consider a dedicated software program for technical drafting such as [https://en.wikipedia.org/wiki/LibreCAD LibreCAD], [https://en.wikipedia.org/wiki/QCad QCad], or others.


</translate>
Once installed, the draft workbench will be availible in your workbenches list. When you activate it, two toolbars will be loaded; a classical toolbar containing the standard draft commands listed below and a special toolbar that has no command on it, but that is used by the different functions to display their controls. On that toolbar, you can also change general things like current line color and width.
[[Image:Draft_Workbench_Example.png|400px|Draft Workbench Example]]
<translate>


== Drawing objects == <!--T:16-->
One thing is important to know, the draft workbench doesn't put you automatically in orthographic projection (why would it?). So before drawing, make sure you are in orthographic projection and in the appropriate view.


<!--T:17-->
==Import functions==
These are tools for creating objects.


<!--T:18-->
===Autodesk DXF===
* [[Image:Draft_Line.svg|32px]] [[Draft_Line|Line]]: draws a line segment between two points.
* [[Image:Draft_Wire.svg|32px]] [[Draft_Wire|Polyline]]: draws a line made of multiple line segments (polyline).
* [[Image:Draft_Fillet.svg|32px]] [[Draft_Fillet|Fillet]]: draws a fillet (rounded corner) or a chamfer (straight line) between two simple [[Draft_Line|Lines]]. {{Version|0.19}}
* [[Image:Draft_Arc.svg|32px]] [[Draft_Arc|Arc]]: draws an arc segment from center, radius, start angle and end angle.
* [[Image:Draft_Arc_3Points.svg|32px]] [[Draft_Arc_3Points|Arc 3Points]]: draws a circular arc segment from three points that are located in the circumference. {{Version|0.19}}
* [[Image:Draft_Circle.svg|32px]] [[Draft_Circle|Circle]]: draws a circle from center and radius.
* [[Image:Draft_Ellipse.svg|32px]] [[Draft_Ellipse|Ellipse]]: draws an ellipse from two corner points.
* [[Image:Draft_Rectangle.svg|32px]] [[Draft_Rectangle|Rectangle]]: draws a rectangle from two corner points.
* [[Image:Draft_Polygon.svg|32px]] [[Draft_Polygon|Polygon]]: draws a regular polygon from center, radius, and number of sides.
* [[Image:Draft_BSpline.svg|32px]] [[Draft_BSpline|BSpline]]: draws a B-Spline from a series of points.
* [[Image:Draft_CubicBezCurve.svg|32px]] [[Draft_CubicBezCurve|Cubic Bezier Curve]]: draws a Bezier curve of third degree by dragging two points. {{Version|0.19}}
* [[Image:Draft_BezCurve.svg|32px]] [[Draft_BezCurve|Bezier Curve]]: draws a Bezier curve from a series of points.
* [[Image:Draft_Point.svg|32px]] [[Draft_Point|Point]]: inserts a point object.
* [[Image:Draft_Facebinder.svg|32px]] [[Draft_Facebinder|Facebinder]]: creates a new object from selected faces on existing objects.
* [[Image:Draft_ShapeString.svg|32px]] [[Draft_ShapeString|ShapeString]]: inserts a compound shape representing a text string at a given point.


== Annotation objects == <!--T:46-->
File Menu > Open


<!--T:47-->
This function opens a DXF file (any version from 12 to 2007) in a new drawing.
* [[Image:Draft_Text.svg|32px]] [[Draft_Text|Text]]: draws a multi-line text annotation.
The color and linetype of objects is currently not used.
* [[Image:Draft_Dimension.svg|32px]] [[Draft_Dimension|Dimension]]: draws a dimension annotation.
DXF object types currently read by this script + implementation in FreeCAD:
* [[Image:Draft_Label.svg|32px]] [[Draft_Label|Label]]: places a label with an arrow pointing to a selected element. {{Version|0.17}}
* [[Image:Draft_AnnotationStyleEditor.svg|32px]] [[Draft_AnnotationStyleEditor|Annotation style editor]]: opens an editor to change the annotation style of these objects. {{Version|0.19}}


== Modifying objects == <!--T:19-->
* line: read and converted to FreeCAD Polygon
* lwpolyline: read and converted to FreeCAD Polygon w/ arcs straigthened
* text: read but no implementation in FreeCAD
* mtext: read but no implementation in FreeCAD
* circle: read and converted to FreeCAD Circle
* arc: read and converted to FreeCAD Circle
* layer: read and layers containing objects are conveted to FreeCAD Group
* block_record: read but no implementation in FreeCAD


<!--T:20-->
===SVG===
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.


<!--T:31-->
File Menu > Open
Many operation tools (move, rotate, array, etc.) also work on solid objects ([[Part Workbench|Part]], [[PartDesign Workbench|PartDesign]], [[Arch Workbench|Arch]], etc.).


<!--T:21-->
A function to import SVG files as workable 2D objects, in opposition to the built-in drawing module which imports svg files as sheet drawings.
* [[Image:Draft_Move.svg|32px]] [[Draft_Move|Move]]: moves objects from one location to another.
SVG objects that get imported at the moment:
* [[Image:Draft_Rotate.svg|32px]] [[Draft_Rotate|Rotate]]: rotates objects from a start angle to an end angle.
* [[Image:Draft_Scale.svg|32px]] [[Draft_Scale|Scale]]: scales selected objects around a base point.
* [[Image:Draft_Mirror.svg|32px]] [[Draft_Mirror|Mirror]]: mirrors the selected objects.
* [[Image:Draft_Offset.svg|32px]] [[Draft_Offset|Offset]]: offsets segments of an object a certain distance.
* [[Image:Draft_Trimex.svg|32px]] [[Draft_Trimex|Trim/Extend (Trimex)]]: trims or extends an object.
* [[Image:Draft_Stretch.svg|32px]] [[Draft_Stretch|Stretch]]: stretches the selected objects. {{Version|0.17}}


<!--T:52-->
* PATH objects with M, C, L or A commands: converted to FreeCAD polygon
* [[Image:Draft_Clone.svg|32px]] [[Draft_Clone|Clone]]: clones the selected objects.
* RECT objects: converted to FreeCAD polygon
* [[Image:Draft_Array.svg|32px]] Array tools.
** [[Image:Draft_OrthoArray.svg|32px]] [[Draft_OrthoArray|Ortho Array]]: creates an orthogonal array from the selected object. It can also create [[App_Link|App Link]] copies. {{Version|0.19}}
** [[File:Draft_PolarArray.svg|32px]] [[Draft_PolarArray|Polar Array]]: creates an array in a polar pattern, that is, sweeping an angle. It can also create [[App_Link|App Link]] copies. {{Version|0.19}}
** [[File:Draft_CircularArray.svg|32px]] [[Draft_CircularArray|Circular Array]]: creates an array in a circular pattern, that is, starting from a center and moving outwards radially. It can also create [[App_Link|App Link]] copies. {{Version|0.19}}
** [[Image:Draft_PathArray.svg|32px]] [[Draft_PathArray|Path Array]]: creates an array of objects by placing the copies along a path.
** [[Image:Draft_PathLinkArray.svg|32px]] [[Draft_PathLinkArray|Path LinkArray]]: like [[Image:Draft_PathArray.svg|32px]] [[Draft_PathArray|Path Array]], but creates [[App_Link|App Links]] instead of regular copies. {{Version|0.19}}
** [[Image:Draft_PointArray.svg|32px]] [[Draft_PointArray|Point Array]]: creates an array of objects by placing the copies at certain points. {{version|0.18}}
** [[File:Draft_PointLinkArray.svg|32px]] [[Draft_PointLinkArray|Point LinkArray]]: like [[Image:Draft_PointArray.svg|32px]] [[Draft_PointArray|Point Array]], but creates [[App_Link|App Links]] instead of regular copies. {{Version|0.19}}


<!--T:53-->
==Drawing functions==
* [[Image:Draft_Edit.svg|32px]] [[Draft_Edit|Edit]]: edits a selected object.
* [[Image:Draft_SubelementHighlight.svg|32px]] [[Draft_SubelementHighlight|Subelement highlight]]: enters an edit mode that allows editing different objects. {{Version|0.19}}


<!--T:54-->
===2-point Line===
* [[Image:Draft_Join.svg|32px]] [[Draft_Join|Join]]: joins lines together into a single wire. {{version|0.18}}
* [[Image:Draft_Split.svg|32px]] [[Draft_Split|Split]]: splits a wire into two at a point. {{version|0.18}}
* [[Image:Draft_Upgrade.svg|32px]] [[Draft_Upgrade|Upgrade]]: upgrades objects into a higher-level object.
* [[Image:Draft_Downgrade.svg|32px]] [[Draft_Downgrade|Downgrade]]: downgrades objects into lower-level objects.


<!--T:55-->
draft Toolbar > Line
* [[Image:Draft_WireToBSpline.svg|32px]] [[Draft_WireToBSpline|Wire to BSpline]]: converts a wire to a B-Spline and vice-versa.
Context menu > draft > Line
* [[Image:Draft_Draft2Sketch.svg|32px]] [[Draft_Draft2Sketch|Draft to Sketch]]: converts a Draft object to a [[Sketcher Workbench|Sketcher Workbench]] Sketch and vice-versa.
draft Menu > Line
* [[Image:Draft_Slope.svg|32px]] [[Draft Slope|Slope]]: changes the elevation slope of the currently selected [[Draft Line|Draft Line]] or [[Draft Wire|Draft Wire]]. {{Version|0.17}}
* [[Image:Draft_FlipDimension.svg|32px]] [[Draft_FlipDimension|Flip Dimension]]: flips the orientation of the text of a [[Draft Dimension|Draft Dimension]].


<!--T:56-->
This function asks the user for 2 points and draws a line betwen them. The newly created line will have the current color and width.
* [[Image:Draft_Shape2DView.svg|32px]] [[Draft_Shape2DView|Shape 2D View]]: creates a 2D object which is a flattened 2D view of a 3D object.
The points can be picked with the mouse in the 3d view or by entering corrdinates with the keyboard. Following functionality is availible:
* Picking a point on an empty area of the 3d view will return a point situated at your mouse location on the current workplane.
* Picking a point on an object will return a point situated on the object, at your mouse location. An open "o" symbol appears to notify you.
* Pressing CTRL will snap your point to availible snap locations. A filled "o" or square symbol appears.
* Pressing SHIFT will constrain your new point in relation to the last one, horizontally or vertically, depending on the location of your mouse at the moment you press SHIFT. To change between horizontal and vertical, simply release SHIFT and press it again with your mouse in another location.
* Enter numbers to insert manually a coordinate.
* Pressing ENTER will switch you from X to Y, from Y to Z and pressing ENTER while you are editing Z will create a new point.
* Pressing SPACE will switch between relative and absolute coordinates. In relative coordinates, the location you enter is relative to the last point.
* Pressing Z or pressing the "Undo" button will undo the last point.
* Pressing ESCAPE will cancel the operation.


=== Obsolete === <!--T:48-->
===Multiple-point Line===


<!--T:49-->
draft Toolbar > Polyline
This command is considered obsolete because the [[Drawing_Workbench|Drawing Workbench]] is obsolete. However, the command itself is still available.
Context menu > draft > Polyline
* [[Image:Draft_Drawing.svg|32px]] [[Draft_Drawing|Drawing]]: writes selected objects to a [[Drawing_Workbench|Drawing Workbench]] page. {{obsolete|0.17}}
draft Menu > Polyline


<!--T:50-->
This function behaves exactly the same way as the previous one, except that it doesn't stop after 2 points. Besids that, a number of extra features are availible:
These commands have been removed from the interface.
* Double-clicking the last point, instead of simply clicking, will finish the line, leaving it open.
* [[Image:Draft_AddPoint.svg|32px]] [[Draft_AddPoint|Add point]]: adds a point to a wire or B-Spline. {{Obsolete|0.19}}
* Pressing F or context menu > draft > Finish or pressing the "Finish" button will also finish the line, leaving it open.
* [[Image:Draft_DelPoint.svg|32px]] [[Draft_DelPoint|Delete point]]: deletes a point from a wire or B-Spline. {{Obsolete|0.19}}
* CTRL-Clicking (snapping) on the first point will finish and close the line
* [[Image:Draft_Array.svg|32px]] [[Draft_Array|Array]]: creates a polar or rectangular array from selected objects. {{Obsolete|0.19}}
* Pressing C or context menu > draft > Close or pressing the "Close" button will also finish and close the line.


== Draft Tray toolbar == <!--T:57-->
===Circle===


<!--T:58-->
draft Toolbar > Circle
The Draft tray toolbar appears when the workbench is started, and allows selecting the working plane, together with some visual properties like the line color, shape color, text size, line width, and automatic group.
Context menu > draft > Circle
draft Menu > Circle


<!--T:59-->
This function draws a circle by asking for two points, the center and the radius. Both values can also be entered manually. The created circle will take the current line width and color. Availible features:
* [[Image:Draft_SelectPlane.svg|32px]] [[Draft_SelectPlane|Set working plane]]: sets a working plane from a standard view or a selected face.
* Pressing CTRL will snap you to availible snap locations. A filled symbol appears to notify you.
* [[Image:Draft_ToggleConstructionMode.svg|32px]] [[Draft_ToggleConstructionMode|Toggle construction mode]]: toggles the Draft construction mode on or off.
* Pressing ESCAPE cancels the function.
* [[Image:Draft_AutoGroup.svg|32px]] [[Draft AutoGroup|AutoGroup]]: automatically place new objects in a given [[File:Std_Group.svg|32px]] [[Std_Group|Std Group]], [[File:Draft_Layer.svg|32px]] [[Draft_Layer|Draft Layer]], or one of the group-like objects of the [[Arch_Workbench|Arch Workbench]], like [[File:Arch_BuildingPart.svg|32px]] [[Arch_BuildingPart|Arch BuildingPart]]. {{Version|0.17}}
* [[Image:Draft_ApplyStyle.svg|32px]] [[Draft_Apply|Apply style]]: applies the current style and color to selected objects.


== Draft Snap toolbar == <!--T:60-->
===Arc===


<!--T:61-->
draft Toolbar > Arc
The [[Draft_Snap|Draft Snap]] toolbar allows selecting the currently snapping mode. Its button keep depressed when a mode is active.
Context menu > draft > Arc
draft Menu > Arc


<!--T:62-->
This function draws an arc by picking four points: the center, the radius, the start angle and the end angle. All these values can also be entered manually. The created arc will take the current line width and color. Availible features:
* [[Image:Draft_Snap_Lock.svg|32px]] [[Draft_Snap_Lock|Toggle snap]]: toggles [[Draft Snap|object snapping]] globally on or off.
* Pressing CTRL will snap you to availible snap locations. A filled symbol appears to notify you.
* [[Image:Draft_Snap_Endpoint.svg|32px]] [[Draft_Snap_Endpoint|Endpoint]]: snaps to the endpoints of line, arc and spline segments.
* Pressing SHIFT will constrain you vertically or horizontally in relation to the center.
* [[Image:Draft_Snap_Midpoint.svg|32px]] [[Draft_Snap_Midpoint|Midpoint]]: snaps to the middle point of line and arc segments.
* Pressing ALT when choosing the end angle will switch you to counter-clockwise direction.
* [[Image:Draft_Snap_Center.svg|32px]] [[Draft_Snap_Center|Center]]: snaps to the center point of arcs and circles.
* Pressing ESCAPE cancels the function.
* [[Image:Draft_Snap_Angle.svg|32px]] [[Draft_Snap_Angle|Angle]]: snaps to the special cardinal points of circles and arcs, at 45° and 90°.
* Pressing ESCAPE cancels the function
* [[Image:Draft_Snap_Intersection.svg|32px]] [[Draft_Snap_Intersection|Intersection]]: snaps to the intersection of two line or arc segments. Hover the mouse over the two desired objects to activate their intersection snaps.
* [[Image:Draft_Snap_Perpendicular.svg|32px]] [[Draft_Snap_Perpendicular|Perpendicular]]: on line and arc segments, snaps perpendicularly to the latest point.
* [[Image:Draft_Snap_Extension.svg|32px]] [[Draft_Snap_Extension|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.
* [[Image:Draft_Snap_Parallel.svg|32px]] [[Draft_Snap_Parallel|Parallel]]: snaps on an imaginary line parallel to a line segment. Hover the mouse over the desired object to activate its parallel snap.
* [[Image:Draft_Snap_Special.svg|32px]] [[Draft_Snap_Special|Special]]: snaps on special points defined by the object. {{Version|0.17}}
* [[Image:Draft_Snap_Near.svg|32px]] [[Draft_Snap_Near|Near]]: snaps to the closest point or edge on the nearest object.
* [[Image:Draft_Snap_Ortho.svg|32px]] [[Draft_Snap_Ortho|Ortho]]: snaps on imaginary lines that cross the last point, and extend at 0°, 45° and 90°.
* [[Image:Draft_Snap_Grid.svg|32px]] [[Draft_Snap_Grid|Grid]]: snaps to the intersections of the grid lines, if the grid is visible.
* [[Image:Draft_Snap_WorkingPlane.svg|32px]] [[Draft_Snap_WorkingPlane|Working plane]]: always places the snapped point on the current [[Draft SelectPlane|working plane]], even if you snap to a point outside that working plane.
* [[Image:Draft_Snap_Dimensions.svg|32px]] [[Draft_Snap_Dimensions|Dimensions]]: shows temporary X and Y dimensions while snapping.
* [[Image:Draft_ToggleGrid.svg|32px]] [[Draft_ToggleGrid|Toggle grid]]: toggles the visibility of the grid on or off.


== Utility tools == <!--T:22-->
==Modification functions==


<!--T:63-->
===Move===
* [[Image:Draft_Layer.svg|32px]] [[Draft_Layer|Layer]]: creates a Layer in the current document, to which objects can be added to control object visibility and color. It replaces [[Draft_VisGroup|VisGroup]]. {{Version|0.19}}
* [[Image:Draft_SetWorkingPlaneProxy.svg|32px]] [[Draft SetWorkingPlaneProxy|Working Plane Proxy]]: create a proxy object to store the current [[Draft_SelectPlane|Working Plane]] position. {{Version|0.17}}
* [[Image:Draft_ToggleDisplayMode.svg|32px]] [[Draft_ToggleDisplayMode|Toggle display mode]]: switches the display mode of selected objects between "Flat Lines" and "Wireframe".
* [[Image:Draft_AddToGroup.svg|32px]] [[Draft_AddToGroup|Add to group]]: quickly adds selected objects to an existing [[Std Group|Std Group]] or [[Draft VisGroup|Draft VisGroup]].
* [[Image:Draft_SelectGroup.svg|32px]] [[Draft_SelectGroup|Select group contents]]: selects the contents of a selected [[Std Group|Std Group]] or [[Draft VisGroup|Draft VisGroup]].
* [[Image:Draft_AddConstruction.svg|32px]] [[Draft_AddConstruction|Add to Construction group]]: add selected objects to the Construction group. {{Version|0.17}}
* [[Image:Draft_Heal.svg|32px]] [[Draft_Heal|Heal]]: heals problematic Draft objects found in very old files.


== Utility menu == <!--T:64-->
draft Toolbar > Move
Context menu > draft > Move
draft Menu > Move


<!--T:23-->
This function moves the selected objects from one point to another.
Additional tools available from the menu {{MenuCommand|Draft → Utilities}}, or via the right-click context menu, depending on the selected object.
* Pressing CTRL will snap you to availible snap locations. A filled symbol appears to notify you.
* Pressing SHIFT will constrain you vertically or horizontally in relation to the center.
* Pressing ESCAPE will cancel the move.
* SPACE will switch you between relative and absolute coordinates.
* C switches the copy mode on/off. With Copy on, objects will be copied instead of moved.


<!--T:24-->
==Common behaviours==
* [[Image:Draft_ToggleContinueMode.svg|32px]] [[Draft_ToggleContinueMode|Toggle continue mode]]: toggles the Draft continue mode on or off.
* [[Image:Draft_ShowSnapBar.svg|32px]] [[Draft_ShowSnapBar|Show snap bar]]: shows or hides the [[Draft Snap|Draft Snap]] toolbar.


===Snapping===
=== Obsolete === <!--T:65-->


<!--T:66-->
In all functions that support snapping, following snap locations are currently availible:
These tools were removed from the interface in v0.19 because they no longer had any purpose.
* Endpoint of lines
* Midpoint of lines
* Center of circles and arcs
* Quadrant points of circles and arcs
* Endpoints of arcs


<!--T:67-->
In functions that support both snapping and constraining, the combination of both behaviours (SHIFT+CTRL) can extend much the snapping possibilities.
* [[Image:Draft_VisGroup.svg|32px]] [[Draft_VisGroup|VisGroup]]: creates a VisGroup in the current document. This was replaced by [[Image:Draft_Layer.svg|32px]] [[Draft_Layer|Layer]]. {{Obsolete|0.19}}
* [[Image:Draft_FinishLine.svg|32px]] [[Draft_FinishLine|Finish line]]: ends the drawing of the current [[Draft Wire|Draft Wire]] or [[Draft BSpline|Draft BSpline]], without closing it. {{Obsolete|0.19}}
* [[Image:Draft_CloseLine.svg|32px]] [[Draft_CloseLine|Close line]]: ends the drawing of the current [[Draft Wire|Draft Wire]] or [[Draft BSpline|Draft BSpline]], and closes it. {{Obsolete|0.19}}
* [[Image:Draft_UndoLine.svg|32px]] [[Draft_UndoLine|Undo line]]: undoes the last segment of a [[Draft Wire|Draft Wire]]. {{Obsolete|0.19}}

== Preferences == <!--T:25-->

<!--T:28-->
* [[Image:Preferences-draft.svg|32px]] [[Draft_Preferences|Preferences]]: general preferences for the working plane and the drawing tools.
* [[Image:Preferences-import-export.svg|32px]] [[Import_Export_Preferences|Import Export Preferences]]: preferences available for importing from and exporting to different file formats.

== File formats == <!--T:3-->

<!--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:
The Draft module provides FreeCAD with importers and exporters for the following file formats:

<!--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 .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|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_DAT|Airfoil Data Format .DAT]]: imports DAT files describing [http://www.ae.illinois.edu/m-selig/ads/coord_database.html Airfoil profiles].

===Install importers=== <!--T:36-->

<!--T:37-->
* [[FreeCAD_and_DWG_Import|FreeCAD and DWG Import]]: Imports and exports DWG files
* [[FreeCAD_and_DXF_Import|FreeCAD and DXF Import]]: Imports and exports DXF files

== Additional features == <!--T:6-->

<!--T:7-->
* [[Draft Coordinates|Coordinates]]: enter coordinates instead of clicking on the 3D view to define a new point.
* [[Draft Constrain|Constraining]]: limit the pointer to horizontal or vertical movements relative to a previous point.
* [[Draft Snap|Snapping]]: place new points on special places on existing objects or on the grid.
* [[Draft_Copying|Copy Mode]]: All modification tools can either modify the selected objects or create a modified copy of them. Pressing and holding {{KEY|Alt}} while the object is being modified, e.g. moved or rotated, creates a copy when the key is released.
* [[Draft ToggleConstructionMode|Construction Mode]]: Allows you to create geometries separate from the rest by simply switching them on and off.
* [[Draft SelectPlane|Working plane]]: allows you to select a surface on which to build your shapes.

== Unit tests == <!--T:39-->

<!--T:40-->
{{Emphasis|See also:}} [[Test_Workbench|Test Workbench]].

<!--T:41-->
To run the unit tests of the workbench execute the following from the operating system terminal.
</translate>
{{Code|code=
freecad -t TestDraft
}}
<translate>

== Scripting == <!--T:10-->

<!--T:11-->
The Draft tools can be used in [[macros|macros]] and from the [[Python|Python]] console by using the [[Draft_API|Draft API]].

<!--T:42-->
The workbench includes a module to create samples of all objects in a new document. {{Version|0.19}}

<!--T:43-->
Use this to test that all objects are produced correctly.
</translate>
{{Code|code=
import drafttests.draft_test_objects as dto
doc = dto.create_test_file()
}}
<translate>

<!--T:44-->
Inspecting the code of this module is useful to understand how to use the programming interface.
</translate>
{{Code|code=
$INSTALLDIR/Mod/Draft/drafttests/draft_test_objects.py
}}
<translate>

<!--T:45-->
Where {{incode|$INSTALLDIR}} is the toplevel directory where the software was installed; for example, in Linux it may be {{incode|/usr/share/freecad}}.

</translate>
[[File:Draft_test_objects.png|500px]]
<translate>
<!--T:51-->
{{Caption|Test objects for the [[Draft_Workbench|Draft Workbench]].}}

== Tutorials == <!--T:14-->
* [[Draft_tutorial|Draft tutorial]]
* [[Draft_tutorial_Outdated|Draft tutorial Outdated]]
* [[Draft_ShapeString_tutorial|Draft ShapeString tutorial]]

<!--T:12-->
{{Docnav
|[[Arch Workbench|Arch Workbench]]
|[[Drawing Workbench|Drawing Workbench]]
|IconL=Workbench_Arch.svg
|IconR=Workbench_Drawing.svg
}}

</translate>
{{Draft Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
[[Category:Workbenches{{#translation:}}]]

Revision as of 11:05, 25 October 2020

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

  • Shape 2D View: creates a 2D object which is a flattened 2D view of a 3D object.

Obsolete

This command is considered obsolete because the Drawing Workbench is obsolete. However, the command itself is still available.

These commands have been removed from the interface.

Draft Tray toolbar

The Draft tray toolbar appears when the workbench is started, and allows selecting the working plane, together with some visual properties like the line color, shape color, text size, line width, and automatic group.

Draft Snap toolbar

The Draft Snap toolbar allows selecting the currently snapping mode. Its button keep depressed when a mode is active.

  • 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 arcs and circles.
  • 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. introduced in version 0.17
  • 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.

Utility tools

Utility menu

Additional tools available from the menu Draft → Utilities, or via the right-click context menu, depending on the selected object.

Obsolete

These tools were removed from the interface in v0.19 because they no longer had any purpose.

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 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: The Draft module provides FreeCAD with importers and exporters for the following file formats:

Install importers

Additional features

  • Coordinates: enter coordinates instead of clicking on the 3D view to define a new point.
  • Constraining: limit the pointer to horizontal or vertical movements relative to a previous point.
  • Snapping: place new points on special places on existing objects or on the grid.
  • Copy Mode: All modification tools can either modify the selected objects or create a modified copy of them. Pressing and holding Alt while the object is being modified, e.g. moved or rotated, creates a copy when the key is released.
  • Construction Mode: Allows you to create geometries separate from the rest by simply switching them on and off.
  • Working plane: allows you to select a surface on which to build your shapes.

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