Flamingo Workbench/it

Introduzione
"Gli strumenti di Flamingo" sono un insieme di comandi e oggetti personalizzati di FreeCAD che aiutano principalmente a velocizzare il disegno di strutture e tubazioni.

Per comodità gli strumenti di Flamingo sono raggruppati in tre barre di strumenti/menu, più un set di utilità.


 * Frame tools: che ha lo scopo di posizionare strutture, travi e simili in FreeCAD usando gli oggetti Structure del modulo Arch. .../flamingo/tutorials/tutorialFrame.pdf
 * Pype tools: questa è la continuazione logica dello strumento Frame poiché si occupa della creazione di condutture e strutture tubolari. Dispone inoltre di proprie classi Python per creare gli oggetti tubazioni, come tubi, gomiti, flange, ecc. .../flamingo/tutorials/tutorialPype2.pdf
 * Eagle tools: è fondamentalmente un'aggiunta, e una scorciatoia, al molto professionale ambiente FreeCAD-PCB (disponibile anche nel repository aggiuntivo di FreeCAD) 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. È anche l'origine, per estensione, del nome dell'intero workbench. .../flamingo/tutorials/tutorialEagle.pdf
 * Utilities è una barra degli strumenti fornisce alcune funzionalità per interrogare gli oggetti nel modello e la loro distanza, per spostare o ruotare il piano di lavoro e una scorciatoia alla finestra di dialogo per la creazione di poligoni del modulo Draft, che consente di modificare la posizione del piano di lavoro al volo.

Riferimenti

 * Autore: oddtopus
 * Codice sorgente in github: https://github.com/oddtopus/flamingo

Installazione
Questo ambiente può essere facilmente installato e aggiornato dal Addon Manager disponibile in FreeCAD 0.17 e superiore. Per gli utenti di FreeCAD 0.16 e per altri metodi di installazione, fare riferimento alla pagina Installare componenti aggiuntivi.

Strumenti Frame



 * 1) Place one-beam over one-edge (class frameIt). Posiziona una-trave su un-segmento

Dato un oggetto trave e una linea nel modello, questo strumento posiziona la trave sulla linea selezionandoli uno dopo l'altro fino a quando non si preme ESC.


 * 2) Fill the frame (class fillFrame). Riempi l'ossatura

Finestra di dialogo per creare su più spigoli selezionati nella vista le travi del tipo scelto in precedenza tra quelli presenti nel modello.

Con il pulsante Select è possibile modificare il tipo di trave.


 * 3) alignFlange (class alignFlange). Allinea la flangia

Finestra di dialogo per ruotare le travi in modo che le loro superfici siano parallele a un piano di riferimento.

È possibile preselezionare la faccia di riferimento prima di invocare il comando.

I tre pulsanti XY, XZ e YZ consentono di scegliere direttamente l'orientamento dei piani principali come riferimento.

Infine è possibile inserire direttamente il nuovo orientamento delle facce con le tre coordinate della normale e il pulsante Set normal.


 * 4) Spin beams by 45 deg. (class spinSect). Ruota le travi di 45 gradi

Strumento per ruotare un oggetto di 45 gradi attorno all'asse "Z" della sua forma.


 * 5) Reverse orientation (class reverseBeam). Orientamento inverso

Strumento per ruotare un oggetto di 180 gradi attorno all'asse "X" della sua forma. Note: se viene selezionato un bordo dell'oggetto, tale bordo viene utilizzato come perno di rotazione.


 * 6) pivotTheBeam (class pivotBeam). Pivotta la trave

Finestra di dialogo per ruotare una trave o un altro oggetto attorno a uno dei suoi bordi

Angle casella di testo per inserire i gradi della rotazione.

Reverse per ruotare nella direzione opposta, se necessario.

OK per eseguire l'azione e Cancel per chiudere la finestra di dialogo.


 * 7) Flush the surfaces (class levelBeam). Abbina le superfici

Strumento per rendere parallele le facce di due oggetti. In realtà il comando acquisisce e mantiene il livello, rispetta la posizione e l'orientamento della prima faccia selezionata, il centro di massa di tutte le facce selezionate. Quindi trasla gli oggetti fino a che le facce non sono parallele.


 * 8) Mate the Edges (class alignEdge). Accoppia i bordi

Strumento per accoppiare due bordi paralleli. In realtà il comando sposta gli oggetti lungo la distanza minima del loro bordo selezionato rispetto al primo. Quindi trasla l'oggetto fino a che i bordi non sono paralleli ed è un buon modo per posizionare gli oggetti nella posizione desiderata. È anche possibile selezionare due bordi degli stessi oggetti. Con questo metodo è possibile spostare rapidamente un oggetto per passi definiti sulla propria geometria.


 * 9) Rotate + mate the edges (class rotJoin). Ruota + accoppia i bordi

Strumento per traslare e ruotare le travi per accoppiare due bordi. Come sopra ma rende anche i bordi co-lineari.


 * 10) Shift the beam (class shiftBeam). Sposta la trave

Finestra di dialogo per traslare e copiare oggetti.

X, Y e Z caselle di testo per l'immissione diretta della quantità di traslazione in ciascuna direzione.

Multiple textbox is the multiple coefficient of the translation amount.

Steps textbox is the denominator of the translation amount. It's used when the amount of translation is to be covered in some steps.

Get displacement button to take the amount and direction of translation from the distance of selected entities (points, edges, faces) or even from a single edge. In the latter case, a green arrow is displayed to show the direction.

OK per eseguire l'azione e Cancel per chiudere la finestra di dialogo.


 * 11) Stretch the beam (class stretchBeam). Stira la trave

Finestra di dialogo per modificare la lunghezza delle travi.

Nella casella di testo scrivere la nuova lunghezza che verrà applicata alle travi o ai tubi selezionati. Altrimenti, il pulsante Get Length acquisisce la nuova lunghezza dalla geometria selezionata (la lunghezza di una trave o di un bordo o la distanza tra le entità geometriche).

Con il cursore è possibile modificare la lunghezza scritta nella casella di testo da -100% a + 100%.

I pulsanti radio Head e Tail consentono di scegliere il lato della trave che verrà modificato.


 * 12) Extend the beam (class extend). Estendi la trave

Finestra di dialogo per estendere una trave fino a un obiettivo selezionato.

Se le entità sono preselezionate prima di chiamare questo comando, la prima entità viene automaticamente presa come destinazione e l'oggetto ad esso associato viene rimosso dal gruppo di selezione. In ogni caso è possibile cambiare l'oggetto obiettivo con il pulsante Select.


 * 13) Adjust frames' angle (class adjustFrameAngle). Regola l'angolo delle strutture

Strumento per regolare l'angolo tra le travi di strutture. Per capire al meglio come funziona, fare riferimento al tutorial precedente.


 * 14) Insert a path (class insertPath). Inserisci un percorso

Strumento per creare un DWire (polilinea o percorso) continuo sul percorso definito da bordi selezionati nella vista, anche se questi non si toccano o si intersecano o appartengono a oggetti diversi. L'unico vincolo è che esista l'intersezione tra due spigoli successivi, nell'ordine in cui sono stati selezionati. Al DWire vengono anche date le proprietà di visualizzazione di una linea centrale, cioè arancione e tratteggiata.


 * 15) FrameLine manager (class FrameLineManager). Gestore di Frame Line

Come per gli oggetti "pype-line", questa è una finestra di dialogo per creare e modificare le proprietà degli oggetti "frame-line".

Analogamente a quanto visto sopra, le frame-lines sono oggetti che raccolgono le proprietà comuni a un insieme di travi (ovvero sono la sezione delle travi) che sono incluse in un gruppo comune nell'albero del modello. Hanno anche una proprietà opzionale ". Base", per impostazione predefinita impostata su Nessuna, che è la linea centrale delle travi della struttura. Dopo che viene definito un percorso (un DWire o uno Sketch), alias .Base, alla frame-line possono essere aggiunte altre travi ma verranno eliminate quando viene richiamato  'Redraw' . La finestra di dialogo fornisce le seguenti funzioni: Se il nome di un oggetto FrameLine viene modificato, anche il nome del gruppo pertinente cambia automaticamente ma non viceversa
 * un elenco di profili di travi precedentemente inclusi nel modello dalla finestra di dialogo "Inserisci sezioni standard" (leggere più avanti);
 * una casella combinata per selezionare il FrameLine attivo tra quelli già creati o per crearne uno nuovo;
 * una casella di testo in cui scrivere il nome della FrameLine che verrà creata; se non viene inserito nulla o " ", FrameLined sarà denominato come predefinito "Telaio00n";
 * Insert pulsante: crea un nuovo oggetto FrameLine o aggiunge nuovi membri a quello selezionato nella casella combinata se nella vista attiva ci sono bordi selezionati.
 * Redraw pulsante: crea nuove travi e le posiziona sul percorso selezionato. Le nuove travi verranno raccolte all'interno del gruppo di FrameLine. Non crea o aggiorna le travi aggiunte a FrameLine al di fuori del percorso definito.
 * Clear pulsante: cancella tutte le travi nel gruppo FrameLine. Si applica anche alle travi aggiunte a FrameLine al di fuori del suo percorso definito.
 * Get Path pulsante: assegna il Dwire selezionato all'attributo Path dell'oggetto FrameLine.
 * Get Profile pulsante: modifica l'attributo Profilo dell'oggetto FrameLine su quello della trave selezionata nella vista o quella selezionata nell'elenco.
 * Copy profile checkbox: se spuntato genera un nuovo oggetto profilo per ogni trave al fine di evitare riferimenti multipli nel modello.
 * Move to origin checkbox: se selezionato, sposta il centro di massa del profilo all'origine del sistema di coordinate: ciò fa coincidere la linea centrale della trave con il c.o.m. del profilo.


 * 16) Insert Std. Sections (class insertSection). Inserisci sezioni standard

Finestra di dialogo per creare il set di profili da utilizzare nel modello per l'oggetto FrameLine. Possono essere create altre tabelle profili aggiungendo il file .csv pertinente nella cartella / tabelle. Le regole per creare o personalizzare tali tabelle sono simili a quelle per le pipe lines.
 * Section lista: include tutte le sezioni definite nel file .csv corrispondente al tipo di sezione selezionato.
 * Section types elenco: i tipi di profili definiti con i file .csv inclusi nella cartella / tabelle
 * Insert pulsante: crea il gruppo "Profiles_set", se non già esistente, e aggiunge ad esso l'oggetto del profilo selezionato.

Nel modello possono essere disegnati altri profili e poi trascinati all'interno del gruppo "Profili_set".

L'orientamento dei DWire può influenzare il rendering delle travi.

Strumenti Pype



 * 1) Inserisci un tubo

Apre una finestra di dialogo per inserire i tubi.

The top-right combo is a common feature for all "Insert ..." dialogs: it lists the pype-line objects defined in the current document: with this it's possible to select to which pype-line to assign the newly created pipes. You can also leave it to so that the object is created on the root line of the part model. In the top-left corner is printed the currently selected pipe rating, taken from the listbox in the right column. Pipes dimensions for each pipe-rating are defined in .csv files, which is possible to add or modify, with few simple naming rules, according needs. Curves, reductions etc. have the same rules for definition of their tables of dimensions: see files in ../Mod/flamingo/Tables. Read also "tutorialPype.pdf" to know how to customize or create them.

Per definire la posizione e l'orientamento dei tubi, sono possibili le seguenti selezioni: Se non viene specificata alcuna lunghezza, il valore predefinito è 200 unità (solo una lunghezza comoda, in mm).
 * uno o più bordi dritti
 * uno o più bordi curvi
 * uno o più vertici
 * nulla; in questo caso il tubo verrà posizionato all'origine.

Reverse pulsante consente di ruotare di 180° l'ultimo tubo creato o quelli attualmente selezionati.

Apply pulsante consente di applicare una lunghezza diversa o un diametro nominale ai tubi attualmente selezionati.


 * 2) Inserisci una curva

Opens a dialog to insert one elbow.

Beside the common widgets with other "Insert..." dialogs, the Trim/Extend button allow to adjust the length of selected pipes to the selected edge of the curve. To define position and orientation following selections are possible: If no angle is specified the default is 90 degrees.
 * one vertex,
 * one circular edge
 * one pipe at one of its ends; in this case the curve's diameter and thickness will automatically fit those of the selected pipe
 * a pair of edges or pipes or beams, also not contiguous but intersecting; in this case curve's properties will automatically fit to connect the two selected objects; also selected pipes will be automatically trimmed or extended to the curve's edges
 * nothing; in this case the curve will be placed at origin.


 * 3) Insert a reduction

Opens a dialog to insert concentric reductions.

To define position and orientation following selections are possible: two pipes parallel (possibly co-linear) In case one pipe is selected, its properties are applied to the reduction.
 * one pipe at one of its ends
 * one pipe
 * one circular edge
 * one straight edge
 * one vertex
 * nothing (created at origin)

In case two pipes are selected, the tool will try automatically to connect them with the right major and minor diameter.


 * 4) Insert a cap

Opens dialog to insert caps.

To define position and orientation following selections are possible: one or more curved edges (axis and origin across the center) one or more vertexes nothing If a pipe edge is selected the caps' properties will automatically fit to those of the pipe.


 * 5) Insert a valve

Create a "placeholder" of a valve from a .csv table like above. Beside the offset dimension, it's important because it defines also the Kv coefficient that will be used to calculate pressure losses with the relevant tool in "Utils" menu. Note that the symbol of the placeholder changes according the type of the valve, if in its name is found one keyword among "ball", "butterfly" or "globe".


 * 6) Insert a flange

Opens dialog to insert flanges. To define position and orientation following selections are possible: In case one pipe is selected, its properties are applied to the flange.
 * one or more circular edges,
 * one or more vertexes,
 * nothing.


 * 7) Insert a U-bolt

Opens dialog to insert U-bolts.

To define position and orientation following selections are possible: In case one pipe is selected, its properties are aplied to the U-bolt. Moreover it's possible to choose to place the U-bolt at the Head or Tail ends or in the Middle of the pipes by checking the relevant box.
 * one or more circular edges
 * one or more pipes
 * nothing.

With '''Ref. face''' button it's possible to select the face of the support to which to orient the U-bolt axis.


 * 8) PypeLine Manager

Before talking about the dialog it's worth to recall what the pype-line object is in the context of Flamingo workbench.

This object represent a collection of objects "PType" that are updated with the methods defined in the Python class itself. At present time it creates, with the method "obj.Proxy.update(obj,[edges])", pipes and curves over the given edges and collect them in a group named according the object's obj.Label. A standard bending radius "3D" (i.e. 1.5xO.D.) is applied for curves. The Bend Radius is a common property of object pype-line, thus it can be changed and then redrawn. When the Label of the object pype-line is renamed, the name of its group is changed accordingly.

The class PypeLine2 has also the optional attribute ".Base", which namely represent the centerline of the piping:
 * If Base is None, PypeLine2 behaves like a bare container of objects, with possibility to group them automatically, assign one color and extract the part-list.
 * .Base can be a Wire or a Sketch or any object which has edges in its Shape.
 * Running "obj.Proxy.update(obj)", without any [edges], the class attempts to render the pypeline (Pipe and Elbow objects) on the "obj.Base" edges: for well defined geometries this usually leads to the desired result. If [edges] are given, pipes and curves will be drawn along them.
 * Running "obj.Proxy.purge(obj)" deletes from the model all Pipes and Elbows that belongs to the pype-line.
 * Remember that the object created outside the .Base won't be updated when the .Base is changed and the pypeline is redrawn and (except pipe and curves) won't be deleted if the pype-line is purged.

This understood, the command opens the dialog to create or modify one pype-line.

The dialog is very similar to those for insert other objects seen before.

The pipe ratings tables, where the O.D. and thickness are defined, are the same of those for tubes (e.g. Pipe_SCH-STD.csv).

When is in the combo and Insert is pressed, a new pype-line object is created in the document with the relevant group.

It is possible to create one pypeline in three ways, according to the objects selected in the viewport when Insert is pushed: After that it's still possible to add other objects (such as Flange, Reduct...) using the relevant insertion commands described above. When objects are created within a pype-line they are automatically included in the relevant group of the model and the common properties (i.e. O.D., thickness, color, bending radius etc.) are applied.
 * nothing is selected. One pype-line is created with property .Base = None and included in its group with the specified name and color (or default values). The piping objects to populate it can be created one-by-one with the commands seen above or alternatively a centerline can be selected afterwards with Get Profile and Redraw buttons.
 * one DWire object is selected. It is automatically taken as Base and converted in a Path (orange, dash-dotted) and pipes and curves are drawn along it.
 * a set of edges are selected (even not contiguous but anyway having intersections extending their ends). One Path is created connecting all the edges (see the Path tool in the Frame toolbar) and assigned as .Base to the newly created pype-line. Then pipes and curves are drawn on it as above.

If at least one pype-line is already in the model, that can be selected from the combo-box: in this case, pushing Insert creates the pipes and curves like described above but, instead of creating a new pype-line object, it adds them to the selected existing pype-line. Beware that the piping created in this way will be deleted at next Redraw.

Get Path, Get Profile and Color allow to change the .Base property, the nominal size and color of the object respectively.

Redraw re-create tubes and curves along the .Base (if defined) after any modification to the path or the properties of the pype-line.

Part list generates a .csv file with the bill of material of the piping object included in the pype-line selected in the combo.


 * 9) Insert a PypeBranch

This pype object behave like a PypeLine except it automatically updates whenever the Base (a DWire or a SketchObject) is modified: that includes changing the placement, stretching, moving, adding or deleting edges. It is mainly intended to represent the secondary branches of the PypeLine (see the dedicated tutorial) but it can also act as a stand-alone object. This is an important task that allow to change quickly the layout of pipes but, as a drawback, its geometry is more rigidly defined. In other words, pipes can not be splitted or resized independently because they will be eventually redrawn on the Base. Changin the OD, thk or BendRadius of the PypeBranch, instead, will apply on all tubes and curves of it.


 * 10) Break the pipe

Opens a dialog to break one pipe at a defined point, optionally making a gap between the ends of the two parts. Multiple selection is possible.

Insert in the Point text-box the length where the pipe or pipes are going to break: this can be an absolute value or just a percentage of the length (a numeral followed by %). In some case it's quicker to use the slide-bar at the bottom to change this value.

The Length button allow to measure the length of the selected pipe and use that as the reference of the slide-bar scale.

If it's needed just to break pipes in two, leave the Gap text-box to 0; otherwise define the length of the gap. If a reference length is choosen, also the gap can be defined as a percentage. As seen in the tutorial, it's possible to measure the gap from geometries in the model with the Get gap button: that's the distance between any geometric entity or even the length of a single edge.

Pushing on Break performs the action.

The Pypeline combo, as usual, allow to choose the group to which to assign the new objects created.


 * 11) Mate pipes edges.

When two circular edges belonging to different objects are selected, pressing this button will make the second object move to make the edges concentric and coplanar.

This works not only with pipes.


 * 12) Join the pypes

Joins the Ports of different objects in a graphical way. It works only among pype-objects, also from different workbenches, where the Ports[] property is defined congruently.


 * 13) Fit one elbow

Select 2 intersecting pipes + 1 elbow: executing this command, they will be joined. It works only among pype-objects, also from different workbenches.


 * 14) Extend pipes to intersection

By selecting two pipes, this command extend them both to their intersection point, if exists.


 * 15) Extend pipe to intersection

By selecting two pipes, this command extend the first to the intersection with the other, if exists.


 * 16) Lay-down the pipes

By selecting one face and multiple pipes, this command translates the pipe along the normal of the face in order to make them lie on its plane.


 * 17) Raise-up the support

Similar to the tool above but in this case is the support that is raised or lowered, so that the face is tangent to the pipe.
 * 18) Attach to tube

Attaches a pype object (2, 3, 4, 5 or 6) rigidly to the nearest end of a pipe (1). To detach, click on the button while the attached object is selected alone.
 * 19) Create pipes point-to-point

Opens a dialog similar to "Draw a DWire" together with the dialog of "Insert a pipe": this allows to draw a sequence of pipes, connected by curves, just selecting one point after the other. It is also allowed to change properties of the pipe and/or the pype-line on the fly.
 * 20) Insert Any Shape

This is a tool to create a "pype" object from a .STEP or .IGES or .BREP file. It loads the imported file into the Shape property of a FeaturePython.

Utilities



 * 1) Make a polygon

The first two tools of utils are part of a separate project which aims to create an automatic scanner of rooms with a stepper motor and an ultrasonic distance meter. This tool creates one regular polygon inside a sketch.


 * 2) Polygon from file

Tool to create any polygon inside a sketch taking vertexes from a .csv file, where they are stored in polar coordinates.
 * 3) Query the model

Tool to get various informations according to the object or objects selected. Beside length or distances, it is specifically suited to give informations related to beams and pipes (length, section, angle-between).


 * 4) Align workplane

Tool to set the position and rotation of working plane according to the selected existing geometry.

The normal of WP is defined scanning the elements in the following order:
 * 1) the normal of a face
 * 2) the normal of the plane of a curve
 * 3) the normal of the plane containing two segments

The origin of WP is defined (in order) by
 * 1) one vertex
 * 2) the center of curvature of a line
 * 3) the intersection of two lines
 * 4) the center of an edge


 * 5) Offset workplane

Shifts the WP along its normal vector. To show the direction of offset, a temporary green arrow is displayed on the screen. Clearly also negative values are allowed.


 * 6) Rotate workplane

Rotates the WP around one of its axis. Also in this case a green arrow is displayed in the viewport to identify the present orientation of the WP: the arrow is pointed in the Z direction and the long base of the arrow is layed over the X direction.


 * 7) Draw a DWire

This tool works exactly like the corresponding tool of Draft workbench but with few additional options at the end of the dialog. As default, the origin of WP is redefined at each point added because this makes simpler to draw segments of known length and orientation using the snap-to-grid option. Then two push-buttons, invoked also with the short-key Ctrl+Shift+, allow to rotate and offset the WP as seen above without breaking the DWire object. The last three buttons allow to quickly change the rotation of WP to be parallel to the principal planes.


 * 8) Quick move objects

To move quickly any part, to access the underlying objects for instance, this tool provides a graphic handle (green arrow) by clicking on which it's possible to displace and rotate the selected objects.


 * 9) Pressure loss calculator

Opens one dialog to calculate the pressure losses across the pype-parts selected in the viewport or across one PypeBranch. The friction coefficient is calculated for each straight tube and elbow. For other objects the concentrated pressure loss is calculated through the flow factor, provided that the attribute Kv is available and set to a positive value.

Links

 * FreeCAD Forum: (Announcement thread)
 * Tutorials: https://github.com/oddtopus/flamingo/tree/master/tutorials
 * Videos:
 * Simple video tutorial for frame creation with pipes
 * How to lay down pipe lines


 * Files:
 * Reporting bugs: please report bugs to the Flamingo GH issue queue

Other useful links

 * DevWorkbenches: List of workbenches in development.
 * Macros recipes
 * OSE-Piping-Workbench: to create extra pipe fittings