TechDraw Workbench: Difference between revisions

From FreeCAD Documentation
No edit summary
(36 intermediate revisions by the same user not shown)
Line 1: Line 1:
<languages/>
<languages/>
[[File:preferences-techdraw.svg|64px]]
[[Image:Workbench_TechDraw.svg|64px]]

<translate>
<translate>

== Introduction ==
<!--T:1-->
<!--T:1-->
FreeCAD is primarily a 3D modelling tool. There are times, however, when we must produce 2D drawings for documentation, contracts, permits, etc. The Technical Drawing workbench (TechDraw) is used to produce basic technical drawings based on the 3D model. Each drawing is a Page, and a Page contains many Views of Drawable Objects. The list of Drawable Objects includes Part::Features, PartDesign::Bodies, App::Part groups and Document Object groups.
The [[TechDraw Workbench]] is used to produce basic technical drawings from 3D models created with another workbench such as [[Part Workbench|Part]], [[PartDesign Workbench|PartDesign]], or [[Arch Workbench|Arch]], or imported from other applications. Each drawing is a Page, which can contain various Views of drawable objects such as Part::Features, PartDesign::Bodies, App::Part groups, and Document Object groups. The resulting drawings can be used for things like documentation, manufacturing instructions, contracts, permits, etc.


<!--T:15-->
<!--T:15-->
Dimensions and hatched areas can be added to Views.
Dimensions, sections, hatched areas, annotations, and [[SVG]] symbols can be added to the page, which can be further exported to different formats like [[DXF]], [[SVG]], and [[PDF]].

<!--T:11-->
Note: if your primary goal is the production of complex 2D drawings, and you don't need 3D modelling, you may wish to consider a dedicated software program such as LibreCad, QCad, TurboCad, and others.


<!--T:17-->
<!--T:17-->
TechDraw was officially included in FreeCAD starting with version 0.17; it is intended to replace the unsupported [[Drawing Workbench]]. Both workbenches are still provided in v0.17, but the Drawing Workbench may be removed in future releases. To keep up with TechDraw plans and developments, visit the [[TechDraw Roadmap]].
{{Version|0.17}}

<!--T:11-->
FreeCAD is primarily a 3D modelling application, and thus doesn't have many 2D drawing tools, which are mostly included in the [[Draft Workbench|Draft]] and [[Sketcher Workbench]]es. 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 [https://en.wikipedia.org/wiki/LibreCAD LibreCAD], [https://en.wikipedia.org/wiki/QCad QCad], TurboCad, and others.


</translate>
</translate>
{{TOCright}}
[[File:TechDraw Workbench Example.png|600px]]
[[File:TechDraw Workbench Example.png|600px]]
<translate>
<translate>


== Pages == <!--T:2-->

===Pages=== <!--T:2-->


<!--T:18-->
<!--T:18-->
These are tools for creating Pages.
These are tools for creating Page objects.


<!--T:19-->
<!--T:19-->
* [[File:TechDraw_New_Default.png|32px]] [[TechDraw_New_Default|New Default]]: Adds a new Page using the default [[TechDraw_Templates|Template]].
* [[File:TechDraw_New_Default.png|32px]] [[TechDraw_New_Default|New Default]]: adds a new page using the default [[TechDraw_Templates|template]].


<!--T:20-->
<!--T:20-->
* [[File:TechDraw_New_Pick.png|32px]] [[TechDraw_New_Pick|New Pick]]: Adds a new Page using a selected [[TechDraw_Templates|Template]].
* [[File:TechDraw_New_Pick.png|32px]] [[TechDraw_New_Pick|New Pick]]: adds a new page using a selected [[TechDraw_Templates|template]].


===Views=== <!--T:21-->
== Views == <!--T:21-->


<!--T:22-->
<!--T:22-->
These are tools for creating Views.
These are tools for creating View objects.


<!--T:23-->
<!--T:23-->
* [[File:techdraw-view.png|32px]] [[TechDraw_NewView|New View]]: Adds a 2D View of a one or more Drawable Objects.
* [[Image:techdraw-view.png|32px]] [[TechDraw_NewView|New View]]: adds a 2D projection view of an object.


<!--T:24-->
<!--T:24-->
* [[File:techdraw-projgroup.png|32px]] [[TechDraw_NewProjGroup|New Projection Group]]: Invokes a dialog for creating Views of one or more Drawable Objects from multiple directions.
* [[Image:techdraw-projgroup.png|32px]] [[TechDraw_NewProjGroup|New Projection Group]]: invokes a dialog to create many views of an object from multiple directions.


<!--T:25-->
<!--T:25-->
* [[File:techdraw-viewsection.png|32px]] [[TechDraw_NewSection|New Section]]: Adds a cross-section View of one or more Drawable Objects.
* [[Image:techdraw-viewsection.png|32px]] [[TechDraw_NewSection|New Section]]: adds a cross-section view of an existing view.


<!--T:26-->
<!--T:26-->
* [[File:techdraw-viewdetail.png|32px]] [[TechDraw_NewDetail|New Detail]]: Adds a detail View of a portion of an existing View.
* [[Image:techdraw-viewdetail.png|32px]] [[TechDraw_NewDetail|New Detail]]: adds a detail view of a portion of an existing view.


<!--T:27-->
<!--T:27-->
* [[File:techdraw-annotation.png|32px]] [[TechDraw_NewAnnotation|New Annotation]]: Adds a text block to a Page.
* [[Image:techdraw-annotation.png|32px]] [[TechDraw_NewAnnotation|New Annotation]]: adds a text block to serve as an annotation.


<!--T:28-->
<!--T:28-->
* [[File:techdraw-draft-view.png|32px]] [[TechDraw_NewDraft|New Draft]]: Adds a View of a Draft module object.
* [[Image:techdraw-draft-view.png|32px]] [[TechDraw_NewDraft|New Draft]]: adds a view of a [[Draft Workbench]] object.


<!--T:29-->
<!--T:29-->
* [[File:techdraw-arch-view.png|32px]] [[TechDraw_NewArch|New Arch]]: Adds a View of a Arch module Section Plane object.
* [[Image:techdraw-arch-view.png|32px]] [[TechDraw_NewArch|New Arch]]: adds a view of a [[Arch Workbench]] [[Arch SectionPlane|SectionPlane]] object.


<!--T:30-->
<!--T:30-->
* [[File:techdraw-spreadsheet.svg|32px]] [[TechDraw_Spreadsheet|Spreadsheet]]: Inserts a view of a selected [[Spreadsheet_Workbench|spreadsheet]] into a drawing.
* [[Image:techdraw-spreadsheet.svg|32px]] [[TechDraw_Spreadsheet|Spreadsheet]]: inserts a view of a [[Spreadsheet Workbench]] sheet.


===Clips=== <!--T:31-->
== Clips == <!--T:31-->


<!--T:32-->
<!--T:32-->
These are tools to create and manage clipped views.
These are tools to create and manage Clip objects (clipped views).


<!--T:33-->
<!--T:33-->
* [[File:techdraw-clip.svg|32px]] [[TechDraw_Clip|Clip]]: Inserts a clip group into a Page.
* [[Image:techdraw-clip.svg|32px]] [[TechDraw_Clip|Clip]]: inserts a clip group into a page.


<!--T:34-->
<!--T:34-->
* [[File:techdraw-clipplus.svg|32px]] [[TechDraw_ClipPlus|ClipPlus]]: Adds a View to a clip group.
* [[Image:techdraw-clipplus.svg|32px]] [[TechDraw_ClipPlus|ClipPlus]]: adds an existing view to a clip group.


<!--T:35-->
<!--T:35-->
* [[File:techdraw-clipminus.svg|32px]] [[TechDraw_ClipMinus|ClipMinus]]: Removes a View from a clip group.
* [[Image:techdraw-clipminus.svg|32px]] [[TechDraw_ClipMinus|ClipMinus]]: removes a view from a clip group.


===Dimensions=== <!--T:36-->
== Dimensions == <!--T:36-->


<!--T:37-->
<!--T:37-->
These are tools for working with Dimensions. Linear dimensions can be based on two points, one line or two lines.
These are tools for creating and working with Dimension objects.

Linear dimensions can be based on two points, on one line, or on two lines.


<!--T:38-->
<!--T:38-->
* [[File:Dimension_Length.png|32px]] [[TechDraw_Dimension_Length|New Length]]: Adds a Length Dimension.
* [[File:Dimension_Length.png|32px]] [[TechDraw_Dimension_Length|New Length]]: adds a length dimension.


<!--T:39-->
<!--T:39-->
* [[File:Dimension_Horizontal.png|32px]] [[TechDraw_Dimension_Horizontal|New Horizontal]]: Adds a horizontal distance dimension.
* [[File:Dimension_Horizontal.png|32px]] [[TechDraw_Dimension_Horizontal|New Horizontal]]: adds a horizontal length dimension.


<!--T:40-->
<!--T:40-->
* [[File:Dimension_Vertical.png|32px]] [[TechDraw_Dimension_Vertical|New Vertical]]: Adds a vertical distance dimension.
* [[File:Dimension_Vertical.png|32px]] [[TechDraw_Dimension_Vertical|New Vertical]]: adds a vertical length dimension.


<!--T:41-->
<!--T:41-->
* [[File:Dimension_Radius.png|32px]] [[TechDraw_Dimension_Radius|New Radius]]: Adds a Radius dimension to a circle or circular arc.
* [[File:Dimension_Radius.png|32px]] [[TechDraw_Dimension_Radius|New Radius]]: adds a radius dimension to a circle or circular arc.


<!--T:42-->
<!--T:42-->
* [[File:Dimension_Diameter.png|32px]] [[TechDraw_Dimension_Diameter|New Diameter]]: Adds a Diameter dimension to a circle or a circular arc.
* [[File:Dimension_Diameter.png|32px]] [[TechDraw_Dimension_Diameter|New Diameter]]: adds a diameter dimension to a circle or a circular arc.


<!--T:43-->
<!--T:43-->
* [[File:Dimension_Angle.png|32px]] [[TechDraw_Dimension_Angle|New Angle]]: Adds an Angle dimension between two straight edges.
* [[File:Dimension_Angle.png|32px]] [[TechDraw_Dimension_Angle|New Angle]]: adds an angle dimension between two straight edges.



<!--T:56-->
<!--T:56-->
* [[File:TechDraw_Dimension_Angle3Pt.png|32px]] [[TechDraw_Dimension_Angle3Pt|New Angle3Pt]]: Adds an Angle dimension using three vertices.
* [[File:TechDraw_Dimension_Angle3Pt.png|32px]] [[TechDraw_Dimension_Angle3Pt|New Angle3Pt]]: adds an angle dimension using three vertices.


<!--T:44-->
<!--T:44-->
* [[File:Dimension_Link.png|32px]] [[TechDraw_Dimension_Link|New Links]]: Links 1 or more Dimensions to 3D geometry.
* [[File:Dimension_Link.png|32px]] [[TechDraw_Dimension_Link|New Links]]: links an existing dimension to the 3D geometry.


===Import/Export=== <!--T:45-->
== Import/Export == <!--T:45-->


<!--T:46-->
<!--T:46-->
These are tools for exporting Pages to other applications.
These are tools for exporting pages to other applications.


<!--T:47-->
<!--T:47-->
* [[File:techdraw-saveSVG.png|32px]] [[TechDraw_SaveSVG|Save SVG]]: Saves a Page as an SVG file.
* [[Image:techdraw-saveSVG.svg|32px]] [[TechDraw_SaveSVG|Save SVG]]: saves a page as an [[SVG]] file.
* [[File:TechDraw_SaveDXF.png|32px]] [[TechDraw_SaveDXF|Save DXF]]: Saves a Page as a DXF file.
* [[Image:techdraw-saveDXF.svg|32px]] [[TechDraw_SaveDXF|Save DXF]]: saves a page as a [[DXF]] file.


===Decoration=== <!--T:48-->
== Decoration == <!--T:48-->


<!--T:49-->
<!--T:49-->
These are tools for changing the appearance of Pages and Views.
These are tools for changing the appearance of pages and views.


<!--T:50-->
<!--T:50-->
* [[File:techdraw-hatch.png|32px]] [[TechDraw_Hatch|Hatch Area]]: Applies a hatch pattern from a file to a Face.
* [[Image:techdraw-hatch.png|32px]] [[TechDraw_Hatch|Hatch Area]]: applies a hatch pattern from a file to a face.


<!--T:51-->
<!--T:51-->
* [[File:techdraw-geomhatch.png|32px]] [[TechDraw_GeomHatch|Geometric Hatch]]: Hatches a Face using an Autodesk PAT specification.
* [[Image:techdraw-geomhatch.png|32px]] [[TechDraw_GeomHatch|Geometric Hatch]]: applies a hatch pattern to a face using an Autodesk PAT specification.


<!--T:52-->
<!--T:52-->
* [[File:techdraw-symbol.png|32px]] [[TechDraw_Symbol|New Symbol]]: Inserts an SVG symbol into a Page.
* [[Image:techdraw-symbol.png|32px]] [[TechDraw_Symbol|New Symbol]]: inserts an [[SVG]] symbol into a page.


<!--T:53-->
<!--T:53-->
* [[File:Techdraw-image.png|32px]] [[TechDraw_Image|New Image]]: Inserts a png/jpg image into a Page.
* [[Image:Techdraw-image.png|32px]] [[TechDraw_Image|New Image]]: inserts a PNG or JPG [[bitmap]] image into a page.


<!--T:54-->
<!--T:54-->
* [[File:techdraw-toggleframe.png|32px]] [[TechDraw_Toggle|Toggle Frames]]: Turns View frames and labels on or off in a Page.
* [[Image:techdraw-toggleframe.png|32px]] [[TechDraw_Toggle|Toggle Frames]]: turns on and off the frames and labels surrounding a view.


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


<!--T:14-->
<!--T:14-->
* [[TechDraw_Hatching|Hatching]]: TechDraw supports a number of hatching techniques.
* [[TechDraw_Hatching|Hatching]]: explanation of the different hatching techniques.
* [[TechDraw_LineGroup|Line Groups]]: default weights can be assigned to various line types.
* [[TechDraw_LineGroup|Line Groups]]: default weights can be assigned to various line types.
* [[TechDraw_Templates|Templates]]: the default templates defined for the drawing pages.


===Preference settings=== <!--T:3-->
== Preferences == <!--T:3-->
* [[Image:Preferences-techdraw.svg|32px]] [[TechDraw_Preferences|Preferences]]: preferences for the default values of the drawing page such as projection angle, colors, text sizes, and line styles.
The TechDraw module has a [[TechDraw Preferences|preferences]] screen to adjust default values.


===Scripting=== <!--T:5-->
== Scripting == <!--T:5-->
The TechDraw Workbench features a [[Python]] API that can be used in scripts and [[macros]].
The TechDraw tools can be used in [[macros]] and from the [[Python]] console by using two APIs.
* [[TechDraw API]]
* [[TechDraw API]]
* [[TechDrawGui API]]
* [[TechDrawGui API]]


===Limitations=== <!--T:7-->
== Limitations == <!--T:7-->
* TechDraw drawings and Python API are not interchangeable with the Drawing module. It is possible to convert Drawing Pages to TechDraw Pages using Python (moveViews.py). It is possible to have both TechDraw and Drawing Pages in the same FreeCAD document.
* TechDraw drawings and its API are not interchangeable with the [[Drawing Workbench]] and its API. It is possible to convert Drawing Pages to TechDraw Pages using a Python script ({{incode|moveViews.py}}).
* It is possible to have both TechDraw and Drawing Pages in the same FreeCAD document, as each page is completely independent from each other.
* There are minor differences in specifying Editable Texts in Templates compared to the Drawing module. See forum discussion [https://forum.freecadweb.org/viewtopic.php?f=3&t=24981&p=196271#p196271 here].
* There are minor differences in specifying editable texts in [[SVG]] templates compared to the Drawing module. In TechDraw the scaling of the SVG document affects the position of the editable text fields. See the forum discussion [https://forum.freecadweb.org/viewtopic.php?f=3&t=24981&p=196271#p196271 TechDraw templates scale] for more details.
* TechDraw is available starting with FreeCAD 0.17.
* Do not Cut/Copy/Paste TechDraw objects. This does not generally work out well.
* Do not cut, copy and paste TechDraw objects in the tree view as this generally does not work out well.


== Tutorials ==
===Workarounds=== <!--T:12-->
* None required at the moment.


<!--T:16-->
Keep up with TechDraw plans and developments. Visit the [[TechDraw_Roadmap|TechDraw Roadmap]].


* [[Basic TechDraw Tutorial]]: introduction to creating drawings with the TechDraw Workbench.
* [[TechDraw_TemplateHowTo|Creating a new template]]: instructions to create a new page template in Inkscape for using with the TechDraw Workbench.


<!--T:8-->
<!--T:8-->
{{docnav|Start Workbench|Test Framework Workbench}}
{{docnav|Start Workbench|Test Framework Workbench}}
{{TechDraw Tools navi}}

{{Userdocnavi}}

[[Category:Workbenches]]
<!--T:9-->
[[Category:User Documentation]]
</translate>
</translate>

Revision as of 04:51, 7 December 2018

Introduction

The TechDraw Workbench is used to produce basic technical drawings from 3D models created with another workbench such as Part, PartDesign, or Arch, or imported from other applications. Each drawing is a Page, which can contain various Views of drawable objects such as Part::Features, PartDesign::Bodies, App::Part groups, and Document Object groups. The resulting drawings can be used for things like documentation, manufacturing instructions, contracts, permits, etc.

Dimensions, sections, hatched areas, annotations, and SVG symbols can be added to the page, which can be further exported to different formats like DXF, SVG, and PDF.

TechDraw was officially included in FreeCAD starting with version 0.17; it is intended to replace the unsupported Drawing Workbench. Both workbenches are still provided in v0.17, but the Drawing Workbench may be removed in future releases. To keep up with TechDraw plans and developments, visit the TechDraw Roadmap.

FreeCAD is primarily a 3D modelling application, and thus doesn't have many 2D drawing tools, which are mostly included in the Draft and Sketcher Workbenches. 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.

Pages

These are tools for creating Page objects.

Views

These are tools for creating View objects.

Clips

These are tools to create and manage Clip objects (clipped views).

Dimensions

These are tools for creating and working with Dimension objects.

Linear dimensions can be based on two points, on one line, or on two lines.

Import/Export

These are tools for exporting pages to other applications.

Decoration

These are tools for changing the appearance of pages and views.

Additional features

  • Hatching: explanation of the different hatching techniques.
  • Line Groups: default weights can be assigned to various line types.
  • Templates: the default templates defined for the drawing pages.

Preferences

  • Preferences: preferences for the default values of the drawing page such as projection angle, colors, text sizes, and line styles.

Scripting

The TechDraw tools can be used in macros and from the Python console by using two APIs.

Limitations

  • TechDraw drawings and its API are not interchangeable with the Drawing Workbench and its API. It is possible to convert Drawing Pages to TechDraw Pages using a Python script (moveViews.py).
  • It is possible to have both TechDraw and Drawing Pages in the same FreeCAD document, as each page is completely independent from each other.
  • There are minor differences in specifying editable texts in SVG templates compared to the Drawing module. In TechDraw the scaling of the SVG document affects the position of the editable text fields. See the forum discussion TechDraw templates scale for more details.
  • Do not cut, copy and paste TechDraw objects in the tree view as this generally does not work out well.

Tutorials

Start Workbench
Test Framework Workbench