Obiekty: Api

From FreeCAD Documentation
This page is a translated version of the page Object API and the translation is 100% complete.
(Październik 2019) Nie edytuj tych stron. Informacje są niekompletne i nieaktualne. Najnowsze API można znaleźć w automatycznie generowana dokumentacja API, lub wygenerować dokumentację samodzielnie, śledząc dokument Dokumentacja źródłowa.

Jako parametryczne, obiekty dokumentów FreeCAD mogą mieć wiele dodatkowych właściwości, ale te są podstawowe, obecne w każdym obiekcie dokumentu FreeCAD. Obiekty mogą być wyszukiwane po prostu przez ich nazwę. Przykład:

myObj = FreeCAD.ActiveDocument.myObjectName
print myObj.PropertiesList
Content

Returns: Reprezentacja XML właściwości obiektu.

Label

Returns: Pobiera/ustawia etykietę obiektu. Łańcuch może być typu unicode.

Name

Returns: Niepowtarzalna nazwa obiektu.

Placement

Returns: Pobiera/ustawia umiejscowienie obiektu. Umiejscowienie określa orientację (obrót) i pozycję ( położenie) w przestrzeni 3D. Funkcja ta jest używana, gdy nie jest wymagane skalowanie lub inne zniekształcenie.

PropertiesList

Returns: Lista właściwości obiektu

State

Returns: Status obiektu w programie FreeCAD (np. czy musi być ponownie obliczony)

Type

Returns: Ciąg znaków opisujący typ obiektu

ViewObject

Returns: Powiązany dostawca widoku obiektu (obiekt FreeCADGUI)

getAllDerivedFrom( )

Description:

Returns: Wszyscy potomkowie tego obiektu

getDocumentationOfProperty( )

Description:

Returns: Ciąg dokumentacji właściwości tej klasy.

getGroupOfProperty( )

Description:

Returns: Nazwa grupy, do której należy właściwość w tej klasie. Właściwości są posortowane w różnych grupach dla wygody.

getPropertyByName( )

Description:

Returns: Wartość nazwanej właściwości.

getTypeOfProperty( )

Description:

Returns: Typ nazwanej właściwości. Może to być (Hidden, ReadOnly, Output) lub dowolna kombinacja.

isDerivedFrom( )

Description:

Returns: Prawda jeśli podany typ jest ojcem

purgeTouched( )

Description: Zaznacza obiekt jako niezmieniony

Returns:

touch( )

Description: Zaznacza obiekt jako zmieniony (dotknięty)

Returns: