Draft ShapeString/en: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
Line 1: Line 1:
<languages/>
<languages/>

{{Docnav
{{Docnav
|[[Draft_Point|Point]]
|[[Draft_Facebinder|Facebinder]]
|[[Draft_Facebinder|Facebinder]]
|[[Draft_Text|Text]]
|[[Draft_Module|Draft]]
|[[Draft_Module|Draft]]
|IconL=Draft_Point.svg
|IconL=Draft_Facebinder.svg
|IconR=Draft_Facebinder.svg
|IconR=Draft_Text.svg
|IconC=Workbench_Draft.svg
|IconC=Workbench_Draft.svg
}}
}}
Line 11: Line 12:
{{GuiCommand
{{GuiCommand
|Name=Draft ShapeString
|Name=Draft ShapeString
|MenuLocation=Draft → Shape from text ...
|MenuLocation=Drafting → Shape from text
|Workbenches=[[Draft_Module|Draft]], [[Arch_Module|Arch]]
|Workbenches=[[Draft_Module|Draft]], [[Arch_Module|Arch]]
|Shortcut={{KEY|S}} {{KEY|S}}
|Shortcut={{KEY|S}} {{KEY|S}}
|Version=0.14
|Version=0.14
|SeeAlso=[[Draft_Text|Draft Text]], [[Part_Extrude|Part Extrude]], [[Macro_Fonts_Win10_PYMP|Macro Fonts Win10 PYMP]]
|SeeAlso=[[Draft_Text|Draft Text]], [[Draft_Label|Draft Label]], [[Part_Extrude|Part Extrude]]
}}
}}


==Description==
==Description==


The {{Button|[[Image:Draft_ShapeString.svg|16px]] [[Draft_ShapeString|Draft ShapeString]]}} tool inserts a compound shape that represents a text string. Text height, tracking and font can be specified.
The [[Image:Draft_ShapeString.svg|24px]] [[Draft_ShapeString|Draft ShapeString]] command creates a compound shape that represents a text string. This shape can be used to create 3D letters with the [[Part_Extrude|Part Extrude]] command.
The resulting shape can be used with the [[Image:Part_Extrude.svg|24px]] [[Part_Extrude|Part Extrude]] tool to create 3D letters.


'''Alternatively''': To insert a simpler text element without a closed shape use [[Image:Draft_Text.svg|24px]] [[Draft_Text|Draft Text]]. To create a text label with a lead and an arrow use [[Image:Draft_Label.svg|24px]] [[Draft_Label|Draft Label]].
The Draft ShapeString command is not intended for standard text annotations. The [[Draft_Text|Draft Text]] command or the [[Draft_Label|Draft Label]] command should be used for that purpose.


[[Image:Draft_ShapeString_Example400.png]]
[[Image:Draft_ShapeString_Example400.png]]
{{Caption|Single point required to position the Shapestring}}
{{Caption|Single point required to position the ShapeString}}


==Usage==
==Usage==


# There are several ways to invoke the command:
If your Draft interface mode is set to ToolBar:
# Press the {{Button|[[Image:Draft_ShapeString.svg|16px]] [[Draft_ShapeString|Draft ShapeString]]}} button, or press {{KEY|S}} then {{KEY|S}} keys.
#* Press the {{Button|[[Image:Draft_ShapeString.svg|16px]] [[Draft_ShapeString|Draft ShapeString]]}} button.
#* Select the {{MenuCommand|Drafting → [[Image:Draft_ShapeString.svg|16px]] Shape from text}} option from the menu.
# Click a point on the 3D view, or type a [[Draft_Coordinates|coordinate]] and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] [[Draft_AddPoint|add point]]}} button.
# Enter the desired text, and press {{KEY|Enter}}.
#* Use the keyboard shortcut: {{KEY|S}} then {{KEY|S}}.
# The {{MenuCommand|ShapeString}} task panel opens.
# Enter the desired size, and press {{KEY|Enter}}.
# Click a point in the [[3D_view|3D view]], or type [[Draft_Coordinates|coordinates]].
# Enter the desired tracking, and press {{KEY|Enter}}.
# Optionally press the {{Button|Reset Point}} button to reset the point to the origin.
# Press {{KEY|Enter}} to accept the displayed font file, or press {{Button|...}} to select a font file.
# Enter a {{MenuCommand|String}}.
[[Image:SSFontSelect.png]]
# Specify the {{MenuCommand|Height}}.
# To select a font do one of the following:
#* Enter a file path in the {{MenuCommand|Font file}} input box.
#* Press the {{Button|...}} button and select a file.
# Press the {{Button|OK}} button to finish the command.


==Options==
If your Draft interface mode is set to TaskView:
# Press the {{Button|[[Image:Draft_ShapeString.svg|16px]] [[Draft_ShapeString|Draft ShapeString]]}} button, or press {{KEY|S}} then {{KEY|S}} keys.
# A dialog will appear where you can specify your parameters.
# Press {{KEY|OK}} to create the ShapeString.


* Press {{KEY|Esc}} or the {{Button|Close}} button to abort the command.


==Preferences==
*The text, size, tracking, and font can be changed after creation, by modifying the values in the Property Editor.

*You will want to set the default font file in [[Draft Preferences|Draft Preferences]], in the {{Button|Texts and dimensions}} tab. This will prefill the font file box in the dialog.
* The default font file can be changed in the preferences: {{MenuCommand|Edit → Preferences... → Draft → Texts and dimensions → Default ShapeString font file}}. See [[Draft_Preferences|Draft Preferences]].
*Supported fonts include TrueType (.ttf), OpenType (.otf), and Type 1 (.pfb).

==Notes==


* Supported fonts include TrueType ({{FileName|.ttf}}), OpenType ({{FileName|.otf}}) and Type 1 ({{FileName|.pfb}}).
===Limitations===
* The command is restricted to left-to-right text.
* Very small text heights may result in deformed character shapes due to loss of detail in scaling.
* Very small text heights may result in deformed character shapes due to loss of detail in scaling.
* Many fonts will generate problematic geometry. This is because font contours are allowed to overlap, have small gaps, and have varying directions within a glyph. These conditions are considered errors in wires used to define faces.
* The current version is limited to left-to-right writing.
* Draft ShapeStrings can also be created with the [[Macro_Fonts_Win10_PYMP|Macro Fonts Win10 PYMP]].
* To create text arranged in a circular fashion use the {{Button|[[File:FCCircularTextButtom.png|24px]] [[Macro_FCCircularText|Circular Text]]}} macro.
* To create Draft ShapeStrings arranged in a circular fashion use the [[Macro_FCCircularText|Macro FCCircularText]].


==Options==
==Tutorials==


* [[Draft_ShapeString_tutorial|Draft ShapeString tutorial]]: extrude a ShapeString, position it in 3D space, and create an engraving in another body.
* To enter coordinates manually, simply enter the numbers, then press {{KEY|Enter}} between each X, Y and Z component. You can press the {{Button|[[Image:Draft_AddPoint.svg|16px]] [[Draft_AddPoint|add point]]}} button when you have the desired values to insert the point.
* [https://forum.freecadweb.org/viewtopic.php?f=3&t=36623 How to use ShapeStrings in PartDesign]
* Press {{KEY|Esc}} or the {{Button|Close}} button to abort the current command.


==Properties==
==Properties==


See also: [[property_editor|Property editor]].
* {{PropertyData|Position}}: specifies the position of the base point of the compound shape.

* {{PropertyData|Angle}}: specifies the rotation of the baseline of the shape.
A Draft ShapeString object is derived from a [[Part_Part2DObject|Part Part2DObject]] and inherits all its properties. It also has the following additional properties:
* {{PropertyData|Axis}}: specifies the axis to use for the rotation.

* {{PropertyData|String}}: specifies the text string to display; unlike the [[Draft_Text|Draft Text]] tool, the [[Draft_ShapeString|Draft ShapeString]] can only display a single line.
===Data===
* {{PropertyData|Size}}: specifies the general height of the letters.

* {{PropertyData|Tracking}}: specifies the additional inter-character spacing in the string.
{{TitleProperty|Draft}}
* {{PropertyData|Font File}}: specifies the full path of the font file used to draw the string.

* {{PropertyData|Font File|File}}: specifies the path of the font file used to draw the text.
* {{PropertyData|Size|Length}}: specifies the general height of the text.
* {{PropertyData|String|String}}: specifies the text string to display. Unlike a [[Draft_Text|Draft Text]], a Draft ShapeString can only display a single text line.
* {{PropertyData|Tracking|Length}}: specifies the additional inter-character spacing of the text.

===View===

{{TitleProperty|Draft}}

* {{PropertyView|Pattern|Enumeration}}: specifies the [[Draft_Pattern|Draft Pattern]] with which to fill the faces of the text. This property only works if {{PropertyView|Display Mode}} is {{value|Flat Lines}}.
* {{PropertyView|Pattern Size|Float}}: specifies the size of the [[Draft_Pattern|Draft Pattern]].


==Scripting==
==Scripting==
{{Emphasis|See also:}} [[Draft_API|Draft API]] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].


See also: [https://www.freecadweb.org/api Autogenerated API documentation] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].
The ShapeString tool can be used in [[macros|macros]] and from the [[Python|Python]] console by using the following function:

To create a Draft ShapeString use the {{incode|make_shapestring}} method ({{Version|0.19}}) of the Draft module. This method replaces the deprecated {{incode|makeShapeString}} method.

{{Code|code=
{{Code|code=
ShapeString = makeShapeString(String, FontFile, Size=100, Tracking=0)
shapestring = make_shapestring(String, FontFile, Size=100, Tracking=0)
}}
}}


* Creates a {{incode|ShapeString}} compound shape using the specified {{incode|String}} and the full path of a supported {{incode|FontFile}}.
* Creates a {{incode|shapestring}} compound shape using the specified {{incode|String}} and the full path of a supported {{incode|FontFile}}.
* {{incode|Size}} is the height of the resulting text in millimeters.
* {{incode|Size}} is the height of the resulting text in millimeters.
* {{incode|Tracking}} is the additional inter-character spacing in millimeters.
* {{incode|Tracking}} is the additional inter-character spacing in millimeters.
Line 84: Line 105:


Example:
Example:

{{Code|code=
{{Code|code=
import FreeCAD as App
import FreeCAD as App
Line 94: Line 116:
font3 = "/usr/share/fonts/truetype/freefont/FreeSerifItalic.ttf"
font3 = "/usr/share/fonts/truetype/freefont/FreeSerifItalic.ttf"


S1 = Draft.makeShapeString("This is a sample text", font1, 200)
S1 = Draft.make_shapestring("This is a sample text", font1, 200)


S2 = Draft.makeShapeString("Inclined text", font2, 200, 10)
S2 = Draft.make_shapestring("Inclined text", font2, 200, 10)


ZAxis = App.Vector(0, 0, 1)
zaxis = App.Vector(0, 0, 1)
p2 = App.Vector(-1000, 500, 0)
p2 = App.Vector(-1000, 500, 0)
place2 = App.Placement(p2, App.Rotation(ZAxis, 45))
place2 = App.Placement(p2, App.Rotation(zaxis, 45))
S2.Placement = place2
S2.Placement = place2


S3 = Draft.makeShapeString("Upside-down text", font3, 200, 10)
S3 = Draft.make_shapestring("Upside-down text", font3, 200, 10)
S3.Placement.Base = App.Vector(0, -1000, 0)
S3.Placement.Base = App.Vector(0, -1000, 0)
S3.Placement.Rotation = App.Rotation(ZAxis, 180)
S3.Placement.Rotation = App.Rotation(zaxis, 180)


doc.recompute()
doc.recompute()
}}
}}


==Tutorials==

* [[Draft_ShapeString_tutorial|Draft ShapeString tutorial]]: extrude a ShapeString, position it in 3D space, and create an engraving in another body.
* [https://forum.freecadweb.org/viewtopic.php?f=3&t=36623 How to use ShapeStrings in PartDesign]

==Notes==

* Many fonts will generate problematic geometric. This is because font contours are allowed to overlap, have small gaps and have varying directions within a glyph. These conditions are considered errors in the Wires used to define Faces. Options are to correct the font definition with a tool like FontForge or to use another font.


{{Docnav
{{Docnav
|[[Draft_Point|Point]]
|[[Draft_Facebinder|Facebinder]]
|[[Draft_Facebinder|Facebinder]]
|[[Draft_Text|Text]]
|[[Draft_Module|Draft]]
|[[Draft_Module|Draft]]
|IconL=Draft_Point.svg
|IconL=Draft_Facebinder.svg
|IconR=Draft_Facebinder.svg
|IconR=Draft_Text.svg
|IconC=Workbench_Draft.svg
|IconC=Workbench_Draft.svg
}}
}}
Line 130: Line 144:
{{Draft Tools navi{{#translation:}}}}
{{Draft Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Revision as of 11:23, 4 May 2021

Draft ShapeString

Menu location
Drafting → Shape from text
Workbenches
Draft, Arch
Default shortcut
S S
Introduced in version
0.14
See also
Draft Text, Draft Label, Part Extrude

Description

The Draft ShapeString command creates a compound shape that represents a text string. This shape can be used to create 3D letters with the Part Extrude command.

The Draft ShapeString command is not intended for standard text annotations. The Draft Text command or the Draft Label command should be used for that purpose.

Single point required to position the ShapeString

Usage

  1. There are several ways to invoke the command:
    • Press the Draft ShapeString button.
    • Select the Drafting → Shape from text option from the menu.
    • Use the keyboard shortcut: S then S.
  2. The ShapeString task panel opens.
  3. Click a point in the 3D view, or type coordinates.
  4. Optionally press the Reset Point button to reset the point to the origin.
  5. Enter a String.
  6. Specify the Height.
  7. To select a font do one of the following:
    • Enter a file path in the Font file input box.
    • Press the ... button and select a file.
  8. Press the OK button to finish the command.

Options

  • Press Esc or the Close button to abort the command.

Preferences

  • The default font file can be changed in the preferences: Edit → Preferences... → Draft → Texts and dimensions → Default ShapeString font file. See Draft Preferences.

Notes

  • Supported fonts include TrueType (.ttf), OpenType (.otf) and Type 1 (.pfb).
  • The command is restricted to left-to-right text.
  • Very small text heights may result in deformed character shapes due to loss of detail in scaling.
  • Many fonts will generate problematic geometry. This is because font contours are allowed to overlap, have small gaps, and have varying directions within a glyph. These conditions are considered errors in wires used to define faces.
  • Draft ShapeStrings can also be created with the Macro Fonts Win10 PYMP.
  • To create Draft ShapeStrings arranged in a circular fashion use the Macro FCCircularText.

Tutorials

Properties

See also: Property editor.

A Draft ShapeString object is derived from a Part Part2DObject and inherits all its properties. It also has the following additional properties:

Data

Draft

  • DataFont File (File): specifies the path of the font file used to draw the text.
  • DataSize (Length): specifies the general height of the text.
  • DataString (String): specifies the text string to display. Unlike a Draft Text, a Draft ShapeString can only display a single text line.
  • DataTracking (Length): specifies the additional inter-character spacing of the text.

View

Draft

  • ViewPattern (Enumeration): specifies the Draft Pattern with which to fill the faces of the text. This property only works if ViewDisplay Mode is Flat Lines.
  • ViewPattern Size (Float): specifies the size of the Draft Pattern.

Scripting

See also: Autogenerated API documentation and FreeCAD Scripting Basics.

To create a Draft ShapeString use the make_shapestring method (introduced in version 0.19) of the Draft module. This method replaces the deprecated makeShapeString method.

shapestring = make_shapestring(String, FontFile, Size=100, Tracking=0)
  • Creates a shapestring compound shape using the specified String and the full path of a supported FontFile.
  • Size is the height of the resulting text in millimeters.
  • Tracking is the additional inter-character spacing in millimeters.

The placement of the ShapeString can be changed by overwriting its Placement attribute, or by individually overwriting its Placement.Base and Placement.Rotation attributes.

Example:

import FreeCAD as App
import Draft

doc = App.newDocument()

font1 = "/usr/share/fonts/truetype/msttcorefonts/Arial.ttf"
font2 = "/usr/share/fonts/truetype/dejavu/DejaVuSerif.ttf"
font3 = "/usr/share/fonts/truetype/freefont/FreeSerifItalic.ttf"

S1 = Draft.make_shapestring("This is a sample text", font1, 200)

S2 = Draft.make_shapestring("Inclined text", font2, 200, 10)

zaxis = App.Vector(0, 0, 1)
p2 = App.Vector(-1000, 500, 0)
place2 = App.Placement(p2, App.Rotation(zaxis, 45))
S2.Placement = place2

S3 = Draft.make_shapestring("Upside-down text", font3, 200, 10)
S3.Placement.Base = App.Vector(0, -1000, 0)
S3.Placement.Rotation = App.Rotation(zaxis, 180)

doc.recompute()