Macro Wiki Object Properties List Generator

Description
This macro generates lists of properties of the selected object in different forms in Wiki format. The list is printed to the Report view of FreeCAD. This macro can be used to simplify working with this Wiki with some restrictions. The property lists published in Wiki usually contain only unique parameters. Parameters inherited from parent objects are not published.

This script automatically removes inherited parameters from the list. But due to the software limitations of FreeCAD, it cannot delete absolutely all inherited parameters, so the lists generated by this script should be carefully checked before publishing.

Introduction
Each object created in FreeCAD is inherited from the parent object. The structure of these relationships is shown in the diagram below. You can read more about this on the page: Part Feature



How To Use

 * Preparing:
 * Copy code of Macro from this page and place it new *.FCMacro file.
 * Save FCMacro file, and place it to FreeCAD Macros folder.
 * Disable Include a timecode for each entry checkbox in Preferences -> General -> Output window (Tab).


 * First using:
 * Select (or create and select) only one object in tree view the type of you need.
 * Select Macro -> Macros... item in main menu.
 * In opened window find *.FCMacro file what you save letter and press Execute Button.
 * In the dialog that opens, select the type of report that you want to get by pressing button:
 * Only Main - prints only unique properties of base (parent) classes.
 * All Properties - prints absolutely all properties of selected object.
 * Inherits+Unique Properties - prints only unique properties with included inherits report.
 * Only Unique Properties - prints only unique properties.


 * How to use again:
 * To quickly run this macro again, you can use keyboard shortcut Shift+Ctrl+1 (on Windows) it will launch the last run macro.

Recommendations
Do not delete spaces between lines. This is necessary to simplify the translation. Each line separated by a space will be considered a separate part for translation. When creating texts, always remember that large monolithic fragments of text are difficult for translators to translate.

Examples of using

 * For example open the Part Workbench
 * Create a Sphere object.
 * Select the created Sphere object.
 * Run the macro.
 * Press one of the buttons in the dialog that opens.

The macro will generate a report depending on which button you clicked.

Note that the order of the lines in the parameter editor may differ from the order of the lines made by the generator.

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

Data

 * : The angle of the sphere


 * : The angle of the sphere


 * : The angle of the sphere


 * : The radius of the sphere



View
&#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;

Data
&#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;


 * : The angle of the sphere


 * : The angle of the sphere


 * : The angle of the sphere


 * : The radius of the sphere



View

 * : Display object bounding box


 * : Set the display mode


 * : Show the object in the tree view


 * : Show the object in the 3d view

The default value is 28.5 degrees, or 0.5 radians. The smaller the value the smoother the appearance in the 3D view, and the finer the mesh that will be exported.
 * : Specify how finely to generate the mesh for rendering on screen or when exporting.

in the 3D view (tessellation). Lower values indicate better quality. The value is in percent of object's size.
 * : Sets the accuracy of the polygonal representation of the model


 * : Object diffuse color.


 * : Defines the style of the edges in the 3D view.


 * : Set object lighting.


 * : 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