Skip to content

Latest commit

 

History

History
879 lines (458 loc) · 26.2 KB

Macro_FCCircularText.md

File metadata and controls

879 lines (458 loc) · 26.2 KB
Raw

Macro FCCircularText

{{Macro |Name=Macro FCCircularText |Icon=FCCircularTextButtom.png |Description={{ColoredText|#ff0000|#ffffff|Latest macro version supports a HiDPI layout (QGridLayout) and runs only on versions 0.18 or higher (requires PySide2/Qt5)}}

For backward compatible version of the macro see [https://gist.githubusercontent.com/mario52a/a25e802498bae6959335/raw/db47f78f2b20a35137ac213b8d1a62d30f525dcb/Macro_FCCircularText.FCMacro FCCircularText] and install manually.

This macro makes use of the [[Draft ShapeString]] tool to create a text line placed in different circular orientations, including circumferential and helical (in the fashion of a Trajan Column). It can also be used to create a clock face with Arabic numerals ''1, 2, 3,'' etc., or Roman numerals ''I, II, III,'' etc. |Author=Mario52 |Version=0.20 |Date=2021/04/05 |FCVersion=0.19 |Download=[https://www.freecadweb.org/wiki/images/c/c1/FCCircularTextButtom.png ToolBar Icon] }}

Description

This macro makes use of the Draft ShapeString tool to create a text line placed in different circular orientations, including circumferential and helical in the fashion of a Trajan's Column. It can also be used to create a clock face with Arabic numerals 1, 2, 3, etc., or Roman numerals I, II, III, etc. This latter usage was inspired by the Forum thread Macro to Create Clock Face by FC community member, cblt2l.

: 360 degree orientation

Example of the macro displaying text in a 360 degree orientation

Usage

Launch the macro folder FcString for created characters and a file FcClock for created clocks.

All the characters are and remain independent. When creating extrusions nothing is deleted. If Compound is created with Run Comp it is copied out of the folder.

The options are shaded by default and are active in all functions if they are checked {{CheckBox|TRUE|}}:

  • {{CheckBox|Extrude Char.}}

  • {{CheckBox|Placement.}}

  • {{CheckBox|SP. inclination.}}

Except for one Clock Service Placement box Z is activated and moves the text in the direction Z to place the text on the support surface.

Notes

  • This macro will gray-out (deactivate) options that are not relevant for a selected function.

Interface

Overview

GUI

First section

  • TextEdit window that lets you copy the text to display (click on the Reset allows to know the number of the input string that is displayed in the window title)

  • The Reverse button reverses the text

  • {{CheckBox|Word}}checked, this option consider the text as word, the text is cut on space and write the text word by word (instead character by character in normal use)

  • LineEdit: display the path and name of file font

  • The Help button displays the wiki page in the FreeCAD browser

  • ComboView to choose the font

    • Default ARIAL.TTF

Options available

After the first use, you must modify the following parameters:

User parameter:BaseApp/Preferences/Macros/FCMmacros/FCCircularText

switchModeTextList

  • 0 = normal text mode (and black) cuts the switchFontComBox
  • 1 = allows switchFontComBox 1

switchFontComBox

  • 0 = (and switchModeTextList= 1) text mode (in color) in ComboBox list, faster
  • 1 = (and switchModeTextList= 1) fontFamily slower but more beautiful ComboBoxst!

setSystemFonts

  • 0 = matplotlib.font_manager.findSystemFonts("C:/", "ttf")
  • do all the fonts (in all folders and sub-folders of the DD) time !!
  • 1 = fontman.findSystemFonts(self.pathFont)
  • do all the fonts in the directory (and in all the sub-folders)

seTtextAlignement

  • 0 = AlignLeft (default)
  • 1 = AlignCenter
  • 2 = AlignRight

setFontByDefault

  • Font by Default

switchResetFALSE

  • 0 = reset (default)
  • 1 = no reset (not recommended) some switches can remain open or close unexpectedly!

Example

  1. switchModeTextList= False
  2. switchFontComBox = False
  3. setSystemFonts = False
  4. seTtextAlignement = 0

  1. switchModeTextList= True
  2. switchFontComBox = False
  3. setSystemFonts = False
  4. seTtextAlignement = 0

  1. switchModeTextList= True
  2. switchFontComBox = False
  3. setSystemFonts = False
  4. seTtextAlignement = 1 (0=Left, 1=Centered, 2=Right)

  1. switchModeTextList= True
  2. switchFontComBox = True
  3. setSystemFonts = False
  4. seTtextAlignement = 1

Second Section

Configuring characters in FCCircularText

First zone

Your choice :

Image:FCCircularText 20.png|Outdoor Image:FCCircularText 21.png|Indoor Image:FCCircularText 22.png|Helix Image:FCCircularText 23.png|Clock

  • Mode Standor Mode Flat : The text will be placed standing or flat (same as clock) options Outdoor and Indoor are reversed.

Image:FCCircularText 01.png|Mode Stand Outdoor The text will be written up. Image:FCCircularText_40.png|Mode Flat Outdoor The text will be placed flat.

Image:FCCircularText 39.png|Mode Flat Indoor The text will be placed flat. Image:FCCircularText_03.png|Mode Stand Indoor The text will stand registered (same as clock).

Second area

This section allows you to configure the overall behavior of characters in all the choices available but with some variation. If the command is not used in the option chosen, it will be grayed out.

left

  • {{SpinBox|10.0 mm}}Radius of circle : Radius of the circle. (Default 10)

  • {{SpinBox|2.0 mm}}Size character : Character height. (Default 2)

  • {{SpinBox|0 deg}}Begin angle : Starting angle of the first character in the circle. (Default 0 °)

  • {{SpinBox|360 deg}}End angle : Angle end of the last character of the text. (Default 360)

  • {{SpinBox|10.0 deg}}Correction angle : Character correction angle to make it tangent to the circle. (Default 10 °)

  • {{SpinBox|0.15 mm}}Correction radius : Fixed the radius of the circle characters (optional). (Default 0.15)

  • {{CheckBox|'''Extrude Char'''}}: Checkbox extrusion characters. (Inactive Default)

  • {{CheckBox|'''Placement'''}}: Text placement in the 3D view. (Inactive Default)

  • {{CheckBox|'''Sp. inclination'''}}: Inclination of characters in three axes X, Y and Z (example to cover such a cone). (Inactive Default)

Outdoor

Default mode. The text is written on the outside of the circumference of the circle.

Image:FCCircularText 20.png|Outdoor Image:FCCircularText 25.png| Image:FCCircularText 30.png|

Indoor

The text is written on the inner side of the circumference of the circle

File:FCCircularText 21.png|Indoor Image:FCCircularText 03.png| Image:FCCircularText 27.png|

Helix

The text is entered on the outer circumference of a helix.

Image:FCCircularText 22.png| Helix Image:FCCircularText 33.png| Image:FCCircularText 34.png|

  • The helix area is hidden by default. The window is visible if the radio button {{RadioButton|TRUE|Helix}} is checked

  • All characters configuration options are available.
  • Step of helix which corresponds to the pitch of the helix turns and displays 2 (character height) by default.
  • '''Char. per turn '''activates and displays 10 by default, which corresponds to 10 characters per helical turn.

  • If Step of helix (helix pitch) is zero, Spinboxes Base Helix and End Helix are activated.
  • Base Helix provides the basis for starting the helix (even Placement Z). If '' 'Placement Z' '' is different from zero, the starting point is added to Z Placement
  • End Helix End of the helix pitch of the helix will be calculated relative to the height and the number of characters per helical turn.
Clock

The figures are part of a circle with Arabic numerals or Romans.

Image:FCCircularText 23.png|Clock Image:FCCircularText 35.png|Axial Image:FCCircularText 36.png|Redress

  • By default, the section is hidden. The window is visible if the radio button {{RadioButton|TRUE|Clock}} is checked

  • When the selection is made, the following functions get dark and are usable:
    1. Begin angle.
    2. End angle.
    3. Correction angle.
    4. Correction radius.
    5. The buttom Mode Stand or Mode Flat.
  • The area Clock is activated.

  • Radius of support : If a value is given, support will be created (default 0).
  • If Support number face is different from zero a support is created. (If '''Extrude support '''= zero then a face is created).
    • 1 = A circle is created (circle appears).
    • 2 = A rectangle is created (length = (Radius of media * 1.5) width = Radius of support) (Rectangle appears).
    • 3 = A triangle is created (circumscribed) (Triangle appears).
    • 4 = A square is created (Radius of support) (Square appears).
    • 5 = A polygon with the number of faces displayed (circumscribed) (Polygon appears).
  • Extrude support is activated and an extrusion dimension can be given.

<img alt="" src=images/FCCircularText_18.png )![](images/FCCircularText_38.png style="width:200px;"> <img alt="" src=images/FCCircularText_17.png )![](images/FCCircularText_37.png style="width:200px;">

  • If Support number face is equal to zero there is no support.

  • Mode Roman: The writing will be in Roman figures I II III IIII V VI VII VIII IX X XI XII

  • Axial: The figures will be written axially.

Path section

The title section change and display the length of the wire selected.

If you select one wire, arc, circle, line and edge the section Path is coloured in {{ColoredText|#E0F8E0|green}} and the unused command coloured in {{ColoredText|#F8E0E0|red}}

  1. {{RadioButton|Orthogonal}}the character is Orthogonal to the view

  2. {{RadioButton|Tangent}}the character is Tangent to point path on wire

  3. {{RadioButton|BB Base}}the point base of the character is to point path on the wire

  4. {{RadioButton|BB Center}}the bounBox center of the character is to point path on the wire

  5. {{RadioButton|BB Top}}the top boundBox of the character is to point path on the wire

the last Radio Button used is saved in the parameter of FreeCAD

Command section

  • Exit: Leaves the macro.

  • Reset: Reset all values and displays the number of characters displayed in the window.

  • Run Comp: Launches the macro and creates a Compount object of all characters.

  • Run: Launches the macro

Parameters available

Certain parameter are available in the parameters of FreeCAD see: Menu → Tools → Edit parameters...

  • User parameter: BaseApp/Preferences/Macros/FCMmacros/FCCircularText

    • switchModeTextList

      :

      • False

        normal text mode (and black) turns off switchFontComBox

      • True

        allow switchFontComBox 1 (default)

    • switchFontComBox

      :

      • False

        (and switchModeTextList = 1) text mode (in color) in Faster ComboBox list (default)

      • True

        (and switchModeTextList = 1) font Family in ComboBox list slower but more beautiful!

    • setSystemFonts

      :

      • False

        matplotlib.font_manager.findSystemFonts ("C: /", "ttf") do all fonts (in all folders and subfolders of the HD) time !!

      • True

        fontman.findSystemFonts (self.pathFont)make all the fonts in the directory (and in all the subfolders) (default)

    • seTtextAlignement

      : 0 = AlignLeft (default) 1 = AlignCenter 2 = AlignRight

    • setFontByDefault

      : Font by Default (the last used)

    • switchResetFALSE

      : False reset (default), True no reset (not recommended) some switches can stay open or close unexpectedly!

    • setPathOrthogonal

      : True False

    • setPathTangent

      : True False

    • setPositionBase

      : True False

    • setPositionCenter

      : True False

    • setPositionTop

      : True False

    • switchVersionSearch

      : True False

    • Version

      : FCCircularText version

Launch the macro folder FcString for created characters and a file FcClock for created clocks.

Script

The button icon:

- in .PNG

- in .SVG File:FCCircularTextButtom.svg

(See Customize_Toolbars for more)

Script

Macro_Circular_Text.FCMacro

or download the script :

- on github Macro_FCCircularText.FCMacro ver 0.20 2021/04/05

- at the forum Extrude from curved surface of cylinder

Example

Image:FCCircularText 02.png|Text beginning at 180 degrees (Begin angle) end at 360 degrees (End angle) external curve. Image:FCCircularText 03.png|Text set in an inner curve.

Image:FCCircularText 04.png|Text circular on internal and external curve. Image:FCCircularText 05.png|Circular text on a flat onbjet.

Image:FCCircularText IndoorFlat 01.png|Configuration Superior.(click to elarge) Image:FCCircularText IndoorFlat 02.png|Configuration Inferior.(click to elarge)

Image:FCCircularText 26.png|External curve. Image:FCCircularText 28.png|Internal curve.

Image:FCCircularText 29.png|Internal curve extrusion material designated and subtraction. Image:FCCircularText 31.png|External curve.

Image:FCCircularText 32.png|Internal curve with subtraction. Image:FCCircularText 41.png|Extrusion on a cone with '''Sp. Inclination '''45° axis Z.

Image:FCCircularText 42.png|Ring Internal curve with subtraction. Image:FCCircularText 61.png|Pivot character 0°, 90°, ....

Image:FCCircularText_Path_00_002_000.png| {{CheckBox|TRUE|Word}} The text is cutting on space character

Example onto Ellipse

Image:FCCircularText 43.png|Create your ellipse hers 100x50. Image:FCCircularText 44.png|Exrtude it 50 mm.

Image:FCCircularText 45.png|Discretize the perimeter and create points with the macro Work Features. Tab Point > Point 2/3 > Points=Cut (Wire) Image:FCCircularText 46.png|Create the circle to 3 points with the macro Work Features. Tab Circle Circle=(3 Points)

Image:FCCircularText 47.png|Create point center circle with the macro Work Features. Tab Point > Point 1/3 > Circle(s) center. Image:FCCircularText 48.png|Create the benchmark lines and configure FCCircularText.

Image:FCCircularText 49.png|Create the text with

Image:FCCircularText 51.png|Delete the circle, points and lines. Image:FCCircularText 52.png|Ellipses.

Mode relief:

Image:FCCircularText 53.png|Create an ellipse. Image:FCCircularText 54.png|Create a rectangle include all object.

Image:FCCircularText 55.png|Select the rectangle , the ellipse and make compound Activate the Part module, then Menu Part > Make compound. Image:FCCircularText 56.png|Extrude the compound of Solid.

Image:FCCircularText 57.png|Select Shape (text) , the compound and Cut. Image:FCCircularText 58.png|The text is cut in the shape of the ellipse.

Image:FCCircularText 59.png|Select the Ellipse extruded , the Cut (text) and fuse.

Example section path

Image:FCCircularText_Path_00_Orth_Base_000.png|Text on BoundBox Base (normal) Image:FCCircularText_Path_00_Orth_Center_000.png|Text on BoundBox Center character

Image:FCCircularText_Path_00_Orth_Top_000.png|Text on BoundBox Top character Image:FCCircularText_Path_00_001_000_000.png|Text on selected line: 1: Orthogonal 2: Tangent

Limitations

Note

it is possible that an error may occur between versions. Please post the issue on the forum and wait for the updated fix or rollback to a previous version of the macro. Thank you)

It is possible that two characters may overlap. If this happens, here's a workaround is available using the Rotate-To-Point Macro.

Image:FCCircularText Correction.gif|Character overlap issue and the workaround

(not fully developed)

Planned:

Writing on a path circular text of position object selected.

Change log

  • ver 0.20 2021/04/05 : adding icone in macro, Tab for diminish the heigth of the macro, remove all dimensions of widgets now fully compatible with the stylesheet, revisite the search version for compatibility and other little change.

  • ver 1.19 2021/03/15 : adding button Delette the last object created and the code FreeCAD.ActiveDocument.openTransaction("FCCTc") for Undo/Redo system

    • Adding CheckBox {{CheckBox|FALSE|Reset}} for switched/activated (requested by users) the natural reset after all push button Runand Run comp. This use checkBox is {{ColoredText|not advised}}, is you constade one malfunction pusch the Reset button or quit FCCircularText and restart.

  • ver 0.18 2021/01/19 : correction bug see FCCircularText Macro issues

  • ver 0.17b 2020/09/28 : correction little bug (pl instead plm in path section) and arrange the window (dimension) Clock, Helix, Path

  • ver 0.17 2020/09/26 : adding create circular text on wire (curve, arc, spline, line ...) selected, mode word

ver 16d 2020/09/15 : see the MasterCATZ commented Sep 14, 2020 message

delette the FC 0.18 test section:

#### Test FreeCAD.Version simple ############################################################################################################
if int(FreeCAD.Version()[1]) < 18:      # Version de FreeCAD
    FreeCAD.Console.PrintMessage("This version " + __Title__ + " rmu  work with the FreeCAD 0.18 or higher." + "\n\n")
    FreeCAD.Console.PrintMessage("For the precedent version see the page " + "\n\n")
    FreeCAD.Console.PrintMessage("https://gist.githubusercontent.com/mario52a/a25e802498bae6959335/raw/db47f78f2b20a35137ac213b8d1a62d30f525dcb/Macro_FCCircularText.FCMacro" + "\n\n")
#### Test FreeCAD.Version simple ############################################################################################################

  • ver 0.16c 2020/07/24 : modify text proposed by Kunda1 Please review FCVerticalText Macro

  • ver 0.16b 2020/07/24 : correct __title__ to __Title__ in 0.18 FC test (see Please review FCVerticalText Macro)

  • ver 0.16 2020/06/07 : little bug in Linux with the path, impost PolicePath = "/usr/share/fonts/" (stay on path /xx/xx/xx/xx/xx/xx/ on entry)

  • ver 0.15 2020/06/01 : For PySide2 Qt5 adding matplotlib fonts in comboView, config on parameter

  • ver 0.14-4 2020/04/25 : corrected for "DisplayMode = u"Flat Lines" :

  • ver 0.14-3 2020/04/25 : adapted for :

OS: Windows 10 (10.0)
Word size of OS: 64-bit
Word size of FreeCAD: 64-bit
Version: 0.19.20655 (Git)
Build type: Release
Branch: master
Hash: e8e67e8c5ebbc9f9ed9ea67aba5b891969595ece
Python version: 3.6.8
Qt version: 5.12.1
Coin version: 4.0.0a
OCC version: 7.3.0

       carDegrees = b' \xc2\xb0'.decode("utf-8")    #thanks wmayer https://forum.freecadweb.org/viewtopic.php?f=13&t=36380&p=308476#p308357        self.DS_InclinaisonX.setSuffix(carDegrees)        self.DS_InclinaisonY.setSuffix(carDegrees)        self.DS_InclinaisonZ.setSuffix(carDegrees)

  • ver 0.14-1 2019/06/11 replace "°" to chr(176)

  • ver 0.14 2019/04/27 compatible for Python 3.6.6 and Qt 5.6.2 (cause: unicode() )

latest testing:

#OS: Windows 10
#Word size of OS: 64-bit
#Word size of FreeCAD: 64-bit
#Version: 0.19.16523 (Git)
#Build type: Release
#Branch: master
#Hash: 9b3ec233c8b21e0df66fada487cd10f471d60cac
#Python version: 3.6.6
#Qt version: 5.6.2
#Coin version: 4.0.0a
#OCC version: 7.3.0

  • ver 0.13 30/01/2018 add feature Pivot for rotate the character on himself

  • ver 0.13 09/08/2016 replace the button "New font" to "fontComboBox" cause , with Windows 10 the window Font stay empty the files are hidden

  • ver 0.12 03/07/2016 optimize the code for accept the decimal number in determination angle

replace the line

            for angleTr in range(debut,rotation,((rotation-debut)/nombre)): 
``` to  
```python
            for angleTrFloat in range((debut*10000),(rotation*10000),int((round(((float(rotation)-float(debut))/float(nombre)),4)*10000)) ):    # pour 4 decimales
                angleTr = (float(angleTrFloat)/10000)
  • ver 0.10 17/05/2015 adding lines 1365, 1366 only created more clock face ?? ()
            supp.MakeFace = True
            App.activeDocument().recompute()
  • ver 0.9 11/05/2015 thank you NormandC for testing

replace

        self.DS_InclinaisonX.setSuffix(" X°")
        self.DS_InclinaisonY.setSuffix(" Y°")
        self.DS_InclinaisonZ.setSuffix(" Z°")
``` to 
```python
        self.DS_InclinaisonX.setSuffix(unicode(" X°"))
        self.DS_InclinaisonY.setSuffix(unicode(" Y°"))
        self.DS_InclinaisonZ.setSuffix(unicode(" Z°"))
  • ver 0.8 10/05/2015 replace "String=texte[ii2]" to "String=unicode(texte[ii2])" line 1290. cause "TypeError: Property 'FontFile': type must be str or unicode, not QString"<span \>
<translate>

# ver 0.8 10/05/2015 /_ # testing with OS :
</translate>
##################################################################################################
# OS: Ubuntu 14.04.1 LTS                          # OS: Ubuntu 14.04.2 LTS
# Platform: 32-bit                                # Word size of OS: 32-bit
# Version: 0.14.2935 (Git)                        # Word size of FreeCAD: 32-bit
# Branch: master                                  # Version: 0.16.4928 (Git)
# Hash: eab159b6ee675012bf79de838c206a311e911d85  # Branch: master
# Python version: 2.7.6                           # Hash: d8f63bcfd10301f3d1e141cced4370f0782238d0
# Qt version: 4.8.6                               # Python version: 2.7.6
# Coin version: 4.0.0a                            # Qt version: 4.8.6
# SoQt version: 1.6.0a                            # Coin version: 4.0.0a
# OCC version: 6.7.0                              # OCC version: 6.8.0.oce-0.17
##################################################################################################
# OS: Windows Vista                               # OS: Windows Vista
# Word size of OS: 32-bit                         # Word size of OS: 32-bit
# Word size of FreeCAD: 32-bit                    # Word size of FreeCAD: 32-bit
# Version: 0.15.4527 (Git)                        # Version: 0.15.4671 (Git)
# Branch: master                                  # Branch: releases/FreeCAD-0-15
# Hash: 0da2e4c45a9a259c26abd54c2a35393e1c15696f  # Hash: 244b3aef360841646cbfe80a1b225c8b39c8380c
# Python version: 2.7.8                           # Python version: 2.7.8
# Qt version: 4.8.6                               # Qt version: 4.8.6
# Coin version: 4.0.0a                            # Coin version: 4.0.0a
# OCC version: 6.7.1                              # OCC version: 6.8.0.oce-0.17
##################################################################################################
  • ver 0.7 02/02/2015 suppression 2 str App.Console.PrintMessage(str(PolicePath)+"\n") to App.Console.PrintMessage((PolicePath)+"\n") that caused an error with the characters above 128 in the police path.
  • ver 0.6 23/11/2014 corrected "texte = unicode(self.textEdit.toPlainText())" now accept "'éèà@..."
  • ver 0.5 19/11/2014 Gui
  • ver 0.4 10/10/2014 add variable "rotation" in the loop (for i in range(0,rotation,(rotation/nombre)): # 360 a parametrer)
  • ver 0.4 27/08/2014 correction error of de radius (exterieur=0, debout=1)
  • ver 0.3 26/08/2014 add creation text of flat curve
  • ver 0.2 26/08/2014 add creation text of internal curve
  • ver 0.1

(2537)

Links

To comment on the Extrude from curved surface of cylinder

documentation index > Draft > Macro FCCircularText