Macro Wiring And Hoses/pl

'Od User:Piffpoof Uwaga: pewne zmiany pomiędzy v 0.14 a v 0.15 wpłynęły na to makro, co opóźni jego wydanie

Makra te wspierają tworzenie i obsługę sieci przewodów i rur.



Kontekst
Jako część naszych innych projektów FreeCAD potrzebowaliśmy sposobu na udokumentowanie okablowania i rur. Ten zestaw makr został stworzony aby sprostać tej potrzebie. Jest wiele rzeczy, których ten system nie robi, ale to co robi, to zapewnia wizualną reprezentację przewodów i rur, albo jako odizolowany system, albo z przewodami i rurami w kontekście modelu FreeCAD. Zapis wszystkich przewodów i rur jest przechowywany w pliku w formacie CSV poza programem FreeCAD. Plik ten może więc zostać wczytany do programu arkusza kalkulacyjnego lub wykorzystany przez inne oprogramowanie.

Opis
W ramach projektu dokumentacji odkryliśmy, że potrzebujemy udokumentować przewody i rury. Wypróbowaliśmy kilka różnych scenariuszy takich jak tworzenie linii lub cylindrów jako część istniejącego modelu. Ze względu na problemy z ich używaniem lub utrzymaniem zdecydowaliśmy się zachować te informacje w innym formacie i poza programem FreeCAD. W ten sposób mogły być one tworzone samodzielnie lub w ramach istniejącego dokumentu. Ta decyzja pozwoliła użytkownikowi pracować z okablowaniem i rurami w sposób, który mu odpowiadał. Mógł również pracować z nimi na różne sposoby w różnych momentach, gdy zmieniały się potrzeby.

Początkowo nie byliśmy pewni, jak prowadzić listę rur i przewodów i próbowaliśmy różnych podejść. Najprostszym sposobem wydawało się użycie formatu pliku CSV, który istnieje od dawna. Istniały już także procedury napisane do zarządzania plikami CSV z poziomu Pythona. Niektóre z zalet były następujące:


 * czytelny dla człowieka
 * może być załadowany do dowolnego arkusza kalkulacyjnego
 * może być utrzymywany przy użyciu arkusza kalkulacyjnego lub prostego edytora tekstu
 * możliwym przyszłym ulepszeniem byłoby użycie go z arkuszem kalkulacyjnym FreeCAD

Kolejnymi decyzjami było "jak" zdefiniować takie przebiegi kabli. Ponieważ naszym celem była przede wszystkim dokumentacja, wybraliśmy prowadzenie odcinków linii od punktu do punktu. Kwestie takie jak promień skrętu nie są rozpatrywane. Również średnica kabla nie jest obsługiwana. Tabela z przebiegami kabli jest przechowywana w pliku CSV, ale takie rzeczy jak bliskość kabli (dla kwestii zakłóceń elektrycznych) i długość trasy nie są obsługiwane (chociaż można by było dość łatwo dodać podstawową długość trasy kabla).

Ten zestaw makr jest w zasadzie "dowodem koncepcji", demonstruje pewne pomysły i ich wykonalność. Naszym głównym celem była dokumentacja, a nie fizyczne zarządzanie instalacją. Zdecydowaliśmy się na utrzymanie struktury danych punktów, które są punktami, przez które przebiegają przewody i rury. Po drugie utworzyliśmy strukturę danych, która definiuje kable i rury pod względem punktów, przez które przechodzą. Tak więc przewód może być poprowadzony tylko tam, gdzie zostały zdefiniowane dla niego punkty.

Dla tych dwóch struktur danych wybraliśmy następujące nazwy:
 * Nexus - punkt, przez który może przechodzić kabel lub rura (liczba mnoga to Nexi). Nexi są po prostu punktami w trójprzestrzeni, dla ułatwienia wizualizacji oprogramowanie umieszcza pierścienie toroidalne wokół lokalizacji, ale jest to tylko dla ułatwienia użycia. Pierścienie toroidalne mogą być wyłączone lub włączone w zależności od preferencji użytkownika.
 * Przepływy - ogólnie są to trasy składające się z Nexi. Do każdego typu przypisany jest kod, domyślne kody to
 * W - przewody elektryczne
 * C - przewody, przeznaczone głównie dla kabli, ale mogące zawierać wszystko
 * H - rury do przenoszenia różnych płynów
 * G - przewody gazowe
 * K - trasa kamery, to jest tak naprawdę zarezerwowane dla przyszłych eksploracji, jak w Zwiedzanie ujęciem widoku.

Zarówno Nexi jak i Przepływ mają nazwy przypisane przez użytkownika, dodatkowo Nexi mają wewnętrznie przypisane ID w celu ułatwienia zarządzania. Będąc punktami lub lokalizacjami w przestrzeni Nexi nie mają kolorów, ale Przepływy mogą mieć jeden z 48 zdefiniowanych kolorów. Nacisk na kolory wiąże się z zamierzonym celem, jakim jest dokumentacja.

Ogólny przebieg pracy jest następujący
 * zdefiniuj i ustaw Nexi
 * zdefiniuj Przepływ(y) w odniesieniu do Nexi
 * dla celów konserwacyjnych edytuj zarówno Nexi, jak i Przepływy albo wizualnie za pomocą GUI FreeCAD, albo używając podejścia tabelarycznego i definicji CSV.

Ponieważ plik danych zawierający definicje Nexi i Przepływu jest plikiem tekstowym, może być obsługiwany w dowolnym edytorze tekstu lub przez dowolny inny program, który chce uzyskać dostęp do danych.

Tryby nawigacyjne
Ponieważ duża część pracy z tymi makrami polega na manipulowaniu wyświetlanym modelem w celu umieszczenia i weryfikacji umieszczenia punktu w przestrzeni trójwymiarowej, niezbędna jest znajomość trybów nawigacyjnych programu FreeCAD, które są udokumentowane na stronie Profil nawigacji myszką. Umiejętność obracania modelu w przestrzeni trójwymiarowej, a następnie wykonywania operacji na nieruchomym modelu jest niezbędna.

Instalacja
Kod dla Okablowania i rurociągów znajduje się w wielu makrach i bibliotece. Instalacja polega więc na skopiowaniu kodu do odpowiedniego katalogu makr i wywołaniu narzędzia Build Utility z menu makr, konsoli Pythona lub przycisku na pasku narzędzi (preferowana metoda).


 * zobacz stronę Jak zainstalować makrodefinicję, aby uzyskać informacje, jak zainstalować ten kod makra
 * zobacz stronę Dostosowanie pasków narzędzi, aby uzyskać informacje, jak zainstalować jako przycisk na pasku narzędzi.

Użycie
Istnieją naprawdę dwa różne podejścia do pracy z tymi makrodefinicjami: Nexi i Przepływy mogą być zdefiniowane samodzielnie przy użyciu współrzędnych przestrzennych, lub można użyć istniejącego dokumentu FreeCAD i zdefiniować Nexi i Przepływy w kontekście tego dokumentu. Nie jest to decyzja typu "albo / albo", ale raczej oba podejścia mogą być stosowane, gdy są najbardziej odpowiednie. Ponieważ definicje Nexi i Przepływów są przechowywane w pliku w formacie CSV, który jest przechowywany poza programem FreeCAD, obecność lub brak dokumentu FreeCAD nie ma wpływu na pracę z Nexi i Przepływami, ale ułatwia ją poprzez zapewnienie kontekstu wizualnego. Dla tego opisu użycia w przykładzie zostanie użyty wcześniej załadowany dokument FreeCAD jako kontekst, ponieważ łatwiej jest umieścić

Użycie tych makrodefinicji dzieli się na 3 części:
 * zdefiniuj Nexi
 * zdefiniuj Przepływy
 * edycja pliku w formacie CSV w celu zmiany lub dodania Nexi i Przepływów

Istnieją alternatywne sposoby wykonania niektórych z przedstawionych poniżej zadań, o których mogą decydować osobiste preferencje. Ten przykład dotyczy instalacji elektrycznej i zimnej wody w domu. Tak wygląda nasz pusty dom



i czeka na zainstalowanie zimnej wody i prądu. Dla wygody wyjaśnienia wszystkie elementy elektryczne są w kolorze żółtym, a woda w kolorze niebieskim (oprócz 2 zlewów).

Określenie Nexi
Pierwszym krokiem jest utworzenie punktów w przestrzeni trójwymiarowej (zwanych "Nexi" lub "nexus" w liczbie mnogiej). Punkty te zostaną użyte w następnym kroku do zdefiniowania przepływu. Punkty te tworzymy klikając na (tj. wybierając) powierzchnię, a następnie podając nazwę dla Nexi. Ten opis dotyczy definiowania punktów Nexi dla przepływu wody.

. To jest pytanie, czy chcesz otworzyć i załadować dokument FreeCAD, który zawiera model, do którego chcesz dodać Nexi i przepływy. Nie jest konieczne wczytywanie żadnego, ale dla tego przykładu wczytamy nasz pusty dom.
 * 1) kliknij na ikonę 
 * 2) pojawi się następujące okno dialogowe:

 
 * 1) select a surface by clicking on it, it will be highlighted in the Tree window and have a colour indicating selected in the display.
 * 2) click on 
 * 3) the following dialog will appear asking for a name for the new nexi:
 * 1) the nexi will now be defined. It will be positioned in 3-space so that it is on the line from the selected face to the viewer, positioned just off the face so that it is not inside the object. Although the nexus might not be in the perfect position, leave it for the moment as it will be edited in a later step. A toroid (i.e. ring) will be displayed, it is centred on the point of the nexus. This ring is purely a visualisation tool so the location of the point can be  identified. The visualisation rings can be toggled on/off at any time.
 * 2) define any more nexi in the same fashion, giving each a meaningful name
 * 3) click on 
 * 4) the following dialog will appear:
 * 1) answer Yes to save your new nexi

Note : at any point you can merge an existing project so as to have a visual context

Define Flow
Once nexi have been defined they can be used to define a flow. Our house now looks like this:

< picture of house with nexi but not flows>

It has nexi defined for the water flow but now flows as of yet.

pojawi się następujące okno dialogowe:
 * 1) kliknij na ikonę .



To jest prośba o wybranie Nexi w kolejności, w jakiej mają one tworzyć przepływ.
 * 1) wybierz typ przepływu: Przewody, Kanalazacja, Rury, Linie gazowe
 * 2) używając drugiego okna, wybierz Nexi w kolejności, w jakiej chcesz je utworzyć




 * 1) podaj nazwę dla przepływu
 * 2) wybierz kolor dla przepływu
 * 3) kliknij przycisk lub . Jeśli popełnisz błąd w wyborze Nexi (albo w kolejności, albo włączając niewłaściwe Nexi), kliknij przycisk  i rozpocznij ten krok ponownie.

< picture of house with water flow>



Editing Nexi and Flows
There are 3 different ways to edit nexi. As the flows are defined in terms of nexi, altering nexi will affect any flow which includes them. For the descriptive flow attributes like colour and name, there is one way to make edits.

So far in this example we have generated the following table:







Interfejs użytkownika
Interfejs użytkownika jest kombinacją własnych ekranów oraz standardowych części GUI programu FreeCAD.







Opcje
W chwili obecnej nie ma żadnych opcji dotyczących przewodów i rur.