Drawing Workbench: Difference between revisions

From FreeCAD Documentation
(add <translate>)
(Marked this version for translation)
(36 intermediate revisions by 9 users not shown)
Line 1: Line 1:
<languages/>
<translate>
<!--T:69-->
{{Docnav|[[Draft Workbench|Draft Workbench]]|[[FEM Workbench|FEM Workbench]]|IconL=Workbench_Draft.svg|IconC=Online Help Toc.svg|
IconR=Workbench_FEM.svg}}
</translate>
[[Image:Workbench_Drawing.svg|64px]]
<translate>
<translate>
The Drawing module allows you to put your 3D work on paper. That is, to put views of your models in a 2D window and to insert that window in a drawing, for example a sheet with a border, a title and your logo and finally print that sheet. The Drawing module is currently under construction and more or less a technology preview!


== Introduction == <!--T:64-->
== GUI Tools ==


<!--T:51-->
{{Drawing Tools}}
{{VeryImportantMessage|Development of the [[Drawing Workbench]] stopped in FreeCAD 0.16, and the new [[TechDraw Workbench]] aiming to replace it was introduced in v0.17. Both workbenches are still provided in v0.17, but the Drawing Workbench may be removed in future releases.}}


'''Note'''
The [[Draft Module]] has its own [[Draft_Drawing]] too to place Draft objects on paper. It has a couple of extra capabilities over the standard Drawing tools, and supports specific objects like [[Draft Dimension|Draft dimensions]].


<!--T:1-->
The Drawing module allows you to put your 3D work on paper. That is, to put views of your models in a 2D window and to insert that window in a drawing, for example a sheet with a border, a title and your logo and finally print that sheet.


</translate>
{{TOCright}}
[[Image:Drawing_extraction.png|800px]]
[[Image:Drawing_extraction.png|800px]]
<translate>


== Tools == <!--T:2-->
In the picture you see the main concepts of the Drawing module. The document contains a shape object (Schenkel) which we want to extract to a drawing. Therefore a "Page" is created. A page gets instantiated through a template, in this case the "A3_Landscape" template. The template is an SVG document which can hold your usual page frame, your logo or comply to your presentation standards.


<!--T:3-->
In this page we can insert one or more views. Each view has a position on the page (Properties X,Y), a scale factor (Property scale) and additional properties. Every time the page or the view or the referenced object changes the page gets regenerated and the page display updated.
These are tools for creating, configuring and exporting 2D drawing sheets


<!--T:52-->
== Scripting ==
* [[Image:Drawing_New.png|32px]] [[Drawing_Open_SVG|Open scalable vector graphic]]: Opens a drawing sheet previously saved as an SVG file


<!--T:53-->
At the moment the end user(GUI) workflow is very limited, so the scripting API is more interesting. Here follow examples on how to use the scripting API of the drawing module.
* [[Image:Drawing_Landscape_A3.png|32px]] [[Drawing_Landscape_A3|New A3 landscape drawing]]: Creates a new drawing sheet from FreeCAD's default A3 template


<!--T:54-->
Here a script that can easily fill the [[Macro_CartoucheFC]] leaf FreeCAD A3_Landscape.
* [[Image:Drawing_View.png|32px]] [[Drawing_View|Insert a view]]: Inserts a view of the selected object in the active drawing sheet


<!--T:55-->
=== Simple example ===
* [[Image:Drawing_Annotation.png|32px]] [[Drawing_Annotation|Annotation]]: Adds an annotation to the current drawing sheet


<!--T:56-->
First of all you need the Part and the Drawing module:
* [[Image:Drawing_Clip.png|32px]] [[Drawing_Clip|Clip]]: Adds a clip group to the current drawing sheet
</translate>
<syntaxhighlight>
import FreeCAD, Part, Drawing
</syntaxhighlight>
<translate>
Create a small sample part
</translate>
<syntaxhighlight>
Part.show(Part.makeBox(100,100,100).cut(Part.makeCylinder(80,100)).cut(Part.makeBox(90,40,100)).cut(Part.makeBox(20,85,100)))
</syntaxhighlight>
<translate>
Direct projection. The G0 means hard edge, the G1 is tangent continuous.
</translate>
<syntaxhighlight>
Shape = App.ActiveDocument.Shape.Shape
[visibleG0,visibleG1,hiddenG0,hiddenG1] = Drawing.project(Shape)
print "visible edges:", len(visibleG0.Edges)
print "hidden edges:", len(hiddenG0.Edges)
</syntaxhighlight>
<translate>
Everything was projected on the Z-plane:
</translate>
<syntaxhighlight>
print "Bnd Box shape: X=",Shape.BoundBox.XLength," Y=",Shape.BoundBox.YLength," Z=",Shape.BoundBox.ZLength
print "Bnd Box project: X=",visibleG0.BoundBox.XLength," Y=",visibleG0.BoundBox.YLength," Z=",visibleG0.BoundBox.ZLength
</syntaxhighlight>
<translate>
Different projection vector
</translate>
<syntaxhighlight>
[visibleG0,visibleG1,hiddenG0,hiddenG1] = Drawing.project(Shape,App.Vector(1,1,1))
</syntaxhighlight>
<translate>
Project to SVG
</translate>
<syntaxhighlight>
resultSVG = Drawing.projectToSVG(Shape,App.Vector(1,1,1))
print resultSVG
</syntaxhighlight>
<translate>
=== The parametric way ===


<!--T:57-->
Create the body
* [[Image:Drawing_Openbrowser.png|32px]] [[Drawing_Openbrowser|Open Browser]]: Opens a preview of the current sheet in the browser
</translate>
<syntaxhighlight>
import FreeCAD
import Part
import Drawing


<!--T:58-->
# Create three boxes and a cylinder
* [[Image:Drawing_Orthoviews.png|32px]] [[Drawing_Orthoviews|Ortho Views]]: Automatically creates orthographic views of an object on the current drawing sheet
App.ActiveDocument.addObject("Part::Box","Box")
App.ActiveDocument.Box.Length=100.00
App.ActiveDocument.Box.Width=100.00
App.ActiveDocument.Box.Height=100.00


<!--T:59-->
App.ActiveDocument.addObject("Part::Box","Box1")
* [[Image:Drawing_Symbol.png|32px]] [[Drawing_Symbol|Symbol]]: Adds the contents of a SVG file as a symbol on the current drawing sheet
App.ActiveDocument.Box1.Length=90.00
App.ActiveDocument.Box1.Width=40.00
App.ActiveDocument.Box1.Height=100.00


<!--T:60-->
App.ActiveDocument.addObject("Part::Box","Box2")
* [[Image:Drawing_DraftView.png|32px]] [[Draft_Drawing|Draft View]]: Inserts a special Draft view of the selected object in the current drawing sheet
App.ActiveDocument.Box2.Length=20.00
App.ActiveDocument.Box2.Width=85.00
App.ActiveDocument.Box2.Height=100.00


<!--T:61-->
App.ActiveDocument.addObject("Part::Cylinder","Cylinder")
* [[Image:Drawing_SpreadsheetView.png|32px]] [[Drawing_SpreadsheetView|Spreadsheet View]]: Inserts a view of a selected spreadsheet in the current drawing sheet
App.ActiveDocument.Cylinder.Radius=80.00
App.ActiveDocument.Cylinder.Height=100.00
App.ActiveDocument.Cylinder.Angle=360.00
# Fuse two boxes and the cylinder
App.ActiveDocument.addObject("Part::Fuse","Fusion")
App.ActiveDocument.Fusion.Base = App.ActiveDocument.Cylinder
App.ActiveDocument.Fusion.Tool = App.ActiveDocument.Box1


<!--T:62-->
App.ActiveDocument.addObject("Part::Fuse","Fusion1")
* [[Image:Drawing_Save.png|32px]] [[Drawing_Save|Save sheet]]: Saves the current sheet as a SVG file
App.ActiveDocument.Fusion1.Base = App.ActiveDocument.Box2
App.ActiveDocument.Fusion1.Tool = App.ActiveDocument.Fusion
# Cut the fused shapes from the first box
App.ActiveDocument.addObject("Part::Cut","Shape")
App.ActiveDocument.Shape.Base = App.ActiveDocument.Box
App.ActiveDocument.Shape.Tool = App.ActiveDocument.Fusion1
# Hide all the intermediate shapes
Gui.ActiveDocument.Box.Visibility=False
Gui.ActiveDocument.Box1.Visibility=False
Gui.ActiveDocument.Box2.Visibility=False
Gui.ActiveDocument.Cylinder.Visibility=False
Gui.ActiveDocument.Fusion.Visibility=False
Gui.ActiveDocument.Fusion1.Visibility=False
</syntaxhighlight>
<translate>
Insert a Page object and assign a template
</translate>
<syntaxhighlight>
App.ActiveDocument.addObject('Drawing::FeaturePage','Page')
App.ActiveDocument.Page.Template = App.getResourceDir()+'Mod/Drawing/Templates/A3_Landscape.svg'
</syntaxhighlight>
<translate>
Create a view on the "Shape" object, define the position and scale and assign it to a Page
</translate>
<syntaxhighlight>
App.ActiveDocument.addObject('Drawing::FeatureViewPart','View')
App.ActiveDocument.View.Source = App.ActiveDocument.Shape
App.ActiveDocument.View.Direction = (0.0,0.0,1.0)
App.ActiveDocument.View.X = 10.0
App.ActiveDocument.View.Y = 10.0
App.ActiveDocument.Page.addObject(App.ActiveDocument.View)
</syntaxhighlight>
<translate>
Create a second view on the same object but this time the view will be rotated by 90 degrees.
</translate>
<syntaxhighlight>
App.ActiveDocument.addObject('Drawing::FeatureViewPart','ViewRot')
App.ActiveDocument.ViewRot.Source = App.ActiveDocument.Shape
App.ActiveDocument.ViewRot.Direction = (0.0,0.0,1.0)
App.ActiveDocument.ViewRot.X = 290.0
App.ActiveDocument.ViewRot.Y = 30.0
App.ActiveDocument.ViewRot.Scale = 1.0
App.ActiveDocument.ViewRot.Rotation = 90.0
App.ActiveDocument.Page.addObject(App.ActiveDocument.ViewRot)
</syntaxhighlight>
<translate>
Create a third view on the same object but with an isometric view direction. The hidden lines are activated too.
</translate>
<syntaxhighlight>
App.ActiveDocument.addObject('Drawing::FeatureViewPart','ViewIso')
App.ActiveDocument.ViewIso.Source = App.ActiveDocument.Shape
App.ActiveDocument.ViewIso.Direction = (1.0,1.0,1.0)
App.ActiveDocument.ViewIso.X = 335.0
App.ActiveDocument.ViewIso.Y = 140.0
App.ActiveDocument.ViewIso.ShowHiddenLines = True
App.ActiveDocument.Page.addObject(App.ActiveDocument.ViewIso)
</syntaxhighlight>
<translate>
Change something and update. The update process changes the view and the page.
</translate>
<syntaxhighlight>
App.ActiveDocument.View.X = 30.0
App.ActiveDocument.View.Y = 30.0
App.ActiveDocument.View.Scale = 1.5
App.ActiveDocument.recompute()
</syntaxhighlight>
<translate>
=== Accessing the bits and pieces ===


<!--T:63-->
Get the SVG fragment of a single view
* [[Drawing_ProjectShape|Project Shape]]: Creates a projection of the selected object (Source) in the 3D view.
</translate>
<syntaxhighlight>
ViewSVG = App.ActiveDocument.View.ViewResult
print ViewSVG
</syntaxhighlight>
<translate>
Get the whole result page (it's a file in the document's temporary directory, only read permission)
</translate>
<syntaxhighlight>
print "Resulting SVG document: ",App.ActiveDocument.Page.PageResult
file = open(App.ActiveDocument.Page.PageResult,"r")
print "Result page is ",len(file.readlines())," lines long"
</syntaxhighlight>
<translate>
Important: free the file!
</translate>
<syntaxhighlight>
del file
</syntaxhighlight>
<translate>
Insert a view with your own content:
</translate>
<syntaxhighlight>
App.ActiveDocument.addObject('Drawing::FeatureView','ViewSelf')
App.ActiveDocument.ViewSelf.ViewResult = """<g id="ViewSelf"
stroke="rgb(0, 0, 0)"
stroke-width="0.35"
stroke-linecap="butt"
stroke-linejoin="miter"
transform="translate(30,30)"
fill="#00cc00"
>


<!--T:4-->
<ellipse cx="40" cy="40" rx="30" ry="15"/>
* {{Emphasis|Note:}} the [[Draft Drawing|Draft Drawing]] tool is used with [[Draft Workbench|Draft objects]]. It has some additional capabilities over the Drawing tools, and supports specific objects like [[Draft Dimension|Draft dimensions]].
</g>"""
App.ActiveDocument.Page.addObject(App.ActiveDocument.ViewSelf)
App.ActiveDocument.recompute()


== Workflow == <!--T:6-->
del ViewSVG
The document contains a 3D shape object (Schenkel) from which we want to produce a drawing. Therefore a "Page" is created. A page it's instantiated from a template, for example, the "A3_Landscape" template. The template is an [[SVG]] document which can hold a page frame, a logo, and other elements.
</syntaxhighlight>
<translate>
That leads to the following result:


<!--T:7-->
[[Image:DrawingScriptResult.jpg|800px]]
In this page we can insert one or more views. Each view has a position on the page, a scale factor, and additional properties. Every time the page or the view or the referenced object changes, the page is regenerated and the page display updated.


== Scripting == <!--T:8-->
=== General Dimensioning and Tolerancing ===


<!--T:9-->
Drawing dimensions an toleranecs are still under development but you can get some basic functionality with a bit of work.
At the moment the graphical user interface workflow is very limited, so the scripting API is more interesting.


<!--T:65-->
First you need to get the gdtsvg python module from here (WARNING: This could be broken at any time!):
See the [[Drawing API example]] page for a description of the functions used to create drawing pages and views.


<!--T:10-->
https://github.com/jcc242/FreeCAD
The macro [[Macro CartoucheFC|CartoucheFC]] allows you to create a custom information box on an A3 landscape page.


== Templates == <!--T:43-->
To get a feature control frame, try out the following:
</translate>
<syntaxhighlight>
import gdtsvg as g # Import the module, I like to give it an easy handle
ourFrame = g.ControlFrame("0","0", g.Perpendicularity(), ".5", g.Diameter(), g.ModifyingSymbols("M"), "A",
g.ModifyingSymbols("F"), "B", g.ModifyingSymbols("L"), "C", g.ModifyingSymbols("I"))
</syntaxhighlight>
<translate>
Here is a good breakdown of the contents of a feature control frame: http://www.cadblog.net/adding-geometric-tolerances.htm


<!--T:44-->
The parameters to pass to control frame are:
FreeCAD comes bundled with a set of default templates, but you can find more on the [[Drawing templates]] page.
#X-coordinate in SVG-coordinate system (type string)
#Y-coordinate in SVG-coordinate system (type string)
#The desired geometric characteristic symbol (tuple, svg string as first, width of symbol as second, height of symbol as third)
#The tolerance (type string)
#(optional) The diameter symbol (tuple, svg string as first, width of symbol as second, height of symbol as third)
#(optional) The condition modifying material (tuple, svg string as first, width of symbol as second, height of symbol as third)
#(optional) The first datum (type string)
#(optional) The first datum's modifying condition (tuple, svg string as first, width of symbol as second, height of symbol as third)
#(optional) The second datum (type string)
#(optional) The second datum's modifying condition (tuple, svg string as first, width of symbol as second, height of symbol as third)
#(optional) The third datum (type string)
#(optional) The third datum's material condition (tuple, svg string as first, width of symbol as second, height of symbol as third)


== Extending the Drawing Module == <!--T:45-->
The ControlFrame function returns a type containing (svg string, overall width of control frame, overall height of control frame)'''


<!--T:46-->
To get a dimension, try out the following:
Some notes on the programming side of the drawing module will be added to the [[Drawing Documentation]] page. This is to help quickly understand how the drawing module works, enabling programmers to rapidly start programming for it.
</translate>
<syntaxhighlight>
import gdtsvg
ourDimension = linearDimension(point1, point2, textpoint, dimensiontext, linestyle=getStyle("visible"),
arrowstyle=getStyle("filled"), textstyle=getStyle("text")
</syntaxhighlight>
<translate>
Inputs for linear dimension are:
#point1, an (x,y) tuple with svg-coordinates, this is one of the points you would like to dimension between
#point2, an (x,y) tuple with svg-coordinates, this is the second point you would like to dimension between
#textpoint, an (x,y) tuple of svg-coordinates, this is where the text of your dimension will be
#dimensiontext, a string containing the text you want the dimension to say
#linestyle, a string containing svg (i.e. css) styles, using the getStyle function to retrieve a preset string, for styling the how the lines look
#arrowstyle, a string containing svg (i.e. css) styles, using the getStyle function to retrieve a preset string, for styling how the arrows look
#textstyle, a string containing svg (i.e. css) styles, using the getStyle function to retrieve a preset string, for styling how the text looks


== Tutorials == <!--T:49-->
With those two, you can proceed as above for displaying them on the drawing page. This module is very buggy and can be broken at any given moment, bug reports are welcome on the github page for now, or contact jcc242 on the forums if you post a bug somewhere else.
* [[Drawing_tutorial|Drawing tutorial]]


== External links == <!--T:50-->
== Templates ==
* [https://www.youtube.com/watch?v=1Hm5Zyjmjac Intro to mechanical drawing on Youtube - by Normal Universe]


<!--T:47-->
FreeCAD comes bundled with a set of default templates, but you can find more on the [[Drawing templates]] page.
{{Docnav|[[Draft Workbench|Draft Workbench]]|[[FEM Workbench|FEM Workbench]]|IconL=Workbench_Draft.svg|IconC=Online Help Toc.svg|
IconR=Workbench_FEM.svg}}


<!--T:67-->
== Extending the Drawing Module ==
{{Drawing Tools navi}}


<!--T:68-->
Some notes on the programming side of the drawing module will be added to the [[Drawing Documentation]] page. This is to help quickly understand how the drawing module works, enabling programmers to rapidly start programming for it.
{{Userdocnavi}}

[[Category:Obsolete Workbenches]]
{{docnav|Part Module|Raytracing Module}}

[[Category:User Documentation]]
</translate>
</translate>
<languages/>

Revision as of 09:43, 1 April 2019

Introduction

Development of the Drawing Workbench stopped in FreeCAD 0.16, and the new TechDraw Workbench aiming to replace it was introduced in v0.17. Both workbenches are still provided in v0.17, but the Drawing Workbench may be removed in future releases.

The Drawing module allows you to put your 3D work on paper. That is, to put views of your models in a 2D window and to insert that window in a drawing, for example a sheet with a border, a title and your logo and finally print that sheet.

Tools

These are tools for creating, configuring and exporting 2D drawing sheets

  • Insert a view: Inserts a view of the selected object in the active drawing sheet
  • Annotation: Adds an annotation to the current drawing sheet
  • Clip: Adds a clip group to the current drawing sheet
  • Open Browser: Opens a preview of the current sheet in the browser
  • Ortho Views: Automatically creates orthographic views of an object on the current drawing sheet
  • Symbol: Adds the contents of a SVG file as a symbol on the current drawing sheet
  • Draft View: Inserts a special Draft view of the selected object in the current drawing sheet
  • Spreadsheet View: Inserts a view of a selected spreadsheet in the current drawing sheet
  • Save sheet: Saves the current sheet as a SVG file
  • Project Shape: Creates a projection of the selected object (Source) in the 3D view.

Workflow

The document contains a 3D shape object (Schenkel) from which we want to produce a drawing. Therefore a "Page" is created. A page it's instantiated from a template, for example, the "A3_Landscape" template. The template is an SVG document which can hold a page frame, a logo, and other elements.

In this page we can insert one or more views. Each view has a position on the page, a scale factor, and additional properties. Every time the page or the view or the referenced object changes, the page is regenerated and the page display updated.

Scripting

At the moment the graphical user interface workflow is very limited, so the scripting API is more interesting.

See the Drawing API example page for a description of the functions used to create drawing pages and views.

The macro CartoucheFC allows you to create a custom information box on an A3 landscape page.

Templates

FreeCAD comes bundled with a set of default templates, but you can find more on the Drawing templates page.

Extending the Drawing Module

Some notes on the programming side of the drawing module will be added to the Drawing Documentation page. This is to help quickly understand how the drawing module works, enabling programmers to rapidly start programming for it.

Tutorials

External links