TechDraw WeldSymbol: Difference between revisions

From FreeCAD Documentation
(update)
(Updated Docnav.)
(21 intermediate revisions by 9 users not shown)
Line 4: Line 4:
<!--T:1-->
<!--T:1-->
{{Docnav
{{Docnav
|[[TechDraw_ShowAll|Show/Hide Invisible Edges]]
|[[TechDraw_ShowAll|ShowAll]]
|[[TechDraw_ExtensionSelectLineAttributes|ExtensionSelectLineAttributes]]
|[[TechDraw_LineGroup|Line Groups]]
|[[TechDraw_Module|TechDraw]]
|[[TechDraw_Workbench|TechDraw]]
|IconL=TechDraw_ShowAll.svg
|IconL=TechDraw_ShowAll.svg
|IconR=TechDraw_ExtensionSelectLineAttributes.svg
|IconC=Workbench_TechDraw.svg
|IconC=Workbench_TechDraw.svg
|IconR=
}}
}}


Line 17: Line 17:
|Icon=techdraw-weldsymbol.svg
|Icon=techdraw-weldsymbol.svg
|MenuLocation=TechDraw → Add Welding Information to Leaderline
|MenuLocation=TechDraw → Add Welding Information to Leaderline
|Workbenches=[[TechDraw Module|TechDraw]]
|Workbenches=[[TechDraw_Workbench|TechDraw]]
|SeeAlso=[[TechDraw_LeaderLine|Add Leaderline to View]]
|Version=0.19
|Version=0.19
|SeeAlso=[[TechDraw_LeaderLine|TechDraw Leaderline]]
}}
}}


Line 28: Line 28:


</translate>
</translate>
[[Image:TechDraw_WeldingSymbol_example.png]]
[[Image:TechDraw_WeldingSymbol_example.png|330px]]
<translate>
<translate>
<!--T:5-->
<!--T:5-->
{{Caption|Welding specification added to a leader line}}
{{Caption|Welding specification added to a leader line}}


==How to use== <!--T:6-->
==Usage== <!--T:6-->


<!--T:7-->
<!--T:7-->
# Select an existing {{Button|[[Image:TechDraw_LeaderLine.svg|16px]] [[TechDraw_LeaderLine|Add Leaderline to View]]}}
# Select an existing [[TechDraw_LeaderLine|leaderline]].
# Press the {{Button|[[Image:TechDraw_WeldSymbol.svg|16px]] [[TechDraw_WeldSymbol|Add Welding Information to Leaderline]]}} button
# Press the {{Button|[[Image:TechDraw_WeldSymbol.svg|16px]] Add Welding Information to Leaderline}} button.
# A Task dialog will open. The dialog allows entry/selection of individual welding symbols and accompanying text to be added to the leader line.
# A task dialog will open. It allows to set individual welding symbols and accompanying text to be added to the leader line.
# To exit the dialog and save changes, press the OK button.
# To exit the dialog and save changes, press the OK button. To exit the dialog without saving, press the Cancel button.
# After the welding symbol is created, it can be edited by double clicking the Welding Symbol in the Tree.
# To exit the dialog without saving, press the Cancel button.
# After the welding symbol is created, it can be edited by double clicking the WeldingSymbol in the Tree.


==Properties== <!--T:8-->
==Properties== <!--T:8-->

===Weld Symbol=== <!--T:21-->


<!--T:9-->
<!--T:9-->
* {{PropertyData|AllAround}}: Show the AllAround symbol (circle) at the kink in the leader line.
* {{PropertyData|All Around}}: Shows the ''All Around'' symbol (circle) at the kink in the leader line.
* {{PropertyData|FieldWeld}}: Show the FieldWeld symbol (flag) at the kink in the leader line.
* {{PropertyData|Field Weld}}: Show the ''Field Weld'' symbol (flag) at the kink in the leader line.
* {{PropertyData|AlternateWeld}}: Offset the lower symbol to indicate alternating welds.
* {{PropertyData|Alternate Weld}}: Offsets the lower symbol to indicate alternating welds.
* {{PropertyData|TailText}}: Text to be shown at the end of the leader line.
* {{PropertyData|Tail Text}}: Text to be shown at the end of the leader line.

===Tile=== <!--T:22-->


<!--T:10-->
<!--T:10-->
Each individual symbol ("arrow side" and "other side") is represented by a "tile" object. A WeldingSymbol has 1 or 2 tiles associated with it.
Each individual symbol ("arrow side" and "other side") is represented by a "tile" object. A Welding Symbol has 1 or 2 tiles associated with it. Each of it has the following properties:
* {{PropertyData|Row}}: 0 for above the line, -1 for below the line. Not intended for end users.
* {{PropertyData|Tile Parent}}: The parent Weld Symbol
* {{PropertyData|Tile Row}}: Row of the tile. 0 means above the line, -1 below the line. '''Note:''' If you change the row of one tile, you must also change the tile for the second side! This way you can flip the sides.
* {{PropertyData|Column}}: not implemented.
* {{PropertyData|SymbolFile}}: Directory and file name of the svg file for the symbol.
* {{PropertyData|Tile Column}}: Column of the tile. At the moment it is always 0, therefore the property is not editable.
* {{PropertyData|LeftText}}: Text to be displayed to the left of the svg symbol.
* {{PropertyData|Symbol File}}: Directory and file name of the symbol's SVG file.
* {{PropertyData|CenterText}}: Text to be displayed above/below the svg symbol.
* {{PropertyData|Symbol Included}}: Directory and file name of the actual included symbol SVG file. (It is a temporary directory.)
* {{PropertyData|RightText}}: Text to be displayed to the right of the svg symbol.
* {{PropertyData|Left Text}}: Text to be displayed to the left of the SVG symbol.
* {{PropertyData|Center Text}}: Text to be displayed above/below the SVG symbol.
* {{PropertyData|Right Text}}: Text to be displayed to the right of the SVG symbol.


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


<!--T:12-->
<!--T:12-->
{{Emphasis|See also:}} [[TechDraw API|TechDraw API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].
{{Emphasis|See also:}} [[TechDraw_API|TechDraw API]] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].


<!--T:13-->
<!--T:13-->
The WeldingSymbol tool can be used in [[macros|macros]] and from the [[Python|Python]] console by using the following functions:
The WeldingSymbol tool can be used in [[Macros|macros]] and from the [[Python|Python]] console by using the following functions:


</translate>
</translate>
Line 91: Line 96:
App.activeDocument().DrawTileWeld001.CenterText = "center text"
App.activeDocument().DrawTileWeld001.CenterText = "center text"
}}
}}
<translate>


==Svg Symbol Tiles== <!--T:23-->

<!--T:14-->
Individual symbols are formed by 64x64 pixel SVG files. Additional symbols can be created in an SVG program like [https://en.wikipedia.org/wiki/Inkscape Inkscape] using one of the symbols supplied by FreeCAD as a template.

</translate>
[[File:Techdraw-WeldingSymbolLayoutArrow.svg|128px]]
[[File:Techdraw-WeldingSymbolLayoutOther.svg|128px]]
<translate>
<translate>
==Svg Symbol Tiles== <!--T:14-->
* Individual symbols are formed by 64x64 pixel Svg files. Additional symbols can be created in an Svg program like Inkscape using one of the supplies symbols as a template.
[[File:Techdraw-WeldingSymbolLayoutArrow.svg|256px|left]]
[[File:Techdraw-WeldingSymbolLayoutOther.svg|256px|right]]


<!--T:20-->
<!--T:20-->
* Individual symbols are formed by 64x64 (nominal) pixel SVG files. The tiles actually have a "border" of 4px. The border ensures that the leader line and symbol meet nicely.
<br/><br/>
* The symbol is drawn in black on a transparent background. The stroke width is 0.5mm.
* Individual symbols are formed by 64x64 (nominal) pixel Svg files. The tiles actually have a "border" of 4px. The border ensures that the leader line and symbol meet nicely.
* The leader passes below symbols for the arrow side (see image on the left) and above symbols for the "other" side (see image on the right).
* The symbol is drawn in black on a transparent background. The stroke is 0.5mm.
* The leader passes below symbols for the arrow side and above symbols for the "other" side.
* There is no particular naming standard other than to append "Up/Down" to the arrow/other side symbols.
* There is no particular naming standard other than to append "Up/Down" to the arrow/other side symbols where required.


==Notes== <!--T:15-->
==Notes== <!--T:15-->
Line 110: Line 119:
* You can edit your WeldingSymbol by double clicking on it in the tree view. Double clicking in the graphics area is not yet supported.
* You can edit your WeldingSymbol by double clicking on it in the tree view. Double clicking in the graphics area is not yet supported.
* There is a [[TechDraw_Preferences|preference parameter]] for the default welding symbol directory. You can add your own symbols in a personal directory.
* There is a [[TechDraw_Preferences|preference parameter]] for the default welding symbol directory. You can add your own symbols in a personal directory.



<!--T:17-->
<!--T:17-->
{{Docnav
{{Docnav
|[[TechDraw_ShowAll|Show/Hide Invisible Edges]]
|[[TechDraw_ShowAll|ShowAll]]
|[[TechDraw_ExtensionSelectLineAttributes|ExtensionSelectLineAttributes]]
|[[TechDraw_LineGroup|Line Groups]]
|[[TechDraw_Module|TechDraw]]
|[[TechDraw_Workbench|TechDraw]]
|IconL=TechDraw_ShowAll.svg
|IconL=TechDraw_ShowAll.svg
|IconR=TechDraw_ExtensionSelectLineAttributes.svg
|IconC=Workbench_TechDraw.svg
|IconC=Workbench_TechDraw.svg
|IconR=
}}
}}


<!--T:18-->
{{TechDraw Tools navi}}

<!--T:19-->
{{Userdocnavi}}
</translate>
</translate>
{{TechDraw Tools navi{{#translation:}}}}
{{clear}}
{{Userdocnavi{{#translation:}}}}

Revision as of 17:30, 30 November 2021

File:Techdraw-weldsymbol.svg TechDraw WeldingSymbol

Menu location
TechDraw → Add Welding Information to Leaderline
Workbenches
TechDraw
Default shortcut
None
Introduced in version
0.19
See also
TechDraw Leaderline

Description

The WeldingSymbol tool adds welding specifications to an existing leader line.

Welding specification added to a leader line

Usage

  1. Select an existing leaderline.
  2. Press the Add Welding Information to Leaderline button.
  3. A task dialog will open. It allows to set individual welding symbols and accompanying text to be added to the leader line.
  4. To exit the dialog and save changes, press the OK button. To exit the dialog without saving, press the Cancel button.
  5. After the welding symbol is created, it can be edited by double clicking the Welding Symbol in the Tree.

Properties

Weld Symbol

  • DataAll Around: Shows the All Around symbol (circle) at the kink in the leader line.
  • DataField Weld: Show the Field Weld symbol (flag) at the kink in the leader line.
  • DataAlternate Weld: Offsets the lower symbol to indicate alternating welds.
  • DataTail Text: Text to be shown at the end of the leader line.

Tile

Each individual symbol ("arrow side" and "other side") is represented by a "tile" object. A Welding Symbol has 1 or 2 tiles associated with it. Each of it has the following properties:

  • DataTile Parent: The parent Weld Symbol
  • DataTile Row: Row of the tile. 0 means above the line, -1 below the line. Note: If you change the row of one tile, you must also change the tile for the second side! This way you can flip the sides.
  • DataTile Column: Column of the tile. At the moment it is always 0, therefore the property is not editable.
  • DataSymbol File: Directory and file name of the symbol's SVG file.
  • DataSymbol Included: Directory and file name of the actual included symbol SVG file. (It is a temporary directory.)
  • DataLeft Text: Text to be displayed to the left of the SVG symbol.
  • DataCenter Text: Text to be displayed above/below the SVG symbol.
  • DataRight Text: Text to be displayed to the right of the SVG symbol.

Scripting

See also: TechDraw API and FreeCAD Scripting Basics.

The WeldingSymbol tool can be used in macros and from the Python console by using the following functions:

symbolName = "DrawWeldSymbol001")
symbolType = "TechDraw::DrawWeldSymbol"
App.activeDocument().addObject(symbolType, symbolName)
App.activeDocument().Page.addView(App.activeDocument().DrawWeldSymbol001)
App.activeDocument().DrawWeldSymbol001.Leader = myLeader
App.activeDocument().DrawWeldSymbol001.AllAround = True
App.activeDocument().DrawWeldSymbol001.FieldWeld = True
App.activeDocument().DrawWeldSymbol001.AlternatingWeld = True
App.activeDocument().DrawWeldSymbol001.TailText = "process text"

tileName = "DrawTileWeld001"
tileType = "TechDraw::DrawTileWeld"
App.activeDocument().addObject(tileType, tileName)
App.activeDocument().DrawTileWeld001.TileParent = App.activeDocument().DrawWeldSymbol001
App.activeDocument().DrawTileWeld001.TileRow = 0
App.activeDocument().DrawTileWeld001.TileColumn = 0
App.activeDocument().DrawTileWeld001.SymbolFile = fullPathToMySvgFile
App.activeDocument().DrawTileWeld001.LeftText = "left text"
App.activeDocument().DrawTileWeld001.RightText = "right text"
App.activeDocument().DrawTileWeld001.CenterText = "center text"

Svg Symbol Tiles

Individual symbols are formed by 64x64 pixel SVG files. Additional symbols can be created in an SVG program like Inkscape using one of the symbols supplied by FreeCAD as a template.

  • Individual symbols are formed by 64x64 (nominal) pixel SVG files. The tiles actually have a "border" of 4px. The border ensures that the leader line and symbol meet nicely.
  • The symbol is drawn in black on a transparent background. The stroke width is 0.5mm.
  • The leader passes below symbols for the arrow side (see image on the left) and above symbols for the "other" side (see image on the right).
  • There is no particular naming standard other than to append "Up/Down" to the arrow/other side symbols.

Notes

  • You can edit your WeldingSymbol by double clicking on it in the tree view. Double clicking in the graphics area is not yet supported.
  • There is a preference parameter for the default welding symbol directory. You can add your own symbols in a personal directory.