Obiekty: Api

From FreeCAD Documentation
Jump to navigation Jump to search
This page is a translated version of the page Object API and the translation is 100% complete.
Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎polski • ‎română
(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
Property.png Content

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

Property.png Label

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

Property.png Name

Returns: Niepowtarzalna nazwa obiektu.

Property.png 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.

Property.png PropertiesList

Returns: Lista właściwości obiektu

Property.png State

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

Property.png Type

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

Property.png ViewObject

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

Method.png getAllDerivedFrom( )

Description:

Returns: Wszyscy potomkowie tego obiektu

Method.png getDocumentationOfProperty( )

Description:

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

Method.png 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.

Method.png getPropertyByName( )

Description:

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

Method.png getTypeOfProperty( )

Description:

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

Method.png isDerivedFrom( )

Description:

Returns: Prawda jeśli podany typ jest ojcem

Method.png purgeTouched( )

Description: Zaznacza obiekt jako niezmieniony

Returns:

Method.png touch( )

Description: Zaznacza obiekt jako zmieniony (dotknięty)

Returns: