App GeoFeature

From FreeCAD Documentation
Revision as of 15:13, 18 April 2024 by FBXL5 (talk | contribs) (Created page with "{{Emphasis|Siehe auch:}} FreeCAD Grundlagen Skripten und Skriptgenerierte Objekte.")

Einleitung

Ein App-GeoFeature-Objekt, oder formal ein App::GeoFeature, ist die Basisklasse der meisten Objekte, die geometrische Elemente in der 3D-Ansicht anzeigen, da es eine Daten-EigenschaftPlacement enthält.

Vereinfachtes Diagramm der Beziehungen zwischen den Kernobjekten in FreeCAD

Anwendung

Das App GeoFeature ist ein internes Objekt; es kann daher nicht von der grafischen Oberfläche aus erstellt werden. Es ist generell nicht dafür vorgesehen, direkt eingesetzt zu werden, eher zum Ableiten einer Unterklasse für ein nacktes Objekt, das nur eine grundlegende Daten-EigenschaftPlacement enthält, die seine Position in der 3D-Ansicht festlegt.

Einige der wichtigsten abgeleiteten Objekte sind folgende:

  • Die Part-Formelement-Klasse (Part Feature class), übergeordnete Klasse der meisten Objekte mit 2D und 3D TopoFormen.
  • Die Mesh-Formelement-Klasse (Mesh Feature class), übergeordnete Klasse der meisten von Netzobjekten abgeleiteten Objekte; keine Festkörper.
  • Die FEM-Netzobjekt-Klasse (FEM FemMeshObject class), übergeordnete Klasse der FEM-Netze, die mit dem Arbeitsbereich FEM erstellt wurden.
  • Die CAM-Element-Klasse (CAM Feature class), übergeordnete Klasse der Werkzeugbahnen (paths), die mit dem Arbeitsbereich CAM für CNC-Bearbeitungen erstellt wurden.
  • Die App-Part-Klasse (App Part class), die Std-Parts definiert, die als Behälter von Körpern eingesetzt werden, um Baugruppen zusammenzustellen.

Wird dieses Objekt mit Python erstellt, sollte anstatt eine Unterklasse von App::GeoFeature abzuleiten, eine Unterklasse von App::GeometryPython abgeleitet werden, da letztere einen Standard-Viewprovider enthält sowie Proxy-Attribute für das Objekt selbst und seinen Viewprovider. Siehe Skripten.

Eigenschaften eines App-GeoFeature-Objekts

Siehe Objekteigenschaften für alle Arten von Eigenschaften, die skriptgenerierte Objekte besitzen können.

Das Objekt App GeoFeature (Klasse App::GeoFeature) ist von dem grundlegenden App DocumentObject (Klasse App::DocumentObject) abgeleitet und erbt alle seine Eigenschaften. Zusätzlich besitzt es eine Daten-EigenschaftPlacement, die seine Position in der 3D-Ansicht bestimmt.

Eigenschaften eines App-GeometryPython-Objekts

Siehe Objekteigenschaften für alle Arten von Eigenschaften, die skriptgenerierte Objekte besitzen können.

Das Objekt App GeometryPython (Klasse App::GeometryPython) wird von einem App GeoFeature (Klasse App::GeoFeature) abgeleitet und erbt alle seine Eigenschaften. Es besitzt einige zusätzliche Eigenschaften.

Diese sind die im Eigenschafteneditor vorhandenen Eigenschaften. Ausgeblendete Eigenschaften können mit dem Befehl Alle anzeigen im Kontextmenü des Eigenschafteneditors angezeigt werden.

Daten

Basis

  • Daten (Hidden)Proxy (PythonObject): a custom class associated with this object.
  • DatenPlacement (Placement): the position of the object in the 3D view. The placement is defined by a Base point (vector), and a Rotation (axis and angle). See Placement.
    • DatenAngle: the angle of rotation around the DatenAxis. By default, it is (zero degrees).
    • DatenAxis: the unit vector that defines the axis of rotation for the placement. Each component is a floating point value between 0 and 1. If any value is above 1, the vector is normalized so that the magnitude of the vector is 1. By default, it is the positive Z axis, (0, 0, 1).
    • DatenPosition: a vector with the 3D coordinates of the base point. By default, it is the origin (0, 0, 0).
  • DatenLabel (String): the user editable name of this object, it is an arbitrary UTF8 string.
  • Daten (Hidden)Label2 (String): a longer, user editable description of this object, it is an arbitrary UTF8 string that may include newlines. By default, it is an empty string "".
  • Daten (Hidden)Expression Engine (ExpressionEngine): a list of expressions. By default, it is empty [].
  • Daten (Hidden)Visibility (Bool): whether to display the object or not.

Ansicht

Base

  • Ansicht (Hidden)Proxy (PythonObject): a custom viewprovider class associated with this object.

Display Options

  • AnsichtBounding Box (Bool): if it is true, the object will show the bounding box in the 3D view.
  • AnsichtDisplay Mode (Enumeration): see the information in App FeaturePython.
  • AnsichtShow In Tree (Bool): see the information in App FeaturePython.
  • AnsichtVisibility (Bool): see the information in App FeaturePython.

Object Style

  • AnsichtShape Color (Color): a tuple of three floating point RGB values (r,g,b) to define the color of the faces in the 3D view; by default it is (0.8, 0.8, 0.8), which is displayed as [204, 204, 204] on base 255, a light gray .
  • Ansicht (Hidden)Shape Material (Material): an App Material associated with this object. By default it is empty.
  • AnsichtTransparency (Percent): an integer from 0 to 100 that determines the level of transparency of the faces in the 3D view. A value of 100 indicates completely invisible faces; the faces are invisible but they can still be picked as long as AnsichtSelectable is true.

Selection

  • AnsichtOn Top When Selected (Enumeration): see the information in App FeaturePython.
  • AnsichtSelectable (Bool): if it is true, the object can be picked with the pointer in the 3D view. Otherwise, the object cannot be selected until this option is set to true.
  • AnsichtSelection Style (Enumeration): see the information in App FeaturePython.

Skripten

Siehe auch: FreeCAD Grundlagen Skripten und Skriptgenerierte Objekte.

See Part Feature for the general information on adding objects to the document.

A GeoFeature is created with the addObject() method of the document. If you would like to create an object with a 2D or 3D topological shape, it may be better to create one of the sub-classes specialized for handling shapes, for example Part Feature or Part Part2DObject.

import FreeCAD as App

doc = App.newDocument()
obj = App.ActiveDocument.addObject("App::GeoFeature", "Name")
obj.Label = "Custom label"

For Python subclassing you should create the App::GeometryPython object.

import FreeCAD as App

doc = App.newDocument()
obj = App.ActiveDocument.addObject("App::GeometryPython", "Name")
obj.Label = "Custom label"