Draft Workbench/pt: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
(One intermediate revision by the same user not shown)
Line 6: Line 6:
|IconR=Workbench_Drawing.svg
|IconR=Workbench_Drawing.svg
}}
}}

[[Image:Workbench_Draft.svg|240px|center]]
[[Image:Workbench_Draft.svg|thumb|128px|Draft workbench icon]]
{{Caption|align=center|The FreeCAD Draft Workbench Icon}}
{{TOCright}}


== Introduction ==
== Introduction ==
Line 16: Line 17:
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], TurboCad, and others.
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], TurboCad, and others.


[[Image:Draft_Workbench_Example.png|400px|Draft Workbench Example]]
{{TOCright}}
[[Image:Draft_Workbench_Example.png|600px|Draft Workbench Example]]


== Drawing objects ==
== Drawing objects ==
Line 26: Line 26:
* [[Image:Draft_Wire.svg|32px]] [[Draft_Wire|Polyline]]: draws a line made of multiple line segments (polyline).
* [[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_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_Circle.svg|32px]] [[Draft_Circle|Circle]]: draws a circle from center and radius.
* [[Image:Draft_Arc.svg|32px]] [[Draft_Arc|Arc]]: draws an arc segment from center, radius, start angle and end angle.
* [[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_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_Ellipse.svg|32px]] [[Draft_Ellipse|Ellipse]]: draws an ellipse 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_Rectangle.svg|32px]] [[Draft_Rectangle|Rectangle]]: draws a rectangle from two corner points.
* [[Image:Draft_Rectangle.svg|32px]] [[Draft_Rectangle|Rectangle]]: draws a rectangle from two corner points.
* [[Image:Draft_Text.svg|32px]] [[Draft_Text|Text]]: draws a multi-line text annotation.
* [[Image:Draft_Polygon.svg|32px]] [[Draft_Polygon|Polygon]]: draws a regular polygon from center, radius, and number of sides.
* [[Image:Draft_Dimension.svg|32px]] [[Draft_Dimension|Dimension]]: draws a dimension annotation.
* [[Image:Draft_BSpline.svg|32px]] [[Draft_BSpline|BSpline]]: draws a B-Spline from a series of points.
* [[Image:Draft_BSpline.svg|32px]] [[Draft_BSpline|BSpline]]: draws a B-Spline from a series of points.
* [[Image:Draft_Point.svg|32px]] [[Draft_Point|Point]]: inserts a point object.
* [[Image:Draft_ShapeString.svg|32px]] [[Draft_ShapeString|ShapeString]]: inserts a compound shape representing a text string at a given point.
* [[Image:Draft_Facebinder.svg|32px]] [[Draft_Facebinder|Facebinder]]: creates a new object from selected faces on existing objects.
* [[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_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_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 ==

* [[Image:Draft_Text.svg|32px]] [[Draft_Text|Text]]: draws a multi-line text annotation.
* [[Image:Draft_Dimension.svg|32px]] [[Draft_Dimension|Dimension]]: draws a dimension annotation.
* [[Image:Draft_Label.svg|32px]] [[Draft_Label|Label]]: places a label with an arrow pointing to a selected element. {{Version|0.17}}
* [[Image:Draft_Label.svg|32px]] [[Draft_Label|Label]]: places a label with an arrow pointing to a selected element. {{Version|0.17}}


Line 50: Line 53:
* [[Image:Draft_Move.svg|32px]] [[Draft_Move|Move]]: moves objects from one location to another.
* [[Image:Draft_Move.svg|32px]] [[Draft_Move|Move]]: moves objects from one location to another.
* [[Image:Draft_Rotate.svg|32px]] [[Draft_Rotate|Rotate]]: rotates objects from a start angle to an end angle.
* [[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_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_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}}

* [[Image:Draft_Clone.svg|32px]] [[Draft_Clone|Clone]]: clones the selected objects.
* [[Image:Draft_Array.svg|32px]] Array tools.
** [[Image:Draft_OrthoArray.svg|32px]] [[Draft_OrthoArray|OrthoArray]]: creates an orthogonal array from the selected object. {{Version|0.19}}
** [[File:Draft_PolarArray.svg|32px]] [[Draft_PolarArray|Polar Array]]: creates an array in a polar pattern, that is, sweeping an angle. {{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. {{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]]: creates an array of [[Std_LinkMake|App::Link]] elements by placing the copies along a path. {{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}}

* [[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}}

* [[Image:Draft_Join.svg|32px]] [[Draft_Join|Join]]: joins lines together into a single wire. {{version|0.18}}
* [[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_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_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.
* [[Image:Draft_Downgrade.svg|32px]] [[Draft_Downgrade|Downgrade]]: downgrades objects into lower-level objects.

* [[Image:Draft_Scale.svg|32px]] [[Draft_Scale|Scale]]: scales selected objects around a base point.
* [[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}}
* [[Image:Draft_WireToBSpline.svg|32px]] [[Draft_WireToBSpline|Wire to BSpline]]: converts a wire to a B-Spline and vice-versa.
* [[Image:Draft_WireToBSpline.svg|32px]] [[Draft_WireToBSpline|Wire to BSpline]]: converts a wire to a B-Spline and vice-versa.
* [[Image:Draft_AddPoint.svg|32px]] [[Draft_AddPoint|Add point]]: adds a point to a wire or B-Spline.
* [[Image:Draft_DelPoint.svg|32px]] [[Draft_DelPoint|Delete point]]: deletes a point from a wire or B-Spline.
* [[Image:Draft_Shape2DView.svg|32px]] [[Draft_Shape2DView|Shape 2D View]]: creates a 2D object which is a flattened 2D view of a 3D object.
* [[Image:Draft_Draft2Sketch.svg|32px]] [[Draft_Draft2Sketch|Draft to Sketch]]: converts a Draft object to a [[Sketcher Workbench|Sketcher Workbench]] Sketch and vice-versa.
* [[Image:Draft_Draft2Sketch.svg|32px]] [[Draft_Draft2Sketch|Draft to Sketch]]: converts a Draft object to a [[Sketcher Workbench|Sketcher Workbench]] Sketch and vice-versa.

* [[Image:Draft_OrthoArray.svg|32px]] [[Draft_OrthoArray|OrthoArray]]: creates an orthogonal array from the selected object. {{Version|0.19}}
* [[Image:Draft_Shape2DView.svg|32px]] [[Draft_Shape2DView|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|Drawing Workbench]] is obsolete. However, the command itself is still available.
* [[Image:Draft_Drawing.svg|32px]] [[Draft_Drawing|Drawing]]: writes selected objects to a [[Drawing_Workbench|Drawing Workbench]] page. {{obsolete|0.17}}

These commands have been removed from the interface.
* [[Image:Draft_AddPoint.svg|32px]] [[Draft_AddPoint|Add point]]: adds a point to a wire or B-Spline. {{Obsolete|0.19}}
* [[Image:Draft_DelPoint.svg|32px]] [[Draft_DelPoint|Delete point]]: deletes a point from a wire or B-Spline. {{Obsolete|0.19}}
* [[Image:Draft_Array.svg|32px]] [[Draft_Array|Array]]: creates a polar or rectangular array from selected objects. {{Obsolete|0.19}}
* [[Image:Draft_Array.svg|32px]] [[Draft_Array|Array]]: creates a polar or rectangular array from selected objects. {{Obsolete|0.19}}
* [[File:Draft_PolarArray.svg|32px]] [[Draft_PolarArray|Polar Array]]: creates an array in a polar pattern, that is, sweeping an angle. {{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. {{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]]: creates an array of [[Std_LinkMake|App::Link]] elements by placing the copies along a path. {{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}}
* [[Image:Draft_Clone.svg|32px]] [[Draft_Clone|Clone]]: clones the selected objects.
* [[Image:Draft_PutOnSheet.svg|32px]] [[Draft_Drawing|Drawing]]: writes selected objects to a [[Drawing Workbench|Drawing Workbench]] page. {{obsolete|0.17}}
* [[Image:Draft_Mirror.svg|32px]] [[Draft_Mirror|Mirror]]: mirrors the selected objects.
* [[Image:Draft_Stretch.svg|32px]] [[Draft_Stretch|Stretch]]: stretches the selected objects. {{Version|0.17}}


== Utility tools ==
== Utility tools ==
Line 159: Line 174:


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

[[File:Draft_test_objects.png|500px]]
{{Caption|Test objects for the [[Draft_Workbench|Draft Workbench]].}}


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 169: Line 187:
{{docnav/pt|Raytracing Module/pt|Arch Module/pt}}
{{docnav/pt|Raytracing Module/pt|Arch Module/pt}}
</div>
</div>



{{Draft Tools navi{{#translation:}}}}
{{Draft Tools navi{{#translation:}}}}

Revision as of 20:47, 30 March 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 to 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, TurboCad, and 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.

Utility tools

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

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.

Raytracing Module/pt
Arch Module/pt