Flamingo Workbench

Introduction
"Flamingo tools" is a set of commands, collected in different toolbars, made to speed up some actions in FreeCAD. It is available among the list of official addons, so it's possible to get it using the addons-installer macro.



CommandsFrame.py: that is one simple toolbox of 12 commands to arrange frames, trusses and similar in FreeCAD with the Arch`s Structure objects. Read tutorialFrame.pdf for more informations.

CommandsEagle.py: that's basically an addition, and shortcut, to the very fine FreeCAD-PCB workbench, to import position of objects from a .brd Eagle's file on a PCB drawn in FreeCAD with the a.m. workbench relating only on their names. -> "If the parts in the group Parts of the .FCStd file have the same name of the parts in the .brd file, they will be moved to the position of the PCB specified in the .brd file." Read tutorialEagle.pdf for more informations

CommandsPolar.py: to import a set of polar coordinates from a spreadsheet and use them to draw a sketch. That is for future development of a project that includes also a prototype electronic board and a ultrasonic range finder...



CommandsPipe.py: new toolbar under development from September '16. Read tutorialPype.pdf for some anticipations. Read tutorialPype2.pdf for more specific features.

Tools
Detailed description inside the tutorials folder (pdf files)

Frame tools commands:

Place one-beam over one-edge (class frameIt) Given a beam object and an edge in the model, this tool lay down the beam over the edge by selecting them one after the other until ESC is pressed.

Fill the frame (class fillFrame) Dialog to create over multiple edges selected in the viewport the beams of the type of that previously chosen among those present in the model.

alignFlange (class alignFlange) Tool to rotate beams (or other objects) so that their surfaces are parallel to one reference plane. If multiple faces are preselected, objects will be rotated according the first face in the selections set. Otherwise the program prompts to select one reference face and then the faces to be reoriented until ESC is pressed.

Spin beams by 45 deg. (class spinSect) Tool to spin one object around the "Z" axis of its shape by 45 degrees.

Reverse orientation (class reverseBeam) Tool to spin one object around the "X" axis of its shape by 180 degrees. Notes: - if one circular edge of the object is selected, that is used as the pivot of rotation.

pivotTheBeam (class pivotBeam) Dialog to rotate one beam or other object around one of its edges. * "Angle (deg):" textbox: insert the degree of rotation. * "move/copy" radiobuttons: select if the object will be also copied. * [Rotate] button: execute the rotation. * [Reverse]: rotate in the opposite direction, if necessary.

Flush the surfaces (class levelBeam) Tool to flush the parallel faces of two objects. Notes: - actually the command takes to the same level, respect the position and orientation of the first face selected, the center-of-mass of all faces selected. Thus it translates the objects even if the faces are not parallel.

Mate the Edges (class alignEdge) Tool to mate two parallel edges. Notes: - actually the command moves the objects along the minimum distance of their selected edge to the first one. Thus it translates the object even if edges are not parallel. - It is also possible to select two edges of the same objects. With this method is possible to move quickly one object by steps defined on its own geometry.

rotJoinEdge (class rotJoin) Tool to translate and rotate the beams to mate two edges.

shiftTheBeam (class shiftBeam) Dialog to translate and copy objects. * "x/y/z" textboxes: direct input of amount of translation in each direction. * "Multiple" textbox: the multiple coefficient of the translation amount. * "Steps" textbox: the denominator of the translation amount. It's used when the amount of translation is to be covered in some steps. * "move/copy" radiobuttons: to select if the selected objects shall be copied or only translated. * [Displacement] button: takes the amount and direction of translation from the distance of selected entities (points, edges, faces). * [Vector] button: defines the amount and direction of translation by the orientation and length of the selected edge. * [Translate] button: execute the translation

stretchTheBeam (class stretchBeam) Dialog to change the length of beams. * "mm" textbox: the new length that will be applied to selected beams. * [Get Length] button: takes the new length from the selected geometry, either the length of a beam or edge or the distance between geometric entities (point, edges, faces). * [Stretch] button: execute the stretch operation to the selected beams. * slider: extends the reference length from -100% to +100%.

extendTheBeam (class extend) Dialog to extend one beam to one selected target. Note: - if entities are preselected before calling this command, the first entity is automatically taken as target and the object attached to it is removed from selection set.

adjustFrameAngle (class adjustFrameAngle) Tool to adjust the beams at square angles of frames.

Insert path (class insertPath) Tool to create a continuous DWire over the path defined by the edges selected in the viewport, even if these are not continuous or belongs to different objects.

FrameLine manager (class FrameLineManager) Dialog to create and change properties of objects FrameLine providing the following features: * a list of beams' profiles previously included in the model by "insertSection" dialog; * a combo-box to select the active FrameLine among those already created or to create a new one; * a text-box where to write the name of the FrameLine that is going to be created; if nothing or " ", the FrameLined will be named as default "Telaio00n"; * [Insert] button: creates a new FrameLine object or adds new members to the one selected in the combo-box if edges are selected in the active viewport. * [Redraw] button: creates new beams and places them over the selected path. New beams will be collected inside the group of the FrameLine. Does not create or update beams added to the FrameLine outside its defined path. * [Clear] button: deletes all beams in the FrameLine group. It applies also to beams added to the FrameLine outside its defined path. * [Get Path] button: assigns the Dwire selected to the attribute Path of the FrameLine object. * [Get Profile] button: changes the Profile attribute of the FrameLine object to the one of the beam selected in the viewport or the one selected in the list. * "Copy profile" checkbox: if checked generates a new profile object for each beam in order to avoid multiple references in the model. * "Move to origin" checkbox: if checked, moves the center-of-mass of the profile to the origin of coordinates system: that makes the centerline of the beam coincide with the c.o.m. of the profile. Notes: - if the name of a FrameLine object is modified, also the name of the relevant group will change automatically but not viceversa.

Insert Std. Sections (class insertSection) Dialog to create the set of profiles to be used in the model for object FrameLine. * "Section:" list: it includes all the sections defined in the .csv file corresponding to the selected section type. * "Section types:" list: the types of profiles defined with the .csv files included in the folder /tables * [Insert] button: creates the group "Profiles_set", if not already existing, and adds to it the object of the selected profile. Notes: - other profiles tables can be created by adding the relevant .csv file in the /tables folder. - Other profiles can be drafted in the model and dragged inside the group "Profiles_set". - The orientation of the DWires may influence the rendering of beams

Automatic installation
See Installing

From GitHub
To install the workbenches, you may copy as usual the files of this repository in a subfolder of \Mod in you FreeCAD installation of your system or use the addons-installer macro.

Links to Flamingo WB

 * Workbench Wiki:
 * FreeCAD Wiki:
 * FreeCAD Forum: 17035
 * Tutorials: https://github.com/oddtopus/flamingo/tree/master/tutorials
 * Videos:
 * Files:
 * Report bugs: Please report bugs at

Other useful links

 * DevWorkbenches: List of workbenches in development.
 * Macros recipes