Język skryptowy Foremki: dokumentacja

Skrypt buduje model tak samo, jak robi to interfejs: każda funkcja odpowiada jednej operacji z historii. Uruchomiony na pustym dokumencie odtwarza model od zera, uruchomiony na istniejącym dopisuje operacje na końcu historii.

Podstawy

# komentarz do końca linii

grubosc = 12          # zmienna
param("bok", 40)      # parametr dokumentu, widoczny w panelu parametrów

b = box([80, 20, 40])          # wywołanie z argumentem pozycyjnym
fillet(edges(b), radius: 3)    # argument nazwany po dwukropku

Liczby wolno pisać z jednostką: 12mm, 2.5cm, 1in, 30deg, 1.57rad. Bez jednostki długość znaczy milimetry, a kąt stopnie. Wewnątrz skryptu wszystko jest już przeliczone na milimetry i stopnie.

Punkt w szkicu zapisuje się jako [x, y], punkt i wektor w przestrzeni jako [x, y, z]. Wektory dodaje się i mnoży przez liczbę: [10, 0, 0] * 2.

Układ świata

Pionem jest oś Y, a nie Z. Stała up to [0, 1, 0], down to [0, -1, 0], a osie mają nazwy x_axis, y_axis, z_axis. Płaszczyzny bazowe to plane.xy (leży poziomo, normalna w górę), plane.yz i plane.xz (obie pionowe). Szkic na plane.xy wyciąga się więc do góry, a box([80, 20, 40]) ma 20 milimetrów wysokości.

Sterowanie

if grubosc > 10 {
  print("gruby")
} else {
  print("cienki")
}

for i in range(0, 5) {
  hole(face(b, "top"), at: [10 + i * 15, 20], diameter: 5)
}

def wysokosc_zebra(dlugosc) {
  return dlugosc / 3
}

Dostępne operatory: + - * / % ^, porównania < > <= >= == != oraz and, or, not.

Trzy rzeczy, które warto wiedzieć

1. Bryły są wynikiem operacji. b = extrude(sk, 10) daje bryłę, a b = fillet(edges(b), 2) zastępuje ją zaokrągloną. Stara zmienna też zadziała: odwołania nadążają za aktualną postacią bryły.

2. Geometrię wybiera się opisem, nie numerem. Zamiast pamiętać, że chodzi o krawędź numer siedem, pisze się edges(b, dir: up) albo faces(b, kind: "cylinder", diameter: 6). Taki zapis przeżywa zmianę wymiarów, numer nie przeżywa.

3. Szkic ma własny układ współrzędnych. [0, 0] to jego początek, także gdy leży on na ścianie bryły. Wyciągnięcie idzie prostopadle do szkicu.

Przykład

grubosc = param("grubosc", 12)

plyta = sketch(plane.xy) {
  rect(center: [0, 0], width: 120, height: 80)
}
b = extrude(plyta, grubosc)
b = fillet(edges(b, dir: up), 8)
b = shell(b, 2, openings: faces(b, side: "top"))

for i in range(0, 4) {
  b = hole(face(b, "bottom"), at: [-45 + i * 30, 0], diameter: 5, depth: 6)
}
name(b, "Podstawa")

Funkcje

Parametry

param

Zapisuje parametr dokumentu i zwraca jego wartość. Wymiary zbudowane z tej wartości, także przeliczonej (w / 2 + 3), wiążą się z parametrem i przeliczają po jego zmianie w panelu parametrów: rozmiary i położenia prymitywów, odległości wyciągnięć, kąty obrotów, promienie zaokrągleń, grubości, wzory, wymiary szkicu oraz punkty linii, prostokątów, okręgów i łamanych.

Zwraca: liczba: wyliczona wartość parametru.

grubosc = param("grubosc", 12)
kat = param("pochylenie", 3, unit: "deg")
bok = param("bok", "grubosc * 4")

Szkic

arc

Łuk przez trzy punkty: początek, koniec i punkt leżący na łuku.

Zwraca: encja szkicu.

arc([0, 0], [20, 0], [10, 6])

arc_center

Łuk o zadanym środku, od punktu początkowego do końcowego, przeciwnie do ruchu wskazówek zegara.

Zwraca: encja szkicu.

center

Środek okręgu albo łuku.

Działa tylko wewnątrz bloku szkicu.

Zwraca: punkt szkicu.

chamfer_2d

Ścina narożnik między dwiema liniami szkicu.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

circle

Okrąg o zadanym środku. Rozmiar podaje się promieniem albo średnicą.

Zwraca: encja szkicu.

circle([0, 0], diameter: 20)
circle([10, 10], 5)

circle_2pt

Okrąg przez dwa punkty leżące na końcach średnicy.

Zwraca: encja szkicu.

circle_3pt

Okrąg przechodzący przez trzy punkty.

Zwraca: encja szkicu.

construction

Przełącza rysowanie na geometrię konstrukcyjną i z powrotem. Działa do końca bloku szkicu.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

construction(true)
line([0,0], [50,0])
construction(false)

end

Punkt końcowy linii, łuku albo krzywej.

Działa tylko wewnątrz bloku szkicu.

Zwraca: punkt szkicu.

fillet_2d

Zaokrągla narożnik między dwiema encjami szkicu.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

intersect_curves

Wstawia krzywe i punkty powstałe z przecięcia wskazanej geometrii z płaszczyzną szkicu.

Działa tylko wewnątrz bloku szkicu.

Zwraca: lista encji.

intersect_curves(b)
intersect_curves(faces(b, kind: "cylinder"))

Ściana i bryła dają krzywe przekroju, krawędź i oś punkt przebicia, płaszczyzna linię wspólną. Geometria, która płaszczyzny szkicu nie dotyka, jest błędem, bo cichy brak wyniku ukryłby pomyłkę w skrypcie.

line

Odcinek między dwoma punktami szkicu.

Zwraca: encja szkicu.

a = line([0, 0], [80, 0])

mirror_curves

Odbija wskazane encje względem linii szkicu i wiąże kopie symetrią.

Działa tylko wewnątrz bloku szkicu.

Zwraca: liczba: ile encji odbito.

offset_curves

Odsuwa wskazane krzywe o zadaną odległość, tworząc równoległy kontur.

Działa tylko wewnątrz bloku szkicu.

Zwraca: lista encji.

offset_curves(kontur, 3)

pattern_rect

Wzór siatkowy w szkicu: kopie encji w rzędach i kolumnach.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

pattern_rect(otwor, cols: 4, rows: 2, dx: 20, dy: 15)

pattern_ring

Wzór kołowy w szkicu: kopie encji rozłożone wokół punktu.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

pattern_ring(otwor, [0, 0], count: 6)

point

Samodzielny punkt szkicu. Nie tworzy obszaru, służy jako odniesienie dla wiązań i wzorów.

Zwraca: encja szkicu.

polygon

Wielokąt foremny wpisany w okrąg albo opisany na nim.

Zwraca: lista encji.

polygon([0, 0], sides: 6, diameter: 20)

polyline

Łamana przez kolejne punkty. Z opcją domknięcia daje zamknięty kontur.

Zwraca: lista encji.

polyline([[0,0], [40,0], [40,20], [0,20]], closed: true)

project

Rzutuje geometrię na płaszczyznę szkicu wzdłuż jej normalnej. Rzut jest powiązany ze źródłem.

Działa tylko wewnątrz bloku szkicu.

Zwraca: lista encji.

project(faces(b, side: "top"))
project(edges(b, dir: up))
project(sk1)

Rzut spłaszcza źródło wzdłuż normalnej szkicu, więc powstaje zawsze. Gdy potrzebny jest ślad geometrii dokładnie na płaszczyźnie, użyj intersect_curves.

rect

Prostokąt. Podaje się dwa przeciwległe narożniki albo środek z szerokością i wysokością.

Zwraca: lista czterech encji.

rect([0, 0], [80, 40])
rect(center: [0, 0], width: 80, height: 40)

rect_3pt

Prostokąt obrócony: dwa punkty wyznaczają bok, trzeci wysokość.

Zwraca: lista czterech encji.

sketch

Tworzy szkic na płaszczyźnie i wypełnia go geometrią z bloku albo z listy encji.

Zwraca: szkic.

sk = sketch(plane.xy) {
  rect([0, 0], [80, 40])
  circle([40, 20], diameter: 10)
}
sk = sketch(face(b, "top"), [circle([0, 0], diameter: 6)])

Wiązania działają tylko w formie z blokiem, bo tylko tam encje mają nazwy.

spline

Krzywa swobodna przechodząca przez podane punkty.

Zwraca: encja szkicu.

spline([[0,0], [20,15], [40,0]], closed: false)

start

Punkt początkowy linii, łuku albo krzywej.

Działa tylko wewnątrz bloku szkicu.

Zwraca: punkt szkicu.

text

Napis z fontu: w punkcie, w ramce z dwóch narożników albo wzdłuż krzywej szkicu. Litery są zamkniętymi konturami, więc napis się wyciąga i wycina jak każdy profil.

Zwraca: encja szkicu.

text("FOREMKA", at: [0, 0], height: 8, font: "Roboto", bold: true)
text("Pokrywa\nrev. 2", [-30, -10], [30, 10], font: "Liberation Serif")
c = circle([0, 0], 20)
text("NA OKRĘGU", path: c, height: 4)

Napis w ramce i na krzywej da się potem edytować w szkicu dwuklikiem, tak jak napis z narzędzia Tekst. Obszary liter wyciąga extrude(sk, ...); w szkicu z prostokątem wokół napisu litery są dziurami w płytce.

trim

Usuwa kawałek krzywej wskazany punktem, tnąc ją w miejscach przecięcia z innymi krzywymi.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

Wiązania

angle

Wymiar kąta między dwiema liniami.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

circle_line_distance

Wymiar odległości obwodu okręgu od prostej. Wymiar do środka daje point_line_distance.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

coincident

Skleja dwa punkty szkicu w jeden. To najsilniejsze wiązanie: punkty przestają istnieć osobno.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

coincident(end(a), start(b))

diameter

Wymiar średnicy okręgu.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

distance

Wymiar odległości między dwoma punktami. Wpisana wartość steruje geometrią.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

distance(start(a), end(a), 80)

equal

Wymusza równą długość dwóch linii albo równy promień dwóch okręgów.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

equal(a, b)

h_distance

Wymiar odległości poziomej między dwoma punktami.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

horizontal

Wymusza poziome ułożenie linii albo poziomą prostą przez dwa punkty. Poziom liczy się w układzie szkicu.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

horizontal(a)
horizontal(center(c1), center(c2))

midpoint

Wymusza, żeby punkt leżał w połowie odległości między dwoma innymi.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

parallel

Wymusza równoległość dwóch linii.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

parallel(a, b)

perpendicular

Wymusza prostopadłość dwóch linii.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

perpendicular(a, b)

point_line_distance

Wymiar odległości punktu od prostej.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

point_on

Wymusza, żeby punkt leżał na linii albo na okręgu.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

radius

Wymiar promienia okręgu albo łuku.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

symmetric

Wymusza symetrię dwóch punktów względem linii.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

tangent

Wymusza styczność linii do okręgu albo dwóch okręgów do siebie.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

tangent(l, c)

v_distance

Wymiar odległości pionowej między dwoma punktami.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

vertical

Wymusza pionowe ułożenie linii albo pionową prostą przez dwa punkty.

Działa tylko wewnątrz bloku szkicu.

Zwraca: nic.

Wybór

axis

Oś podana punktem i kierunkiem. Do obrotu i wzoru kołowego.

Zwraca: oś.

revolve(sk, axis([0,0,0], up), 360)

axis_of

Oś wyprowadzona z geometrii: z krawędzi prostej jej kierunek, z okrągłej albo ze ściany walcowej oś obrotu.

Zwraca: oś.

pattern_circular(b, axis_of(face(b, kind: "cylinder")), count: 6)

bodies

Lista wszystkich widocznych brył dokumentu.

Zwraca: lista brył.

for b in bodies() { print(b.name) }

body

Bryła po nazwie z drzewa. Bez argumentu daje ostatnio utworzoną.

Zwraca: bryła.

b = body("Bryła 1")

edges

Krawędzie bryły spełniające wszystkie podane warunki. Bez warunków daje wszystkie krawędzie.

Zwraca: zbiór krawędzi.

fillet(edges(b, dir: up), radius: 3)
chamfer(edges(b, kind: "circle", diameter: 6), 0.5)
edges(b, where: def(e) { return e.length > 20 and e.mid.z > 0 })

Krawędzie styczne, szwy i zdegenerowane są pomijane, tak jak przy zaznaczaniu myszą.

face

Jedna ściana. Skrót na faces(...) z wymogiem, żeby wynik był dokładnie jeden; przy większej liczbie skrypt się zatrzymuje, zamiast po cichu wybrać pierwszą lepszą.

Zwraca: zbiór ścian z jedną ścianą.

sk = sketch(face(b, "top"))
hole(face(b, "top"), at: [10, 10], diameter: 5)

faces

Ściany bryły spełniające wszystkie podane warunki.

Zwraca: zbiór ścian.

shell(b, 2, openings: faces(b, side: "top"))
faces(b, kind: "cylinder", diameter: 6, internal: true)
faces(b, normal: up, min_area: 100)

find_sketch

Szkic po nazwie z drzewa. Bez argumentu daje ostatnio utworzony.

Zwraca: szkic.

sk = find_sketch("Sketch1")
b = extrude(find_sketch(), 10)

Odpowiednik „body” dla szkiców: pozwala sięgnąć po szkic z wcześniejszego uruchomienia skryptu, gdzie zmienna z nim już nie istnieje.

plane_from

Płaszczyzna podana punktem i normalną.

Zwraca: płaszczyzna.

mirror(b, plane_from([0,0,0], x_axis))

profile

Obszary szkicu do wyciągnięcia albo obrotu. Bez dodatkowych warunków bierze wszystkie zamknięte obszary szkicu.

Zwraca: profil.

extrude(profile(sk, index: 0), 10)

Zwykle wystarczy podać sam szkic: extrude(sk, 10) bierze wszystkie jego obszary.

sketches

Lista wszystkich szkiców dokumentu.

Zwraca: lista szkiców.

print(count(sketches()))

Prymitywy

box

Prostopadłościan o zadanych wymiarach.

Zwraca: bryła.

b = box([80, 40, 20])

cylinder

Walec o osi pionowej.

Zwraca: bryła.

b = cylinder(diameter: 30, height: 50)

gear_rack

Zębatka (listwa zębata) o zębach prostych, do pary z kołem spur_gear o tym samym module i kącie przyporu. Leży na płaszczyźnie poziomej: listwa biegnie wzdłuż +X, zęby patrzą w -Z, szerokość rośnie w górę.

Zwraca: bryła.

r = gear_rack(24, 2, thickness: 10, at: [-75.4, 0, 20])
p = spur_gear(20, 2, thickness: 10, hole: 8)

Koło o promieniu podziałowym r zazębia się z listwą, gdy jego środek leży r od linii podziałowej po stronie zębów: listwa z at: [x, 0, r] pasuje do koła w początku układu. Ząb numer k ma oś w x + (k + 1/2) * pi * moduł, więc oba końce listwy wypadają w połowie wrębu. Obrót koła o kąt a (w radianach) przesuwa listwę o a * r.

sphere

Kula.

Zwraca: bryła.

spur_gear

Koło zębate walcowe o zębach prostych, z zarysem ewolwentowym (zarys odniesienia ISO 53). Leży na płaszczyźnie poziomej z osią pionową, ząb numer 0 patrzy w +X.

Zwraca: bryła.

g = spur_gear(24, 2, thickness: 8, hole: 8)
p = spur_gear(13, 2, thickness: 8, at: [37, 0, 0])

Para kół zazębia się przy odległości osi moduł * (z1 + z2) / 2. Koło stojące w +X od drugiego ma naprzeciw wrąb, gdy liczba jego zębów jest nieparzysta; przy parzystej obróć je o pół podziałki: move(p, rotate: 180 / z, axis: up) przed przesunięciem na miejsce. Przy mniej niż 17 zębach (kąt 20°) zęby nie mają podcięcia, więc mała zębatka styka się z dużym kołem także pod okręgiem zasadniczym.

torus

Torus o osi pionowej.

Zwraca: bryła.

Bryły

emboss

Wytłacza albo wgłębia profil szkicu na ścianie bryły, także zakrzywionej (napis albo logo na walcu).

Zwraca: bryła.

emboss(face(walec, kind: "cylinder"), napis, 1)
emboss(walec, napis, 1, at: [0, 20, 20])
emboss(face(b, "top"), logo, 0.5, deboss: true)

Punktem odniesienia jest środek profilu rzucony wzdłuż normalnej szkicu na ścianę, więc szkic rysuje się na płaszczyźnie zwróconej do ściany (dla walca: przez jego oś albo stycznej).

extrude

Wyciąga profil prostopadle do jego płaszczyzny. Profilem jest szkic, jego wybrane obszary albo ściana bryły (wtedy działa jak wyciąganie ściany).

Zwraca: bryła albo lista brył.

b = extrude(sk, 20)
extrude(sk, -10, op: "cut", target: b)
extrude(sk, -1, op: "cut", target: b, through_all: true)
extrude(face(b, "top"), 5, op: "join", target: b)
extrude(sk, 0, to: face(other, "bottom"), offset: 1)

Wyciągnięcie ze szkicu założonego na ścianie bryły domyślnie dokłada albo odbiera materiał, zależnie od znaku odległości.

loft

Rozpina bryłę między profilami z różnych płaszczyzn, w podanej kolejności.

Zwraca: bryła albo lista brył.

b = loft([dol, srodek, gora])
b = loft([dol, gora], twist: 90)

pipe

Rura o przekroju kołowym wzdłuż ścieżki ze szkicu.

Zwraca: bryła.

b = pipe(sciezka, diameter: 12)

project_to_surface

Kładzie krzywe szkicu na ścianach bryły, także zakrzywionych. Wynikiem jest bryła z samych krzywych, na przykład linia podziału ściany.

Zwraca: bryła krzywych.

k = project_to_surface(face(walec, kind: "cylinder"), napis)
split_face(face(walec, kind: "cylinder"), k)

Krzywe nie dokładają materiału. Służą jako narzędzie podziału ściany albo odniesienie; materiał na ścianie daje emboss.

revolve

Obraca profil wokół osi.

Zwraca: bryła albo lista brył.

b = revolve(sk, axis([0,0,0], up), 360)
gwint = revolve(trapez, axis([0,0,0], up), pitch: 4, length: 30, op: "join", target: pret)
czasza = revolve(luk, axis([0,0,0], up), 360, solid: false)

rib

Żebro z otwartego profilu: rośnie do bryły i kończy się tam, gdzie do niej dolega.

Zwraca: bryła.

sweep

Przeciąga profil wzdłuż ścieżki z innego szkicu.

Zwraca: bryła albo lista brył.

b = sweep(profil, sciezka)
filar = sweep(kwadrat, os, rail: sylwetka, twist: 120, spin: 180)

web

Ścianka z otwartego profilu: w odróżnieniu od żebra wchodzi w bryłę na całej długości.

Zwraca: bryła.

Modyfikacje

chamfer

Ścina wskazane krawędzie.

Zwraca: bryła.

b = chamfer(edges(b, kind: "circle", diameter: 8), 0.5)

copy

Kopia bryły w tym samym miejscu. Oryginał zostaje.

Zwraca: bryła.

druga = move(copy(b), [40, 0, 0])

draft

Pochyla wskazane ściany względem kierunku wyciągania. Do form odlewniczych i wtryskowych.

Zwraca: bryła.

b = draft(faces(b, kind: "plane", normal: x_axis), 3, neutral: face(b, "bottom"))

fillet

Zaokrągla wskazane krawędzie.

Zwraca: bryła.

b = fillet(edges(b, dir: up), 3)
fillet(edges(b, kind: "circle"), radius: 1)

Zaokrąglenie zastępuje bryłę źródłową, tak jak przy pracy myszą. Gdy promień jest za duży dla geometrii, operacja nie powstaje i skrypt zgłasza błąd.

hole

Wierci otwór w ścianie bryły: prosty, z pogłębieniem walcowym albo stożkowym, z opcjonalnym gwintem.

Zwraca: bryła.

b = hole(face(b, "top"), at: [10, 10], diameter: 6, depth: 12)
b = hole(face(b, "top"), at: [0, 0], thread: "M8")
b = hole(face(b, "top"), at: [20, 0], diameter: 5, type: "countersink", cs_diameter: 10)

move

Przesuwa i obraca bryłę.

Zwraca: bryła.

move(b, [0, 0, 25])
move(b, rotate: 45, axis: up)

offset_body

Odsuwa wszystkie ściany bryły naraz, razem z zaokrągleniami i otworami. Ujemna odległość zmniejsza bryłę i powiększa otwory: kompensacja rozlewania się druku 3D.

Zwraca: bryła.

b = offset_body(b, -0.1)
b = offset_body(b, 0.5, corners: "round")

scale

Skaluje bryłę; osobne współczynniki dla osi dają skalowanie nierównomierne.

Zwraca: bryła.

scale(b, 2)
scale(b, [2, 1, 1])

shell

Wydrąża bryłę, zostawiając ściankę o zadanej grubości. Wskazane ściany są usuwane i tworzą otwarcia; bez nich skorupa jest zamknięta, z pustką w środku.

Zwraca: bryła.

b = shell(b, 2, openings: faces(b, side: "top"))
b = shell(b, 2)

thicken

Nadaje grubość powierzchni albo wskazanym ścianom, zamieniając je w bryłę.

Zwraca: bryła.

b = thicken(powierzchnia, 2)

thread

Nacina gwint na ścianie walcowej: na wałku od zewnątrz, w otworze od wewnątrz.

Zwraca: bryła.

b = thread(face(b, kind: "cylinder", diameter: 10), "M10")
b = thread(face(b, kind: "cylinder", diameter: 75), "M75x2", fit: true)
b = thread(face(b, kind: "cylinder", diameter: 10), "M10", chamfer: "end")

Operacje logiczne

cut

Odejmuje bryły narzędzia od bryły docelowej.

Zwraca: bryła albo lista brył.

b = cut(korpus, wiertlo)

intersect

Zostawia część wspólną brył.

Zwraca: bryła albo lista brył.

mirror

Odbija bryły względem płaszczyzny. Oryginały zostają.

Zwraca: bryła albo lista brył.

mirror(b, plane.yz)
mirror(b, plane.yz, features: [wyciecie])

split_body

Dzieli bryłę płaszczyzną albo narzędziem (powierzchnią, też zagiętą, lub inną bryłą) na osobne bryły.

Zwraca: lista brył.

czesci = split_body(b, plane.xy)
czesci = split_body(b, tool: zagieta)

union

Łączy bryły w jedną.

Zwraca: bryła albo lista brył.

b = union(podstawa, wspornik)

Wzory

pattern_circular

Powiela bryłę wokół osi.

Zwraca: bryła albo lista brył.

pattern_circular(b, axis([0,0,0], up), count: 6)

pattern_linear

Powiela bryłę wzdłuż kierunku.

Zwraca: bryła albo lista brył.

pattern_linear(b, x_axis, count: 5, distance: 20)
pattern_linear(b, x_axis, count: 4, distance: 15, direction2: y_axis, count2: 3, distance2: 10)

pattern_path

Powiela bryłę wzdłuż ścieżki ze szkicu.

Zwraca: bryła albo lista brył.

Ściany

delete_face

Usuwa wskazane ściany, domykając bryłę sąsiednimi. Do zdejmowania zaokrągleń i faz.

Zwraca: bryła.

offset_face

Odsuwa wskazane ściany o zadaną odległość, zmieniając wymiar bryły.

Zwraca: bryła.

replace_face

Zastępuje wskazane ściany inną powierzchnią.

Zwraca: bryła.

split_face

Dzieli ściany innym kształtem, bez zmiany objętości.

Zwraca: bryła.

Powierzchnie

boundary_fill

Rozpina powierzchnię na wskazanych krawędziach brył.

Zwraca: bryła powierzchniowa.

extend_surface

Przedłuża powierzchnię przy wskazanych krawędziach.

Zwraca: bryła powierzchniowa.

offset_surface

Tworzy powierzchnię odsuniętą od wskazanej. Źródło zostaje.

Zwraca: bryła powierzchniowa.

patch

Wypełnia zamknięty kontur szkicu powierzchnią.

Zwraca: bryła powierzchniowa.

stitch

Zszywa powierzchnie w powłokę, a przy szczelnym wyniku w bryłę.

Zwraca: bryła.

trim_surface

Przycina powierzchnię innym kształtem, zostawiając kawałek wskazany punktem.

Zwraca: bryła powierzchniowa.

unstitch

Rozkłada kształt na osobne ściany.

Zwraca: lista brył powierzchniowych.

Geometria konstrukcyjna

construction_axis

Oś konstrukcyjna w drzewie, widoczna w scenie.

Zwraca: oś konstrukcyjna.

construction_point

Punkt konstrukcyjny w drzewie.

Zwraca: punkt konstrukcyjny.

offset_plane

Płaszczyzna konstrukcyjna odsunięta równolegle od podanej. Trafia do drzewa i można na niej szkicować.

Zwraca: płaszczyzna konstrukcyjna.

p = offset_plane(plane.xy, 25)
sk = sketch(p)

plane_along_path

Płaszczyzna konstrukcyjna prostopadła do krzywej szkicu we wskazanym miejscu jej długości.

Zwraca: płaszczyzna konstrukcyjna.

przekroj = plane_along_path(sciezka, 0.5)

Przydaje się przed przeciągnięciem: profil rysuje się na płaszczyźnie prostopadłej do ścieżki.

plane_at_angle

Płaszczyzna konstrukcyjna zawierająca linię szkicu, obrócona wokół niej o zadany kąt.

Zwraca: płaszczyzna konstrukcyjna.

skos = plane_at_angle(krawedz, 30)

Pomiary

measure

Właściwości bryły: objętość, pole, środek masy, zasięg.

Zwraca: rekord z polami volume, area, center, min, max, size.

m = measure(b)
print("objętość " + round(m.volume / 1000, 2) + " cm3")

Dokument

color

Ustawia kolor bryły.

Zwraca: ta sama bryła.

color(b, "#3498db")

hide

Ukrywa bryłę, szkic albo płaszczyznę.

Zwraca: nic.

material

Przypisuje bryle materiał z biblioteki wyglądów. Materiał z gęstością pozwala policzyć masę.

Zwraca: ta sama bryła.

name

Nadaje nazwę bryle albo szkicowi. Ta sama nazwa pozwala odnaleźć obiekt później przez body("...").

Zwraca: ten sam obiekt.

name(b, "Korpus")

remove

Usuwa bryłę, szkic albo operację z historii.

Zwraca: nic.

Usunięcie operacji usuwa też wszystko, co z niej wynika.

show

Pokazuje ukrytą bryłę, szkic albo płaszczyznę.

Zwraca: nic.

Wymiana

export_file

Zapisuje bryły do pliku w podanym formacie.

Zwraca: nic.

export_file(b, "korpus.step")

import_file

Wczytuje plik CAD i wstawia jego zawartość jako bryły.

Zwraca: bryła albo lista brył.

Plik musi być dostępny dla aplikacji: w przeglądarce z katalogu wskazanego w ustawieniach biblioteki modeli.

Widok

fit

Dopasowuje widok tak, żeby cały model był widoczny.

Zwraca: nic.

section

Włącza analizę przekroju: model jest pokazywany przecięty wskazaną płaszczyzną. Nie zmienia geometrii.

Zwraca: nic.

section(plane.yz)

section_off

Wyłącza analizę przekroju.

Zwraca: nic.

view

Ustawia kamerę na widok standardowy.

Zwraca: nic.

Matematyka

abs

Wartość bezwzględna.

Zwraca: liczba.

acos

Arcus cosinus, wynik w stopniach.

Zwraca: liczba.

asin

Arcus sinus, wynik w stopniach.

Zwraca: liczba.

atan

Arcus tangens, wynik w stopniach.

Zwraca: liczba.

atan2

Kąt w stopniach wektora (x, y) względem osi X.

Zwraca: liczba: kąt w stopniach.

ceil

Zaokrąglenie w górę.

Zwraca: liczba.

clamp

Wartość przycięta do przedziału.

Zwraca: liczba.

cos

Cosinus kąta podanego w stopniach.

Zwraca: liczba.

cross

Iloczyn wektorowy: wektor prostopadły do obu podanych.

Zwraca: wektor.

deg

Zamienia radiany na stopnie.

Zwraca: liczba: kąt w stopniach.

dot

Iloczyn skalarny dwóch wektorów.

Zwraca: liczba.

floor

Zaokrąglenie w dół.

Zwraca: liczba.

length_of

Długość wektora.

Zwraca: liczba.

max

Większa z dwóch liczb.

Zwraca: liczba.

min

Mniejsza z dwóch liczb.

Zwraca: liczba.

normalized

Wektor o długości jeden, zgodny kierunkiem z podanym.

Zwraca: wektor.

pow

Potęga. To samo co operator ^.

Zwraca: liczba.

rad

Zamienia stopnie na radiany. Rzadko potrzebne, bo cały język liczy w stopniach.

Zwraca: liczba: kąt w radianach.

round

Zaokrąglenie do zadanej liczby miejsc po przecinku.

Zwraca: liczba.

sin

Sinus kąta podanego w stopniach.

Zwraca: liczba.

sqrt

Pierwiastek kwadratowy.

Zwraca: liczba.

tan

Tangens kąta podanego w stopniach.

Zwraca: liczba.

vec

Wektor albo punkt w przestrzeni. To samo co zapis [x, y, z], wygodne przy liczeniu.

Zwraca: wektor [x, y, z].

Listy

count

Liczba elementów listy albo zbioru krawędzi lub ścian.

Zwraca: liczba.

item

Element listy po numerze, licząc od zera. Numer ujemny liczy od końca.

Zwraca: element.

range

Lista liczb od początku do końca, bez wartości końcowej. Do pętli.

Zwraca: lista liczb.

for i in range(0, 5) { print(i) }
range(0, 100, 25)

Diagnostyka

assert

Przerywa skrypt, gdy warunek nie jest spełniony. Do sprawdzania założeń, na przykład czy selektor trafił w tyle krawędzi, ile powinien.

Zwraca: nic.

assert(edges(b, kind: "circle").count == 4, "spodziewam się czterech otworów")

print

Wypisuje wartość w konsoli skryptu.

Zwraca: nic.

print("wysokość: " + h)