TechDraw Balloon: Difference between revisions

From FreeCAD Documentation
No edit summary
m (typo fixed)
(45 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{UnfinishedDocu}}
<languages/>
<languages/>
<translate>
<translate>

<!--T:23-->
<!--T:23-->
{{Docnav
{{Docnav|[[TechDraw_Dimension_Link|Dimension Link ]]|[[TechDraw_SaveSVG|Save SVG]]|[[TechDraw_Module|TechDraw]]|IconL=Techdraw_Dimension_Link.png|IconC=Workbench_TechDraw.svg|IconR=techdraw-saveSVG.svg}}
|[[TechDraw_Dimension_Link|Dimension Link ]]
|[[TechDraw_Dimension_Horizontal_Extent|Dimension Horizontal Extent]]
|[[TechDraw_Module|TechDraw]]
|IconL=TechDraw_Dimension_Link.svg
|IconR=TechDraw_Dimension_Horizontal_Extent.svg
|IconC=Workbench_TechDraw.svg
}}


<!--T:1-->
<!--T:1-->
Line 9: Line 16:
|Name=TechDraw Balloon
|Name=TechDraw Balloon
|MenuLocation=TechDraw → Balloon
|MenuLocation=TechDraw → Balloon
|Workbenches=[[TechDraw Module|TechDraw]]
|Workbenches=[[TechDraw_Module|TechDraw]]
|Version=0.19 (dev)
|Version=0.19
|SeeAlso=[[TechDraw NewAnnotation|TechDraw New annotation]]
|SeeAlso=[[TechDraw_NewAnnotation|TechDraw New annotation]]
}}
}}


Line 20: Line 27:


</translate>
</translate>
[[Image:Techdraw_balloon.png]]
[[Image:Techdraw_balloon.png|600px]]
<translate>
<translate>
⚫
<!--T:12-->
{{Caption|Balloon ...}}


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


<!--T:13-->
<!--T:13-->
# Select the View to which the Balloon will be attached...
# Select the View to which the Balloon will be attached.
# Press the {{Button|[[Image:TechDraw_Balloon.svg|16px]] [[TechDraw Balloon|Balloon]]}} button
# Press the {{Button|[[Image:TechDraw_Balloon.svg|16px]] [[TechDraw_Balloon|Balloon]]}} button.
# The cursor is now displayed as a balloon icon. Click on the page to place the balloon origin to the desired position.
# A balloon will be added to the View. The balloon bubble may be dragged to the desired position. Use CTL-drag to move the bubble and the arrow.
# The balloon bubble may be dragged to the desired position. Use {{KEY|Ctrl}}+drag to move the bubble and the arrow.
# To change the balloon properties either double-clicking onto it in the drawing or double-click on the balloon object in the model tree. This will open the balloon dialog.


== Limitations == <!--T:7-->
<!--T:29-->
'''Note:''' The position of the balloon is relative to the View and uses the same scale factor than the View.


<!--T:14-->
== Using separators == <!--T:7-->
Dimension objects are vulnerable to "topological naming" issues. This means that if you modify the 3D geometry the faces and edges of the model may be renamed internally; if a dimension is attached to an edge that is then modified, the dimension may break. In general, it is not possible to keep the projected 2D dimensions synchronized with the actual 3D objects.


<!--T:15-->
<!--T:26-->
When using a rectangle shape, separators can be added using "|" in the text.
Therefore, it is recommended that dimensions be added when the 3D model is no longer being modified.
For example "AAA|TEST|111" gives:


⚫
<!--T:27-->
[[File:balloon_separator.png|300 px]]


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


=== Data === <!--T:16-->
=== Data === <!--T:16-->
* {{PropertyData|Text}}: Text to be displayed.
* {{PropertyData|Source View}}: Source View for the balloon.
* {{PropertyData|Origin X}}: Balloon origin x-position relative to the View.
* {{PropertyData|Origin Y}}: Balloon origin y-position relative to the View.
* {{PropertyData|End Type}}: End symbol for the balloon line. Options: [[Image:Arrownone.svg|20px]] None, [[Image:Arrowfilled.svg|20px]] Filled Arrow, [[Image:Arrowopen.svg|20px]] Open Arrow, [[Image:Arrowtick.svg|20px]] Tick, [[Image:Arrowdot.svg|20px]] Dot, [[Image:arrowopendot.svg|20px]] Open Circle, [[Image:arrowfork.svg|20px]] Fork, [[Image:arrowpyramid.svg|20px]] Filled Triangle
* {{PropertyData|End Type Scale}}: Scale factor for the '''End Type'''.
* {{PropertyData|Bubble Shape}}: Shape of the balloon bubble. Options: [[Image:Circular.svg|20px]] Circular, None, [[Image:Triangle.svg|20px]] Triangle, [[Image:Inspection.svg|20px]] Inspection, [[Image:Hexagon.svg|20px]] Hexagon, [[Image:TechDraw_Square.svg|20px]] Square, [[Image:Rectangle.svg|20px]] Rectangle
* {{PropertyData|Shape Scale}}: Scale factor for the '''Shape'''.
* {{PropertyData|Text Wrap}}: Text wrap length; -1 means the text will never be wrapped and the result is in every case a single line.
* {{PropertyData|Kink Length}}: Distance from the '''Shape''' to the leader line kink.
* {{PropertyData|X}}: Horizontal position of the balloon bubble relative to the View.
* {{PropertyData|X}}: Horizontal position of the balloon bubble relative to the View.
* {{PropertyData|Y}}: Vertical position of the balloon bubble relative to the View.
* {{PropertyData|Y}}: Vertical position of the balloon bubble relative to the View.


=== View === <!--T:17-->
=== View === <!--T:17-->
* {{PropertyView|Color}}: Color of the balloon text.
* {{PropertyView|Font}}: The name of the font to use for the balloon bubble.
* {{PropertyView|Font}}: The name of the font to use for the balloon bubble.
* {{PropertyView|Fontsize}}: Dimension text size in mm.
* {{PropertyView|Fontsize}}: Dimension text size in mm.
* {{PropertyView|Line Visible}}: Whether the balloon line is visible.
* {{PropertyView|Line Width}}: Balloon line width


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


<!--T:18-->
<!--T:18-->
{{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:19-->
<!--T:19-->
The Balloon tool can be used in [[macros|macros]] and from the [[Python|Python]] console by using the following functions:
The Balloon tool can be used in [[Macros|macros]] and from the [[Python|Python]] console by using the following functions:


</translate>
</translate>
Line 65: Line 88:
}}
}}
<translate>
<translate>


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

<!--T:20-->
*



<!--T:24-->
<!--T:24-->
{{Docnav
{{Docnav|[[TechDraw_Dimension_Link|Dimension Link ]]|[[TechDraw_SaveSVG|Save SVG]]|[[TechDraw_Module|TechDraw]]|IconL=Techdraw_Dimension_Link.png|IconC=Workbench_TechDraw.svg|IconR=techdraw-saveSVG.svg}}
|[[TechDraw_Dimension_Link|Dimension Link ]]

|[[TechDraw_Dimension_Horizontal_Extent|Dimension Horizontal Extent]]
<!--T:21-->
|[[TechDraw_Module|TechDraw]]
⚫
{{TechDraw Tools navi}}
|IconL=TechDraw_Dimension_Link.svg
|IconR=TechDraw_Dimension_Horizontal_Extent.svg
|IconC=Workbench_TechDraw.svg
}}


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

Revision as of 02:08, 20 January 2021

Other languages:

TechDraw Balloon

Menu location
TechDraw → Balloon
Workbenches
TechDraw
Default shortcut
None
Introduced in version
0.19
See also
TechDraw New annotation

Description

The Balloon tool can add balloons with leader line in a drawing.

Usage

  1. Select the View to which the Balloon will be attached.
  2. Press the Balloon button.
  3. The cursor is now displayed as a balloon icon. Click on the page to place the balloon origin to the desired position.
  4. The balloon bubble may be dragged to the desired position. Use Ctrl+drag to move the bubble and the arrow.
  5. To change the balloon properties either double-clicking onto it in the drawing or double-click on the balloon object in the model tree. This will open the balloon dialog.

Note: The position of the balloon is relative to the View and uses the same scale factor than the View.

Using separators

When using a rectangle shape, separators can be added using "|" in the text. For example "AAA|TEST|111" gives:

Properties

Data

  • DataText: Text to be displayed.
  • DataSource View: Source View for the balloon.
  • DataOrigin X: Balloon origin x-position relative to the View.
  • DataOrigin Y: Balloon origin y-position relative to the View.
  • DataEnd Type: End symbol for the balloon line. Options: None, Filled Arrow, Open Arrow, Tick, Dot, Open Circle, Fork, Filled Triangle
  • DataEnd Type Scale: Scale factor for the End Type.
  • DataBubble Shape: Shape of the balloon bubble. Options: Circular, None, Triangle, Inspection, Hexagon, Square, Rectangle
  • DataShape Scale: Scale factor for the Shape.
  • DataText Wrap: Text wrap length; -1 means the text will never be wrapped and the result is in every case a single line.
  • DataKink Length: Distance from the Shape to the leader line kink.
  • DataX: Horizontal position of the balloon bubble relative to the View.
  • DataY: Vertical position of the balloon bubble relative to the View.

View

  • ViewColor: Color of the balloon text.
  • ViewFont: The name of the font to use for the balloon bubble.
  • ViewFontsize: Dimension text size in mm.
  • ViewLine Visible: Whether the balloon line is visible.
  • ViewLine Width: Balloon line width

Scripting

See also: TechDraw API and FreeCAD Scripting Basics.

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

bal1 = FreeCAD.ActiveDocument.addObject('TechDraw::DrawViewBalloon','Balloon')
rc = page.addView(bal1)
TechDraw
User documentation
Retrieved from "http://wiki.freecad.org/index.php?title=TechDraw_Balloon&oldid=841510"