Draft API/pl: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
No edit summary
 
(14 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<languages/>
These functions are part of the Draft module and can be used in scripts and macros or from the python interpreter, once the Draft module has been imported.
{{VeryImportantMessage
|''(listopad 2018 r.)'' Informacje te mogą być niekompletne i nieaktualne. Najnowsze API - patrz [https://www.freecadweb.org/api dokumentacja API generowana automatycznie].}}


Funkcje te są częścią Środowiska pracy [[Draft Workbench|Draft]] i mogą być używane w [[macros|makrodefinicjach]] i z konsoli [[Python|Python]] po zaimportowaniu modułu {{incode|Draft}}.
Example:
<syntaxhighlight>
import FreeCAD
from Draft import *
myrect = makeRectangle(4,3)
mydistance = FreeCAD.Vector(2,2,0)
move(myrect,mydistance)
</syntaxhighlight>


Przykład:
{{Code|code=
import FreeCAD, Draft


myrect = Draft.makeRectangle(4, 3)
{{APIFunction|cut|FreeCAD.Object, FreeCAD.Object|Returns a cut object made from the difference of the 2 given objects. The original objects get hidden.|The newly created object}}
mydistance = FreeCAD.Vector(2, 2, 0)
{{APIFunction|extrude|FreeCAD.Object, Vector|Extrudes the given object in the direction given by the vector. The original object gets hidden.|The newly created object}}
Draft.move(myrect, mydistance)
{{APIFunction|formatObject|FreeCAD.Object, [FreeCAD.Object]|This function applies to the given target object the current properties set on the Draft toolbar (line color and line width), or copies the properties of a second object if provided. It also places the object in construction group if the construction button is pressed.|Nothing}}
}}
{{APIFunction|fuse|FreeCAD.Object, FreeCAD.Object|Returns an object made from the union of the 2 given objects. If the objects are coplanar, a special Draft Wire is used, otherwise the final object is a standard Part fuse.|The newly created object}}
{{APIFunction|getDraftPath|[string]|Returns the user or system path where the Draft module is running from. If a subpath or a filename is supplied, the full path to the subpath inside the Draft module is returned.|A file path}}
{{APIFunction|getGroupContents|list|Scans recursively the given list for groups. If groups are encountered, their contents are appended to the list.|A list of FreeCAD Objects}}
{{APIFunction|getRealName|string|Strips the trailing numbers from an object name.|The stripped object name}}
{{APIFunction|getSelection| |Returns the current FreeCAD selection.|The current FreeCAD selection.}}
{{APIFunction|makeCircle|radius, [placement], [facemode], [startangle], [endangle]|Creates a circle object with given radius. If a placement is given, it is used. If facemode is False, the circle is shown as a wireframe, otherwise as a face. If startangle AND endangle are given (in degrees), they are used and the object appears as an arc.|The newly created object.}}
{{APIFunction|makeDimension|Vector, Vector, [Vector] or FreeCAD.Object, int, int, [Vector]|Creates a Dimension object measuring distance between first and second vectors, with the dimension line passign through the third vector if provided. The current line width and color from the Draft toolbar will be used. Instead of 2 vectors, you can also pass a FreeCAD object, and two integers (and optionally a vector where the dimension line must pass). In that case, the dimension will be associated with the object, and measure two of its vertices, indicated by the two given indice numbers.|The newly created object.}}
{{APIFunction|makeLine|Vector, Vector|Creates a line between the two given vectors. The current line width and color from the Draft toolbar will be used.|The newly created object.}}
{{APIFunction|makeRectangle|length, width, [placement], [facemode]|Creates a Rectangle object with length in X direction and height in Y direction. If a placement is given, it is used. If facemode is False, the rectangle is shown as a wireframe, otherwise as a face. The current line width and color from the Draft toolbar will be used.|The newly created object.}}
{{APIFunction|makeText|string or list, [Vector], [screenmode]|Creates a Text object, at the given point if a vector is provided, containing the string or the strings given in the list, one string by line. The current color from the Draft toolbar and the text height and font specified in preferences are used. If screenmode is True, the text always faces the view direction, otherwise it lies on the XY plane.|The newly created object.}}
{{APIFunction|makeWire|list or Part.Wire, [closed], [placement], [facemode]|Creates a DWire object from the given list of vectors or from the given Wire. If closed is True or if first and last points are identical, the wire is closed. If facemode is True (and wire is closed), the wire will appear filled. The current line width and color from the Draft toolbar will be used.|A new Draft DWire (not a Part Wire).}}
{{APIFunction|move|FreeCAD.Object or list, Vector, [copymode]|Moves the given object or the objects contained in the given list in the direction and distance indicated by the given vector. If copymode is True, the actual objects are not moved, but copies are created instead.|The object(s) (or their copies if copymode was True).}}
{{APIFunction|precision| |Returns the precision value from Draft user settings.|An integer.}}
{{APIFunction|rotate|FreeCAD.Object or list, angle, [center], [axis] ,[copymode]|Rotates the given object or the objects contained in the given list with the given angle around the given center if provided, using axis as a rotation axis. If axis is omitted, the rotation will be around the vertical Z axis. If copymode is True, the actual objects are not moved, but copies are created instead.|The objects (or their copies).}}
{{APIFunction|scale|FreeCAD.Object or list, vector, [center], [copymode]|Scales the given object or the objects contained in the given list with a scale factors defined by the given vector (in X, Y and Z directions) around the given center if provided. If copymode is True, the actual objects are not moved, but copies are created instead.|The objects (or their copies).}}
{{APIFunction|select|FreeCAD.Object|Deselects everything and selects only the passed object|Nothing.}}
{{APIFunction|shapify|FreeCAD.Object|Transforms a parametric shape object into non-parametric.|The new object.}}
{{APIFunction|draftify|FreeCAD.Object or list|Turns the given object or each object of the given list into Draft parametric wires.|Nothing.}}
{{APIFunction|getSVG|FreeCAD.Object, [linemodifier], [textmodifier], [(u,v)]|Creates a SVG representation of the given object. The linemodifier attribute is a scale factor (in percents) for line width, and textmodifier for text size. You can also optionally provide a tuple of vectors to define a projection plane, otherwise the geometry will be projected on the XY plane.|a string containing a SVG representation of the given object.}}


{{APIFunction|cut|FreeCAD.Object, FreeCAD.Object|Zwraca wycięty obiekt wykonany z różnicy dwóch danych obiektów. Oryginalne obiekty zostają ukryte.|Nowo utworzony obiekt.}}
{{APIFunction|extrude|FreeCAD.Object, Vector|Wyciągnie dany obiekt w kierunku podanym przez wektor. Oryginalny obiekt zostaje ukryty.|Nowo utworzony obiekt.}}
{{APIFunction|formatObject|FreeCAD.Object, [FreeCAD.Object]|Funkcja ta stosuje do danego obiektu docelowego bieżące właściwości ustawione na pasku narzędzi szkicu (kolor linii i szerokość linii) lub kopiuje właściwości drugiego obiektu, jeśli jest podany. Umieszcza również obiekt w grupie konstrukcyjnej, jeśli zostanie naciśnięty przycisk konstrukcyjny.|Nic}}
{{APIFunction|fuse|FreeCAD.Object, FreeCAD.Object|Zwraca obiekt wykonany ze złączenia 2 podanych obiektów. Jeśli obiekty są współpłaszczyznowe, używany jest specjalny ścieżka robocza, w przeciwnym razie obiektem końcowym jest standardowy Part fuse.|Nowo utworzony obiekt.}}
{{APIFunction|getDraftPath|[string]|Zwraca ścieżkę dostępu katalogu użytkownika lub systemu, z którego uruchamiany jest moduł Draft. Jeżeli podano podścieżkę lub nazwę pliku, zwracana jest pełna ścieżka do podścieżki wewnątrz modułu Draft.|Ścieżka dostępu do pliku.}}
{{APIFunction|getGroupContents|list|Skanuje cyklicznie podaną listę grup. Jeśli grupy zostały napotkane, ich zawartość jest dołączana do listy.|Lista obiektów ''FreeCAD Objects''.}}
{{APIFunction|getRealName|string|Odcina numery końcowe z nazwy obiektu.|Nazwa ''(skrócona)'' obiektu.}}
{{APIFunction|getSelection| |Zwraca bieżący wybór z FreeCAD.|Bieżący wybór z FreeCAD.}}
{{APIFunction|makeCircle|radius, [placement], [facemode], [startangle], [endangle]|Tworzy obiekt okręgu o zadanym promieniu. Jeśli podano położenie, to jest ono używane. Jeśli tryb ściany ''(Facemode)'' to False, okrąg jest pokazany jako szkielet druciany, w przeciwnym razie jako ściana. Jeśli podano kąt początkowy i końcowy ''(w stopniach)'', są one używane i obiekt pojawia się jako łuk.|Nowo utworzony obiekt.}}
{{APIFunction|makeDimension|Vector, Vector, [Vector] or FreeCAD.Object, int, int, [Vector]|Tworzy obiekt wymiarowy mierzący odległość pomiędzy pierwszym i drugim wektorem, z oznaczeniem linii wymiarowej przez trzeci wektor, jeśli jest dostępny. Zostanie użyta aktualna szerokość i kolor linii z paska narzędzi Draft. Zamiast 2 wektorów, można również przekazać obiekt FreeCAD i dwie liczby całkowite ''(i opcjonalnie wektor, przez który musi przejść linia wymiarowa)''. W takim przypadku wymiar będzie kojarzony z obiektem i będzie mierzył dwa jego wierzchołki, wskazane przez dwa podane numery indeksów.|Nowo utworzony obiekt.}}
{{APIFunction|makeLine|Vector, Vector|Tworzy linię pomiędzy dwoma danymi wektorami. Zostanie użyta aktualna szerokość i kolor linii z paska narzędzi Draft.|Nowo utworzony obiekt.}}
{{APIFunction|makeRectangle|length, width, [placement], [facemode]|Tworzy obiekt prostokąta o długości w kierunku X i wysokości w kierunku Y. Jeśli podano położenie, jest ono używane. Jeśli tryb Facemode to False, prostokąt jest pokazywany jako szkielet, w przeciwnym razie jako ściana. Zostanie użyta aktualna szerokość i kolor linii z paska narzędzi Draft.|Nowo utworzony obiekt.}}
{{APIFunction|makeText|string or list, [Vector], [screenmode]|Tworzy obiekt tekstowy, w danym punkcie, jeśli podano wektor, zawierający ciąg znaków lub ciągi znaków podane w liście, jeden ciąg na linię. Używany jest aktualny kolor z paska narzędzi Draft oraz wysokość tekstu i czcionka określona w preferencjach. Jeśli tryb ekranu ''(screenmode)'' to True, tekst zawsze jest zwrócony w kierunku widoku, w przeciwnym razie leży na płaszczyźnie XY.|Nowo utworzony obiekt.}}
{{APIFunction|makeWire|list or Part.Wire, [closed], [placement], [facemode]|Tworzy obiekt DWire z podanej listy wektorów lub z podanej ścieżki. Jeśli parametr zamknięty ''(closed)'' to True lub jeśli pierwszy i ostatni punkt są w tym samym położeniu, ścieżka jest zamykana. Jeśli tryb facemode to True ''(i ścieżka jest zamknięta)'', ścieżka zostanie wyświetlana jako wypełniona. Zostanie użyta aktualna szerokość i kolor linii z paska narzędzi Draft.|Nowy obiekt Draft DWire ''(nie mylić z Part Wire)''.}}
{{APIFunction|move|FreeCAD.Object or list, Vector, [copymode]|Przesuwa dany obiekt lub obiekty znajdujące się na liście, w kierunku i na odległość wskazaną przez dany wektor. Jeśli kopymode to True, to aktualne obiekty nie są przesuwane, lecz tworzone są ich kopie.|Obiekt(y) ''(lub ich kopie, jeżeli parametr copymode to True)''.}}
{{APIFunction|precision| |Zwraca wartość dokładności z ustawień użytkownika Draft.|Liczba całkowita.}}
{{APIFunction|rotate|FreeCAD.Object or list, angle, [center], [axis] ,[copymode]|Obraca dany obiekt lub obiekty znajdujące się na danej liście o zadany kąt wokół zadanego punktu środkowego, jeśli podano, z użyciem osi obrotu. Jeśli oś jest pominięta, obrót będzie się odbywał wokół pionowej osi Z. Jeśli parametr copymode to True, aktualne obiekty nie są przesuwane, lecz tworzone są ich kopie.|Obiekty (lub ich kopie).}}
{{APIFunction|scale|FreeCAD.Object or list, vector, [center], [copymode]|Skaluje dany obiekt lub obiekty znajdujące się na podanej liście za pomocą współczynników skali zdefiniowanych przez dany wektor ''(w kierunkach X, Y i Z)'' wokół podanego punktu środka, jeśli jest to możliwe. Jeśli tryb Copymode to True, rzeczywiste obiekty nie są przenoszone, ale zamiast tego tworzone są ich kopie.|Obiekty (lub ich kopie).}}
{{APIFunction|select|FreeCAD.Object|Odznacza wszystko i zaznacza tylko przekazywany obiekt.|Nic.}}
{{APIFunction|shapify|FreeCAD.Object|Przekształca obiekt o kształcie parametrycznym w nieparametryczny.|Nowy obiekt.}}
{{APIFunction|draftify|FreeCAD.Object or list|Zamienia dany obiekt lub każdy obiekt z danej listy w parametryczne ścieżki Draft|Nic.}}
{{APIFunction|getSVG|FreeCAD.Object, [linemodifier], [textmodifier], [(u,v)]|Tworzy reprezentację SVG danego obiektu. Atrybut linemodifier to współczynnik skali ''(w procentach)'' dla szerokości linii i modyfikator tekstu dla rozmiaru tekstu. Możesz także opcjonalnie podać zestaw wektorów w celu zdefiniowania płaszczyzny rzutowania, w przeciwnym razie geometria zostanie rzutowana na płaszczyznę XY.|Łańcuch zawierający reprezentację SVG danego obiektu.}}


{{Draft Tools navi{{#translation:}}}}
[[Category:API]]
{{Userdocnavi{{#translation:}}}}
[[Category:Poweruser Documentation]]
[[Category:API{{#translation:}}]]
[[Category:Poweruser Documentation{{#translation:}}]]


{{clear}}
{{clear}}
<languages/>

Latest revision as of 17:34, 17 October 2021

(listopad 2018 r.) Informacje te mogą być niekompletne i nieaktualne. Najnowsze API - patrz dokumentacja API generowana automatycznie.

Funkcje te są częścią Środowiska pracy Draft i mogą być używane w makrodefinicjach i z konsoli Python po zaimportowaniu modułu Draft.

Przykład:

import FreeCAD, Draft

myrect = Draft.makeRectangle(4, 3)
mydistance = FreeCAD.Vector(2, 2, 0)
Draft.move(myrect, mydistance)
cut(FreeCAD.Object, FreeCAD.Object)

Description: Zwraca wycięty obiekt wykonany z różnicy dwóch danych obiektów. Oryginalne obiekty zostają ukryte.

Returns: Nowo utworzony obiekt.

extrude(FreeCAD.Object, Vector)

Description: Wyciągnie dany obiekt w kierunku podanym przez wektor. Oryginalny obiekt zostaje ukryty.

Returns: Nowo utworzony obiekt.

formatObject(FreeCAD.Object, [FreeCAD.Object])

Description: Funkcja ta stosuje do danego obiektu docelowego bieżące właściwości ustawione na pasku narzędzi szkicu (kolor linii i szerokość linii) lub kopiuje właściwości drugiego obiektu, jeśli jest podany. Umieszcza również obiekt w grupie konstrukcyjnej, jeśli zostanie naciśnięty przycisk konstrukcyjny.

Returns: Nic

fuse(FreeCAD.Object, FreeCAD.Object)

Description: Zwraca obiekt wykonany ze złączenia 2 podanych obiektów. Jeśli obiekty są współpłaszczyznowe, używany jest specjalny ścieżka robocza, w przeciwnym razie obiektem końcowym jest standardowy Part fuse.

Returns: Nowo utworzony obiekt.

getDraftPath([string])

Description: Zwraca ścieżkę dostępu katalogu użytkownika lub systemu, z którego uruchamiany jest moduł Draft. Jeżeli podano podścieżkę lub nazwę pliku, zwracana jest pełna ścieżka do podścieżki wewnątrz modułu Draft.

Returns: Ścieżka dostępu do pliku.

getGroupContents(list)

Description: Skanuje cyklicznie podaną listę grup. Jeśli grupy zostały napotkane, ich zawartość jest dołączana do listy.

Returns: Lista obiektów FreeCAD Objects.

getRealName(string)

Description: Odcina numery końcowe z nazwy obiektu.

Returns: Nazwa (skrócona) obiektu.

getSelection( )

Description: Zwraca bieżący wybór z FreeCAD.

Returns: Bieżący wybór z FreeCAD.

makeCircle(radius, [placement], [facemode], [startangle], [endangle])

Description: Tworzy obiekt okręgu o zadanym promieniu. Jeśli podano położenie, to jest ono używane. Jeśli tryb ściany (Facemode) to False, okrąg jest pokazany jako szkielet druciany, w przeciwnym razie jako ściana. Jeśli podano kąt początkowy i końcowy (w stopniach), są one używane i obiekt pojawia się jako łuk.

Returns: Nowo utworzony obiekt.

makeDimension(Vector, Vector, [Vector] or FreeCAD.Object, int, int, [Vector])

Description: Tworzy obiekt wymiarowy mierzący odległość pomiędzy pierwszym i drugim wektorem, z oznaczeniem linii wymiarowej przez trzeci wektor, jeśli jest dostępny. Zostanie użyta aktualna szerokość i kolor linii z paska narzędzi Draft. Zamiast 2 wektorów, można również przekazać obiekt FreeCAD i dwie liczby całkowite (i opcjonalnie wektor, przez który musi przejść linia wymiarowa). W takim przypadku wymiar będzie kojarzony z obiektem i będzie mierzył dwa jego wierzchołki, wskazane przez dwa podane numery indeksów.

Returns: Nowo utworzony obiekt.

makeLine(Vector, Vector)

Description: Tworzy linię pomiędzy dwoma danymi wektorami. Zostanie użyta aktualna szerokość i kolor linii z paska narzędzi Draft.

Returns: Nowo utworzony obiekt.

makeRectangle(length, width, [placement], [facemode])

Description: Tworzy obiekt prostokąta o długości w kierunku X i wysokości w kierunku Y. Jeśli podano położenie, jest ono używane. Jeśli tryb Facemode to False, prostokąt jest pokazywany jako szkielet, w przeciwnym razie jako ściana. Zostanie użyta aktualna szerokość i kolor linii z paska narzędzi Draft.

Returns: Nowo utworzony obiekt.

makeText(string or list, [Vector], [screenmode])

Description: Tworzy obiekt tekstowy, w danym punkcie, jeśli podano wektor, zawierający ciąg znaków lub ciągi znaków podane w liście, jeden ciąg na linię. Używany jest aktualny kolor z paska narzędzi Draft oraz wysokość tekstu i czcionka określona w preferencjach. Jeśli tryb ekranu (screenmode) to True, tekst zawsze jest zwrócony w kierunku widoku, w przeciwnym razie leży na płaszczyźnie XY.

Returns: Nowo utworzony obiekt.

makeWire(list or Part.Wire, [closed], [placement], [facemode])

Description: Tworzy obiekt DWire z podanej listy wektorów lub z podanej ścieżki. Jeśli parametr zamknięty (closed) to True lub jeśli pierwszy i ostatni punkt są w tym samym położeniu, ścieżka jest zamykana. Jeśli tryb facemode to True (i ścieżka jest zamknięta), ścieżka zostanie wyświetlana jako wypełniona. Zostanie użyta aktualna szerokość i kolor linii z paska narzędzi Draft.

Returns: Nowy obiekt Draft DWire (nie mylić z Part Wire).

move(FreeCAD.Object or list, Vector, [copymode])

Description: Przesuwa dany obiekt lub obiekty znajdujące się na liście, w kierunku i na odległość wskazaną przez dany wektor. Jeśli kopymode to True, to aktualne obiekty nie są przesuwane, lecz tworzone są ich kopie.

Returns: Obiekt(y) (lub ich kopie, jeżeli parametr copymode to True).

precision( )

Description: Zwraca wartość dokładności z ustawień użytkownika Draft.

Returns: Liczba całkowita.

rotate(FreeCAD.Object or list, angle, [center], [axis] ,[copymode])

Description: Obraca dany obiekt lub obiekty znajdujące się na danej liście o zadany kąt wokół zadanego punktu środkowego, jeśli podano, z użyciem osi obrotu. Jeśli oś jest pominięta, obrót będzie się odbywał wokół pionowej osi Z. Jeśli parametr copymode to True, aktualne obiekty nie są przesuwane, lecz tworzone są ich kopie.

Returns: Obiekty (lub ich kopie).

scale(FreeCAD.Object or list, vector, [center], [copymode])

Description: Skaluje dany obiekt lub obiekty znajdujące się na podanej liście za pomocą współczynników skali zdefiniowanych przez dany wektor (w kierunkach X, Y i Z) wokół podanego punktu środka, jeśli jest to możliwe. Jeśli tryb Copymode to True, rzeczywiste obiekty nie są przenoszone, ale zamiast tego tworzone są ich kopie.

Returns: Obiekty (lub ich kopie).

select(FreeCAD.Object)

Description: Odznacza wszystko i zaznacza tylko przekazywany obiekt.

Returns: Nic.

shapify(FreeCAD.Object)

Description: Przekształca obiekt o kształcie parametrycznym w nieparametryczny.

Returns: Nowy obiekt.

draftify(FreeCAD.Object or list)

Description: Zamienia dany obiekt lub każdy obiekt z danej listy w parametryczne ścieżki Draft

Returns: Nic.

getSVG(FreeCAD.Object, [linemodifier], [textmodifier], [(u,v)])

Description: Tworzy reprezentację SVG danego obiektu. Atrybut linemodifier to współczynnik skali (w procentach) dla szerokości linii i modyfikator tekstu dla rozmiaru tekstu. Możesz także opcjonalnie podać zestaw wektorów w celu zdefiniowania płaszczyzny rzutowania, w przeciwnym razie geometria zostanie rzutowana na płaszczyznę XY.

Returns: Łańcuch zawierający reprezentację SVG danego obiektu.