Macro TreeToAscii/it
|
|
| Descrizione |
|---|
| Questa macro genera una rappresentazione in stile ASCII dell'albero degli oggetti selezionati Versione macro: 0.6 Ultima modifica: 23-03-2020 Versione FreeCAD: 0.17+ Autore: OpenBrain |
| Autore |
| OpenBrain |
| Download |
| None |
| Link |
| Raccolta di macro Come installare le macro Personalizzare la toolbar |
| Versione macro |
| 0.6 |
| Data ultima modifica |
| 23-03-2020 |
| Versioni di FreeCAD |
| 0.17+ |
| Scorciatoia |
| Nessuna |
| Vedere anche |
| Nessuno |
Descrizione
Questa macro è stata scritta principalmente con lo scopo di documentare la costruzione del modello. Genera una rappresentazione in ASCII art dell'albero di costruzione dell'oggetto o degli oggetti selezionati.
Utilizzo
Selezionare gli oggetti di cui si desidera visualizzare l'albero e avviare la macro. Questa visualizzerà l'albero di ciascun oggetto in una finestra di dialogo. Tutti gli oggetti selezionati saranno considerati allo stesso livello gerarchico, in cima all'albero (anche se non sono presenti nel modello reale). Una volta aperta la finestra di dialogo, è possibile modificare lo stile e/o il pattern e rigenerare l'albero ASCII.
Sono disponibili diversi stili, al momento principalmente per supportare sistemi che potrebbero riscontrare problemi con la codifica Unicode:
- Modern: (predefinito) utilizza caratteri Unicode per visualizzare biforcazioni e ramificazioni
- Baroque: un altro stile Unicode con una maggiore indentazione
- ASCII: rappresentazione ASCII pura di biforcazioni e ramificazioni
Creare il proprio stile non dovrebbe essere troppo difficile: basta modificare la macro e cambiare/aggiungere uno stile alla variabile 'STYLES'. Lo stile selezionato viene salvato nei parametri di FreeCAD.
Il modello della linea è personalizzabile. Supporta diversi metadati definiti:
- {LBL} : Etichetta oggetto (etichetta visualizzata)
- {NAM} : Nome oggetto (nome interno) ad es. 'Box001'
- {SNAM} : Nome breve oggetto (senza cifre) ad es. 'Box001' verrà visualizzato come 'Box'
- {TYP} : Tipo oggetto ad es. 'Part::MultiFuse'
- {BTYP} : Tipo base oggetto ad es. 'Part::MultiFuse' verrà visualizzato come 'Part'
- {STYP} : Tipo breve oggetto (senza base) ad es. 'Part::MultiFuse' verrà visualizzato come 'MultiFuse'.
Il modello predefinito è '{LBL} ({SNAM})', il che significa, ad esempio, che l'oggetto 'Box001' etichettato 'myCube' verrà visualizzato come 'myCube (Box001)'. Si noti che sono consentiti praticamente tutti i caratteri. Se si desidera stampare le parentesi graffe, è necessario raddoppiarle. Ad esempio, con lo stesso oggetto di esempio, il modello '{LBL} (SNAME) {{{TYP}}} =>' stamperà 'myCube (Box) {Part::Box} =>'. I metadati disponibili sono visualizzati nel tooltip del campo di modifica del modello, quindi non è necessario ricordarli. Il modello di linea viene salvato nei parametri di FreeCAD.
Una volta aperta la finestra di dialogo, sono disponibili diverse azioni:
- Copy to clipboard: copia l'intero albero negli appunti
- Save to file: salva l'intero albero in un file a scelta sul sistema
- Embed in text file: memorizza l'intero albero in un file di testo incorporato nel documento (disponibile dalla versione 0.18.4 di FC)
- Naturalmente è possibile copiare qualsiasi parte dell'albero selezionandola e utilizzando i comandi di copia standard
Installazione
La macro è disponibile tramite Addon Manager. Il codice è riportato in questa pagina per comodità, nel caso in cui il sistema dell'utente non disponga di git-python. Sebbene dovrebbe essere aggiornato, l'ultima versione è sempre disponibile all'indirizzo FreeCAD-macro repository.
Per spiegazioni più dettagliate, consultare la pagina Come installare le macro.
Script
Discussione sul forum
Per qualsiasi feedback (bug, richiesta di nuove funzionalità, commenti, ecc.), si prega di utilizzare questa discussione sul forum: https://forum.freecad.org/viewtopic.php?f=22&t=43504
Codice
Macro_FCTree2Ascii.FCMacro
#!/usr/bin/python
#####################################
# Copyright (c) openBrain 2020
# Licensed under LGPL v2
#
# This FreeCAD macro prints the Tree of selected object(s) as ASCII art.
# Several styles are available. Tree branch pattern is customizable.
# It can export to clipboard, file or embedded text document.
# This mainly aims at documenting the model.
#
# Version history :
# *0.6 : introduce last fork string definition, add new style
# *0.5 : beta release
#
#####################################
# -*- coding: utf-8 -*-
__Name__ = 'TreeToAscii'
__Comment__ = 'Prints the Tree of selected object(s) as ASCII art'
__Author__ = 'openBrain'
__Version__ = '0.6'
__Date__ = '2020-03-23'
__License__ = 'LGPL v2'
__Web__ = 'https://wiki.freecad.org/Macro_TreeToAscii'
__Wiki__ = 'https://wiki.freecad.org/Macro_TreeToAscii'
__Icon__ = ''
__Help__ = 'Select object(s) you want to print the tree then run'
__Status__ = 'Beta'
__Requires__ = 'FreeCAD >= 0.17'
__Communication__ = 'https://forum.freecad.org/viewtopic.php?f=22&t=43504'
import FreeCAD as App
import FreeCADGui as Gui
from PySide import QtGui, QtCore # Special FreeCAD's PySide, which may be PySide2!
PREF_PATH = 'User parameter:BaseApp/Preferences/Mod/TreeToAscii'
PREF_PATTERN = 'TreePattern'
PREF_STYLE = 'TreeStyle'
STYLES = { # defines styles as NAME : [ branch str, fork str, opt:last fork str]
'Modern' : [' │ ', ' ├ ', ' └ '], # Unicode U+251C, Unicode U+2502
'Baroque' : [' │ ', ' ├─ ', ' └─ '],
'ASCII' : [' | ', ' \\_']
}
DEF_PATTERN = '{LBL} ({SNAM})'
DEF_STYLE = list(STYLES.keys())[0]
g_ascii_tree=""
def printChildren(objs=None, level=0, baseline=''):
"""Build ASCII tree by recursive call"""
global g_ascii_tree
for cnt, obj in enumerate(objs,1):
data = {
"LBL" : obj.Label,
"NAM" : obj.Name,
"SNAM" : "".join(filter(str.isalpha, obj.Name)),
"TYP" : obj.TypeId,
"BTYP" : obj.TypeId.partition('::')[0],
"STYP" : obj.TypeId.rpartition('::')[-1]
}
branch_str = STYLES[gen_style.currentText()][0]
fork_str = STYLES[gen_style.currentText()][1]
last_fork_str = STYLES[gen_style.currentText()][-1]
if cnt == len(objs):
g_ascii_tree += baseline + last_fork_str
else:
g_ascii_tree += baseline + fork_str
try:
g_ascii_tree += gen_pattern.text().format(**data)
except (ValueError, IndexError, KeyError):
g_ascii_tree = 'Error in generating pattern'
return
g_ascii_tree += '\n'
if cnt == len(objs):
baselinechi = baseline + ' '*len(branch_str)
else:
baselinechi = baseline + branch_str
printChildren(obj.ViewObject.claimChildren(), level + 1, baselinechi)
def copyToClip():
"""Copies ASCII tree to clipboard"""
tree_view.selectAll()
tree_view.copy()
tree_view.setPlainText("Copied to clipboard")
QtCore.QTimer.singleShot(3000, lambda:tree_view.setPlainText(g_ascii_tree))
def saveToFile():
"""Saves ASCII tree to user system file"""
_path = QtGui.QFileDialog.getSaveFileName()
if _path[0]:
save_file = QtCore.QFile(_path[0])
if save_file.open(QtCore.QFile.ReadWrite):
save_fileContent = QtCore.QTextStream(save_file)
save_fileContent << g_ascii_tree
save_file.flush()
save_file.close()
tree_view.setPlainText("Saved to file : " + _path[0])
else:
tree_view.setPlainText("ERROR : Can't open file : " + _path[0])
QtCore.QTimer.singleShot(3000, lambda:tree_view.setPlainText(g_ascii_tree))
def embedToText():
"""Stores ASCII tree into an embedded document"""
text_doc = None
try:
text_doc = App.ActiveDocument.addObject("App::TextDocument","ModelTree")
except:
tree_view.setPlainText("ERROR : can't create Text document. Maybe your version is too old")
if text_doc:
text_doc.Text = g_ascii_tree
tree_view.setPlainText("Embedded to text document : " + text_doc.Label)
QtCore.QTimer.singleShot(3000, lambda:tree_view.setPlainText(g_ascii_tree))
def updateTxt():
"""Updates ASCII tree"""
global g_ascii_tree
g_ascii_tree=""
printChildren(Gui.Selection.getSelection())
tree_view.setPlainText(g_ascii_tree)
def onGenerate():
"""Called when updating ASCII tree"""
p.SetString(PREF_PATTERN, gen_pattern.text())
p.SetString(PREF_STYLE, gen_style.currentText())
updateTxt()
# Get saved parameters or use defaults.
p = App.ParamGet(PREF_PATH)
g_name_pattern = p.GetString(PREF_PATTERN, DEF_PATTERN)
g_tree_style = p.GetString(PREF_STYLE, DEF_STYLE)
if g_tree_style not in STYLES:
g_tree_style = DEF_STYLE
# Build UI and show
dlg = QtGui.QDialog(Gui.getMainWindow(), QtCore.Qt.Tool)
dlg_layout = QtGui.QVBoxLayout(dlg)
gen_layout = QtGui.QHBoxLayout()
gen_pattern = QtGui.QLineEdit(g_name_pattern, dlg)
gen_pattern.setToolTip("""Defined variables are :
{LBL} : object Label
{NAM} : object Name
{SNAM} : object ShortName (without digits)
{TYP} : object Type
{BTYP} : object BaseType
{STYP} : object ShortType (without base)
If you need to print curly braces, they have to be doubled""")
gen_run = QtGui.QPushButton("Generate",dlg)
gen_run.clicked.connect(onGenerate)
gen_style = QtGui.QComboBox(dlg)
gen_style.addItems(list(STYLES.keys()))
gen_style.setCurrentIndex(list(STYLES.keys()).index(g_tree_style))
gen_layout.addWidget(QtGui.QLabel("Generating pattern: "))
gen_layout.addWidget(gen_pattern)
gen_layout.addWidget(QtGui.QLabel("Style : "))
gen_layout.addWidget(gen_style)
gen_layout.addWidget(gen_run)
tree_view = QtGui.QPlainTextEdit(g_ascii_tree)
tree_view.setReadOnly(True)
tree_view.setMinimumWidth(Gui.getMainWindow().width()/2)
tree_view.setMinimumHeight(Gui.getMainWindow().height()/2)
tree_view.setLineWrapMode(QtGui.QPlainTextEdit.NoWrap)
button_box = QtGui.QDialogButtonBox()
copy_clip_but = QtGui.QPushButton("Copy to clipboard", button_box)
button_box.addButton(copy_clip_but, QtGui.QDialogButtonBox.ActionRole)
copy_clip_but.clicked.connect(copyToClip)
_but = QtGui.QPushButton("Save to file", button_box)
button_box.addButton(_but, QtGui.QDialogButtonBox.ActionRole)
_but.clicked.connect(saveToFile)
store_embed_but = QtGui.QPushButton("Embed in a text file", button_box)
button_box.addButton(store_embed_but, QtGui.QDialogButtonBox.ActionRole)
store_embed_but.clicked.connect(embedToText)
close_dlg_but = QtGui.QPushButton("Close", button_box)
button_box.addButton(close_dlg_but, QtGui.QDialogButtonBox.RejectRole)
button_box.rejected.connect(dlg.reject)
dlg_layout.insertLayout(0,gen_layout)
dlg_layout.addWidget(tree_view)
dlg_layout.addWidget(button_box)
updateTxt()
dlg.exec_()