Macro Wiki Object Properties List Generator/fr

Description
Cette macro génère des listes de propriétés de l'objet sélectionné sous différentes formes au format Wiki. La liste est imprimée dans la Vue rapport de FreeCAD. Cette macro peut être utilisée pour simplifier le travail avec ce Wiki avec quelques restrictions. Les listes de propriétés publiées dans le Wiki ne contiennent généralement que des paramètres uniques. Les paramètres hérités des objets parents ne sont pas publiés.

Ce script supprime automatiquement les paramètres hérités de la liste. Mais en raison des limitations du logiciel FreeCAD, il ne peut pas supprimer absolument tous les paramètres hérités, donc les listes générées par ce script doivent être soigneusement vérifiées avant d'être publiées.

Introduction
Chaque objet créé dans FreeCAD est hérité de l'objet parent. La structure de ces relations est illustrée dans le diagramme ci-dessous. Vous pouvez en lire plus à ce sujet sur la page : Part Feature



Utilisation

 * Préparation :
 * Copiez le code de la macro de cette page et placez-le dans un nouveau fichier *.FCMacro.
 * Enregistrez le fichier FCMacro et placez-le dans le dossier Macros de FreeCAD.
 * Désactivez la case à cocher Inclure un timecode pour chaque entrée dans Préférences -> Général -> Fenêtre de sortie (onglet).


 * Première utilisation :
 * Sélectionnez (ou créez et sélectionnez) un seul objet dans l'arborescence le type de dont vous avez besoin.
 * Sélectionnez l'élément Macro -> Macros... dans le menu principal.
 * Dans la fenêtre ouverte, trouvez le fichier *.FCMacro que vous avez sauvegardé et appuyez sur le bouton Lancer.
 * Dans la boîte de dialogue qui s'ouvre, sélectionnez le type de rapport que vous voulez obtenir en appuyant sur un des boutons :
 * Only Main - imprime uniquement les propriétés uniques des classes de base (parent).
 * All Properties - imprime absolument toutes les propriétés de l'objet sélectionné.
 * Inherits+Unique Properties - imprime uniquement les propriétés uniques avec le rapport d'héritage inclus.
 * Only Unique Properties - imprime uniquement les propriétés uniques.


 * Comment utiliser à nouveau :
 * Pour relancer rapidement cette macro, vous pouvez utiliser le raccourci clavier Shift+Ctrl+1 (sous Windows) qui lancera la dernière macro exécutée.

Recommendations
Ne supprimez pas les espaces entre les lignes. Cela est nécessaire pour simplifier la traduction. Chaque ligne séparée par un espace sera considérée comme une partie distincte pour la traduction. Lorsque vous créez des textes, n'oubliez jamais que les grands fragments monolithiques de texte sont difficiles à traduire pour les traducteurs.

Exemples d'utilisation

 * Par exemple, ouvrez l'atelier Part
 * Créez un objet sphère.
 * Sélectionnez l'objet sphère créé.
 * Exécutez la macro.
 * Appuyez sur l'un des boutons de la boîte de dialogue qui s'ouvre.

La macro génère un rapport en fonction du bouton sur lequel vous avez cliqué.

Remarquez que l'ordre des lignes dans l'éditeur de paramètres peut être différent de l'ordre des lignes faites par le générateur.

{| class="wikitable" !style="width: 33%;"|Only Unique Properties !style="width: 33%;"|Inherits+Unique Properties !style="width: 33%;"|All Properties
 * - style="vertical-align: top;"

Données

 * : L'angle de la sphère


 * : L'angle de la sphère


 * : L'angle de la sphère


 * : Le rayon de la sphère



Vue
&#60;&#33;&#45;&#45; AngularDeflection inherited from class PartDesign::Body BoundingBox inherited from class PartDesign::Body Deviation inherited from class PartDesign::Body DiffuseColor inherited from class PartDesign::Body DisplayMode inherited from class PartDesign::Body DrawStyle inherited from class PartDesign::Body Lighting inherited from class PartDesign::Body LineColor inherited from class PartDesign::Body LineColorArray inherited from class PartDesign::Body LineMaterial inherited from class PartDesign::Body LineWidth inherited from class PartDesign::Body OnTopWhenSelected inherited from class PartDesign::Body PointColor inherited from class PartDesign::Body PointColorArray inherited from class PartDesign::Body PointMaterial inherited from class PartDesign::Body PointSize inherited from class PartDesign::Body Selectable inherited from class PartDesign::Body SelectionStyle inherited from class PartDesign::Body ShapeColor inherited from class PartDesign::Body ShapeMaterial inherited from class PartDesign::Body ShowInTree inherited from class PartDesign::Body Transparency inherited from class PartDesign::Body Visibility inherited from class PartDesign::Body &#45;&#45;&#62;

Données
&#60;&#33;&#45;&#45; AttacherType inherited from class Part::Part2DObject AttachmentOffset inherited from class Part::Part2DObject ExpressionEngine inherited from class PartDesign::Body Label inherited from class PartDesign::Body Label2 inherited from class PartDesign::Body MapMode inherited from class Part::Part2DObject MapPathParameter inherited from class Part::Part2DObject MapReversed inherited from class Part::Part2DObject Placement inherited from class PartDesign::Body Shape inherited from class PartDesign::Body Support inherited from class Part::Part2DObject Visibility inherited from class PartDesign::Body &#45;&#45;&#62;


 * : L'angle de la sphère


 * : L'angle de la sphère


 * : L'angle de la sphère


 * : Le rayon de la sphère



Vue

 * : Affiche la boîte de délimitation de l'objet.


 * : Définit le mode d'affichage.


 * : Affiche l'objet dans l'arborescence.


 * : Montre l'objet dans la vue 3D.


 * : Spécifie la finesse avec laquelle le maillage doit être généré pour le rendu à l'écran ou lors de l'exportation. La valeur par défaut est de 28,5 degrés ou 0,5 radians. Plus la valeur est petite plus l'apparence est lisse dans la vue 3D et plus le maillage exporté est fin.


 * : Définit la précision de la représentation polygonale du modèle dans la vue 3D (tessellation). Des valeurs plus faibles indiquent une meilleure qualité. La valeur est exprimée en pourcentage de la taille de l'objet.


 * : Couleur de diffusion de l'objet.


 * : Définit le style des bords dans la vue 3D.


 * : Définit l'éclairage de l'objet.


 * : Set object line color.


 * : Object line color array.


 * : Object line material.


 * : Set object line width.


 * : Set object point color


 * : Object point color array.


 * : Object point material.


 * : Set object point size.


 * : Set shape color


 * : Shape material


 * : Set object transparency

Object: On top only if the whole object is selected Element: On top only if some sub-element of the object is selected
 * : Enabled: Display the object on top of any other object when selected


 * : Set if the object is selectable in the 3d view


 * : Set the object selection style

Data







 * : Class name of attach engine object driving the attachment.


 * : Extra placement to apply in addition to attachment (in local coordinates)


 * : Mode of attachment to other object


 * : Sets point of curve to map the sketch to. 0..1 = start..end


 * : Reverse Z direction (flip sketch upside down)


 * : Support of the 2D geometry


 * : Property expressions


 * : User name of the object (UTF8)


 * : User description of the object (UTF8)


 * : The angle of the sphere


 * : The angle of the sphere


 * : The angle of the sphere


 * : The radius of the sphere


 * }

Generates properties of all parent base classes
...

Script
"+pr[1][4] if pr[1][4]!="" else "" to ignore status field if it not exists     print("\n"+"* : "+pr[1][3])

def add_to_blacklist(data_blacklist,view_blacklist,obj_type,temp_obj_name,show_report): printsr("Class: '"+obj_type+"'",show_report) # Make tempory object obj = FreeCAD.activeDocument.addObject(obj_type,temp_obj_name) name = obj.Name # Get Data parametrs printsr("Data parameters list:",show_report) for pr in obj.PropertiesList: if not show_report or pr not in data_blacklist: data_blacklist[pr]=obj_type atr = str(obj.getPropertyStatus(pr)).replace("[]","") typeid = (obj.getTypeIdOfProperty(pr) or "").replace("App::Property","") printsr(pr+" ("+typeid+") "+atr,show_report) # Get View parameters if it is possible obj = Gui.activeDocument.getObject(name) try: test = obj.PropertiesList printsr("View parameters list:",show_report) for pr in obj.PropertiesList: if not show_report or pr not in view_blacklist: view_blacklist[pr]=obj_type atr = str(obj.getPropertyStatus(pr)).replace("[]","") typeid = (obj.getTypeIdOfProperty(pr) or "").replace("App::Property","") printsr(pr+" ("+typeid+") "+atr,show_report) except: printsr("This class not support View parameters.",show_report) # Remove object FreeCAD.activeDocument.removeObject(name) printsr("",show_report) return data_blacklist,view_blacklist
 * 1) Add propertyes to blacklist if it not presentet in it yet

def fill_blacklists(show_report): data_blacklist={} view_blacklist={} # Interfaces are not supported #data_blacklist,view_blacklist = add_to_blacklist(data_blacklist,view_blacklist,"App::OriginGroupExtension","Temp",show_report) #data_blacklist,view_blacklist = add_to_blacklist(data_blacklist,view_blacklist,"Part::AttachExtension","Temp",show_report) #data_blacklist,view_blacklist = add_to_blacklist(data_blacklist,view_blacklist,"Sketcher::PropertyConstrainList","Temp",show_report) data_blacklist,view_blacklist = add_to_blacklist(data_blacklist,view_blacklist,"App::DocumentObject","Temp",show_report) data_blacklist,view_blacklist = add_to_blacklist(data_blacklist,view_blacklist,"App::GeoFeature","Temp",show_report) data_blacklist,view_blacklist = add_to_blacklist(data_blacklist,view_blacklist,"App::Part","Temp",show_report) data_blacklist,view_blacklist = add_to_blacklist(data_blacklist,view_blacklist,"Mesh::Feature","Temp",show_report) data_blacklist,view_blacklist = add_to_blacklist(data_blacklist,view_blacklist,"Fem::FemMeshObject","Temp",show_report) data_blacklist,view_blacklist = add_to_blacklist(data_blacklist,view_blacklist,"Path::Feature","Temp",show_report) data_blacklist,view_blacklist = add_to_blacklist(data_blacklist,view_blacklist,"Part::Part2DObject","Temp",show_report) # Part::Primitive is not possible to create #data_blacklist,view_blacklist = add_to_blacklist(data_blacklist,view_blacklist,"Part::Primitive","Temp",show_report) data_blacklist,view_blacklist = add_to_blacklist(data_blacklist,view_blacklist,"PartDesign::Feature","Temp",show_report) data_blacklist,view_blacklist = add_to_blacklist(data_blacklist,view_blacklist,"Part::BodyBase","Temp",show_report) data_blacklist,view_blacklist = add_to_blacklist(data_blacklist,view_blacklist,"PartDesign::Body","Temp",show_report) if show_report: print("List of all not unique properties of Data:\n"+str(data_blacklist)+"\n\nList of all not unique properties of View:\n"+str(view_blacklist)+"\n") return data_blacklist,view_blacklist

sel = FreeCADGui.Selection.getSelection if len(sel) != 1: msgbox = QtGui.QMessageBox(QtGui.QMessageBox.Question, u'Properties Generator', """You must select only one object in tree view!""") msgbox.exec_ else: # Show dialog for select type of report msgbox = QtGui.QMessageBox(QtGui.QMessageBox.Question, u'Properties Generator', """Select type of report Only Main - print only unique properties of main classes with types. All Properties - print all properties of selected object. Inherits+Unique Properties - print unique properties with inherits report. Only Unique Properties - print only unique properties of selected object. """) msgbox.setStandardButtons(QtGui.QMessageBox.Cancel) #

Links
The discussion on the forum: https://forum.freecadweb.org/viewtopic.php?f=21&t=61998