Scripts/pl

Wprowadzenie
Przez tworzenie skryptów rozumiemy tworzenie obiektów topologicznych za pomocą interpretera Python dla FreeCAD. Program FreeCAD może być używany jako "bardzo dobry" zamiennik OpenSCAD, głównie dlatego, że ma prawdziwy interpreter środowiska Python, co oznacza, że ma na pokładzie prawdziwy język programowania, prawie wszystko, co można zrobić z GUI, można zrobić za pomocą skryptu Python.

Niestety informacje na temat skryptów w dokumentacji, a nawet na tej Wiki, są rozproszone i brakuje im jednolitości "pisania”, a większość z nich jest wyjaśniona w zbyt techniczny sposób.



Zaostrzenie apetytu
Pierwszą przeszkodą w łatwej drodze do tworzenia skryptów jest to, że nie ma bezpośredniego sposobu na dostęp do wewnętrznego edytora Python FreeCAD poprzez pozycję menu lub ikonę na pasku narzędzi, ale wiedząc, że FreeCAD otwiera plik z rozszerzeniem w wewnętrznym edytorze Python, najprostszą sztuczką jest utworzenie go w ulubionym edytorze tekstu, a następnie otwarcie go za pomocą zwykłego polecenia.

Aby zrobić to w uprzejmy sposób, plik musi być napisany w pewnym porządku, edytor FreeCAD Python ma dobre podświetlanie składni, którego brakuje w wielu prostych edytorach, takich jak Notatnik Windows lub niektóre podstawowe edytory Linuksa, więc wystarczy napisać te kilka linijek:

Zapisz je ze znaczącą nazwą z rozszerzeniem i załaduj wynikowy plik w FreeCAD, za pomocą wspomnianego polecenia.

Minimalny przykład tego, co jest niezbędne w skrypcie, jest pokazany w tym fragmencie kodu, który można wykorzystać jako szablon dla prawie każdego przyszłego skryptu:

Powyższy kod zawiera kilka sztuczek:


 * Ta linia importuje FreeCAD w interpreterze FreeCAD Python, może wydawać się zbędna, ale tak nie jest.
 * Base i Vector są szeroko stosowane w skryptach FreeCAD, importowanie ich w ten sposób pozwoli zaoszczędzić na wywoływaniu ich za pomocą lub  zamiast  lub, zaoszczędzi to wiele naciśnięć klawiszy i sprawi, że linie kodu będą znacznie krótsze.

Zacznijmy od małego skryptu, który wykonuje bardzo małą pracę, ale pokazuje moc tej metody.

Umieść te linie po kodzie "szablonu" i naciśnij zieloną strzałkę na pasku narzędzi "Makrodefinicje".

Zobaczysz kilka magicznych rzeczy, otworzy się nowy dokument o nazwie "Pippo" (włoska nazwa Goofy), a w widoku 3D zobaczysz Sześcian, taki jak na poniższym obrazku.





Coś więcej ...
Nie jest to zbyt niesamowite? Tak, ale musimy od czegoś zacząć, możemy zrobić to samo z walcem, dodając te linie kodu po metodzie i przed linią:.

Nawet tutaj nie ma nic zbyt ekscytującego. Warto jednak zwrócić uwagę na kilka osobliwości:


 * Brak zwykłego odniesienia do, obecnego w wielu fragmentach kodu Dokumentacji, jest zamierzony, kod ten może być użyty nawet do wywołania FreeCAD jako modułu w zewnętrznym interpreterze Pythona, nie jest to łatwe do zrobienia z AppImage, ale z pewną ostrożnością można to zrobić. Plus w standardowym motto Pythona, że "lepiej jawnie niż niejawnie" wyjaśnia w bardzo "kiepski" sposób, skąd pochodzą rzeczy.
 * Zwróć uwagę na użycie "stałej" nazwy przypisanej do aktywnego Dokumentu w = ; activeDocument nie jest "stałą" w ścisłym sensie, ale w sposób "semantyczny" jest naszym "aktywnym dokumentem", który dla naszego użytku jest właściwą "stałą", więc konwencja Pythona polega na używaniu nazwy "ALL CAPS" dla "stałych", nie wspominając o tym, że  jest znacznie krótszy niż.
 * Każda metoda zwraca geometrię, będzie to jasne w dalszej części strony.
 * Geometria nie miała właściwości, podczas używania prostych geometrii do tworzenia bardziej złożonych geometrii, zarządzanie jest kłopotliwe.

Co teraz zrobić z tą geometrią?

Wprowadźmy operacje logiczne. Jako przykład początkowy umieść te linie po, to utworzy metodę dla operacji Fusion znanej również jako Union:

Tutaj również nie ma nic wyjątkowego, należy jednak zwrócić uwagę na jednolitość kodowania metod; to podejście jest bardziej liniowe niż te spotykane w innych samouczkach dotyczących skryptów, ta "liniowość" znacznie pomaga w czytelności, a także w operacjach wycinania, kopiowania i wklejania.

Użyjmy geometrii, usuńmy linie poniżej sekcji kodu zaczynającej się od i wstawmy następujące linie:

Uruchom skrypt za pomocą zielonej strzałki, a w widoku 3D zobaczymy coś takiego:



Umiejscowienie
Koncepcja umiejscowienia jest stosunkowo złożona, zobacz poradnik samolotu, aby uzyskać bardziej dogłębne wyjaśnienie.

Zazwyczaj potrzebujemy umieścić geometrie względem siebie, podczas budowania złożonych obiektów jest to powtarzające się zadanie, najczęstszym sposobem jest użycie właściwości geometrii.

FreeCAD oferuje szeroki wybór sposobów ustawiania tej właściwości, jeden jest bardziej dostosowany do drugiego w zależności od wiedzy i doświadczenia użytkownika, ale bardziej proste pisanie jest wyjaśnione w cytowanym samouczku, używa osobliwej definicji części, dość łatwej do nauczenia.

Ale ponad innymi rozważaniami, jedna rzecz jest kluczowa, geometria punkt odniesienia. Innymi słowy punkt, z którego obiekt jest modelowany przez FreeCAD, jak opisano w tej tabeli, skopiowanej z umiejscowienia:

Informacje te należy mieć na uwadze, zwłaszcza gdy musimy zastosować rotację.

Some examples may help, delete all the line after method and insert the portion of code below:

Let's explain something in the code:


 * We have used a method to define a sphere, using the most easy definition, using only the radius.
 * We have introduced a second writing for the Union or Fusion, using multiple objects, not more distant from the usual Part::Fuse it uses Part:Multifuse. We only use one property . We have passed a tuple as arguments, but it accepts also a list.
 * We have defined a complex object aeroplano (italian word for aeroplane), but we have done it in a "parametric" way, defining some parameters and deriving other parameters, through some calculation, based on the main parameters.
 * We have used some Placement poperties around in the method and before returning the final geometries we have used a  property with the Yaw-Pitch-Roll writing. Note the last, that define a center of rotation of the whole geometry.

It can be easily noted that aeroplano geometry rotate around his "barycenter" or "center of gravity", that I've fixed at wing center, a place that is relatively "natural", but could be placed wherever you want.

The first  is the Translation vector, not used here, but if you substitute  with these lines:

You will see in the Report window this text:

What has happened?

FreeCAD has translated the in other word our  definition that specifies three components, Translation, Rotation and center of rotation in the "internal" values of only two components, Translation and Rotation'.

you can easily visualize the value of using a print statement in the  method and see that it is:

in other word the rotation center of the geometry is at, but this rotation center is not shown in the GUI, it could be entered as a value, it could not be easily retrieved.

This is the meaning of the word "awkward" that I've used to define property.