Macro TreeToAscii/de

Baum zu ASCII
Beschreibung
Dieses Makro generiert eine ASCII-Kunst-Darstellung des Baums der ausgewählten Objekte Versionsmakro : 0.6 Datum der letzten Änderung : 2020-03-23 FreeCAD version : 0.17+ Autor: OpenBrain
Autor
OpenBrain
Herunterladen
None
Links
Makros Rezepte Wie man Makros installiert Symbolleisten anpassen
Macro-Version
0.6
Datum der letzten Änderung
2020-03-23
FreeCAD-Version(s)
0.17+
Standardverknüpfung
None
Siehe auch
None

Beschreibung

Dieses Makro wurde hauptsächlich zum Dokumentieren der Modellkonstruktion geschrieben. Es erzeugt eine ASCII-Kunst-Darstellung des Konstruktionsbaums ausgewählter Objekte.

Anwendung

Einfach die Objekte auswählen, deren Baumstruktur gedruckt werden soll, und das Makro ausführen. Daraufhin wird die Baumstruktur jedes Objekts in einem Dialogfeld angezeigt. Alle ausgewählten Objekte werden als Objekte derselben Hierarchieebene am Anfang der Baumstruktur betrachtet (auch wenn dies im tatsächlichen Modell nicht der Fall ist). Sobald das Dialogfeld geöffnet ist, kann der Stil und/oder das Muster geändert werden und die ASCII-Baumstruktur neu generiert werden.

Es werden mehrere Stile angeboten, derzeit hauptsächlich zur Unterstützung von Systemen, bei denen Probleme mit der Unicode-Kodierung auftreten können:

• Modern: (Standard) verwendet Unicode-Zeichen zur Anzeige von Verzweigungen und Verästelungen.
• Barock: ein weiterer Unicode-Stil mit größerer Einrückung
• ASCII: Reine ASCII-Darstellung von Verzweigungen und Verästelungen

Das Erstellen eines eigenen Stils sollte nicht allzu schwierig sein, indem man das Makro bearbeitet und einen Stil in der Variablen 'STYLES' ändern/hinzufügt. Die ausgewählte Stilauswahl wird in den FreeCAD-Parametern gespeichert.

Das Linienmuster kann angepasst werden. Es unterstützt verschiedene definierte Metadaten:

• {LBL} : Objektbezeichnung (angezeigte Bezeichnung)
• {NAM} : Objektname (interner Name), z. B. 'Box001'
• {SNAM} : Objekt-Kurzname (ohne Ziffern), z. B. 'Box001' will be displayed as 'Box'
• {TYP} : Objekttyp, z. B. 'Part::MultiFuse'
• {BTYP} : Objekt Basistyp z. B. 'Part::MultiFuse' wird angezeigt als 'Part'
• {STYP} : Objekt ShortType (ohne Basis) z. B. 'Part::MultiFuse' wird als 'MultiFuse' angezeigt.

Das Standardmuster ist '{LBL} ({SNAM})', Das bedeutet, dass beispielsweise das Objekt 'Box001' mit der Bezeichnung 'myCube' als 'myCube (Box001)' angezeigt wird. Man beachte, dass praktisch alle Zeichen zulässig sind. Wenn man geschweifte Klammern drucken möchte, müssen diese doppelt geschrieben werden. Beispielsweise wird bei demselben Beispielobjekt das Muster '{LBL} (SNAME) {{{TYP}}} =>' als 'myCube (Box) {Part::Box} =>' gedruckt. Die verfügbaren Metadaten werden in der QuickInfo des Musterbearbeitungsfeldes angezeigt, sodass Sie sich diese nicht merken müssen. Das Zeilenmuster wird in den FreeCAD-Parametern gespeichert.

Sobald das Dialogfeld geöffnet ist, stehen mehrere Aktionen zur Verfügung:

• In die Zwischenablage kopieren : kopiert den gesamten Baum in die Zwischenablage
• In Datei speichern : speichert den gesamten Baum in einer beliebigen Datei auf Ihrem System
• In Textdatei einbetten : speichert den gesamten Baum in einer in das Dokument eingebetteten Textdatei (verfügbar seit FC 0.18.4)
• Natürlich kann man jeden Teil des Baums kopieren, indem man ihn auswählt und die Standard-Kopierbefehle verwendet.

Installation

Das Makro ist über den Addon-Manager verfügbar. Der Code wird auf dieser Seite zur Verfügung gestellt, für den Fall, dass das Benutzersystem nicht über git-python verfügt. Obwohl es aktuell sein sollte, ist die neueste Version immer unter FreeCAD-Makro Repositorium verfügbar.

Ausführlichere Erläuterungen findet man unter: Wie man Makros installiert.

Skript

Forums-Diskussion

Für jegliches Feedback (Fehler, Funktionswünsche, Kommentare usw.) nutzen Sie bitte diesen Forum-Thread: https://forum.freecad.org/viewtopic.php?f=22&t=43504

Code

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_()