Skip to content

Latest commit

 

History

History
199 lines (102 loc) · 12.2 KB

Part_Feature.md

File metadata and controls

199 lines (102 loc) · 12.2 KB
Raw

Part Feature

Introduction

A Part Feature object, or formally a Part::Feature, is a simple element with a topological shape that can be displayed in the 3D view.

The Part Feature is the parent class of most 2D (Draft, Sketcher) and 3D (Part, PartDesign) objects, with the exception of meshes, which are normally based on the Mesh Feature, or the FEM FemMeshObject for FEM objects.

Simplified diagram of the relationships between the core objects in FreeCAD

Usage

The Part Feature is an internal object, so it cannot be created from the graphical interface, only from the Python console as described in the Scripting section.

The Part::Feature is defined in the Part Workbench but can be used as the base class for scripted objects in all workbenches that produce 2D and 3D geometrical shapes. Essentially all objects produced in the Part Workbench are instances of a Part::Feature.

Part::Feature

is also the parent class of the PartDesign Body, of the PartDesign Features, and of the Part Part2DObject, which is specialized for 2D (planar) shapes.

Workbenches can add more properties to this basic element to produce an object with complex behavior.

Properties

See Property for all property types that scripted objects can have.

The Part Feature (Part::Feature class) is derived from the basic App GeoFeature (App::GeoFeature class) and inherits all its properties. It also has several additional properties. Notably a Shape property, which stores the Part TopoShape of the object. This is the geometry that is shown in the 3D view. Other properties that this object has are those related to the appearance of its TopoShape.

These are the properties available in the property editor. Hidden properties can be shown by using the Show all command in the context menu of the property editor.

Data

{{TitleProperty|Base}}

  • Proxy|PythonObject|Hidden: a custom class associated with this object. This only exists for the Python version. See Scripting.

  • Shape|PartShape|Hidden: a Part TopoShape class associated with this object.

  • Placement|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.

-   
    **Angle**
    
    : the angle of rotation around the **Axis**. By default, it is {{value|0°}} (zero degrees).

-   
    **Axis**
    
    : the unit vector that defines the axis of rotation for the placement. Each component is a floating point value between {{value|0}} and {{value|1}}. If any value is above {{value|1}}, the vector is normalized so that the magnitude of the vector is {{value|1}}. By default, it is the positive Z axis, {{value|(0, 0, 1)}}.

-   
    **Position**
    
    : a vector with the 3D coordinates of the base point. By default, it is the origin {{value|(0, 0, 0)}}.

  • Label|String: the user editable name of this object, it is an arbitrary UTF8 string.

  • Label2|String|Hidden: 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 {{value|""}}.

  • Expression Engine|ExpressionEngine|Hidden: a list of expressions. By default, it is empty {{value|[]}}.

  • Visibility|Bool|Hidden: whether to display the object or not.

View

Most objects in FreeCAD have what is called a "viewprovider", which is a class that defines the visual appearance of the object in the 3D view, and in the Tree view. The default viewprovider of Part Feature objects defines the following properties. Scripted objects that are derived from Part Feature will have access to these properties as well.

{{TitleProperty|Base}}

  • Proxy|PythonObject|hidden: a custom viewprovider class associated with this object. This only exists for the Python version. See Scripting.

{{TitleProperty|Display Options}}

  • Bounding Box|Bool: if it is True, the object will show the bounding box in the 3D view.

  • Display Mode|Enumeration: {{value|Flat Lines}} (regular visualization), {{value|Shaded}} (no edges), {{value|Wireframe}} (no faces), {{value|Points}} (only vertices).

  • Show In Tree|Bool: it defaults to True, in which case the object will appear in the Tree view; otherwise, the object will be hidden in the tree view. Once an object in the tree is invisible, you can see it again by opening the context menu over the name of the document (right-click), and selecting {{CheckBox|TRUE|Show hidden items}}. Then the hidden item can be chosen and Show In Tree can be switched back to True.

  • Visibility|Bool: if it is True, the object appears in the 3D view; otherwise it is invisible. By default this property can be toggled on and off by pressing the Space bar.

{{TitleProperty|Object style}}

  • Angular Deflection|Angle: it is a companion to Deviation. It is another way to specify how finely to generate the mesh for rendering on screen or when exporting. The default value is {{value|28.5 degrees}}, or {{value|0.5 radians}}. This is the maximum value, the smaller the value the smoother the appearance will be in the 3D view, and the finer the mesh that will be exported.

  • Deviation|FloatConstraint: it is a companion to Angular Deflection. It is another way to specify how finely to generate the mesh for rendering on screen or when exporting. The default value is {{value|0.5%}}. This is the maximum value, the smaller the value the smoother the appearance will be in the 3D view, and the finer the mesh that will be exported.

  • Diffuse Color|ColorList|hidden: it is a list of RGB tuples defining colors, similar to Shape Color. It defaults to a list of one {{value|[(0.8, 0.8, 0.8)]}}.

  • Draw Style|Enumeration: {{value|Solid}} (default), {{value|Dashed}}, {{value|Dotted}}, {{value|Dashdot}}; defines the style of the edges in the 3D view.

  • Lighting|Enumeration: {{value|Two side}} (default), {{value|One side}}; the illumination comes from two sides or one side in the 3D view.

  • Line Color|Color: a tuple of three floating point RGB values almost black .

  • Line Color Array|ColorList|hidden: it is a list of RGB tuples defining colors, similar to Line Color. It defaults to a list of one {{value|[(0.09, 0.09, 0.09)]}}.

  • Line Material|Material|hidden: an App Material associated with the edges in this object. By default it is empty.

  • Line Width|FloatConstraint: a float that determines the width in pixels of the edges in the 3D view. It defaults to {{value|2.0}}.

  • Point Color|Color: similar to Line Color, defines the color of the vertices.

  • Point Color Array|ColorList|hidden: it is a list of RGB tuples defining colors, similar to Point Color. It defaults to a list of one {{value|[(0.09, 0.09, 0.09)]}}.

  • Point Material|Material|hidden: an App Material associated with the vertices in this object. By default it is empty.

  • Point Size|FloatConstraint: similar to Line Width, defines the size of the vertices.

  • Shape Color|Color: similar to light gray.

  • Shape Material|Material|hidden: an App Material associated with this object. By default it is empty.

  • Transparency|Percent: an integer from {{value|0}} to {{value|100}} (a percentage) that determines the level of transparency of the faces in the 3D view. A value of {{value|100}} indicates completely invisible faces; the faces are invisible but they can still be picked as long as Selectable is True.

{{TitleProperty|Selection}}

  • On Top When Selected|Enumeration: it controls the way in which the selection occurs in the 3D view if the object has a Shape, and there are many objects partially covered by others. It defaults to {{value|Disabled}}, meaning that no special highlighting will occur; {{value|Enabled}} means that the object will appear on top of any other object when selected; {{value|Object}} means that the object will appear on top only if the entire object is selected in the Tree view; {{value|Element}} means that the object will appear on top only if a subelement (vertex, edge, face) is selected in the 3D view.

  • Selectable|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.

  • Selection Style|Enumeration: it controls the way the object is highlighted. If it is {{value|Shape}}, the entire shape (vertices, edges, and faces) will be highlighted in the 3D view; if it is {{value|BoundBox}} a bounding box will appear surrounding the object and will be highlighted.

Angular deflection and deviation

*Angular Deflection and deviation parameters; d < linear deflection, α < angular deflection.*

The deviation is a value in percentage that is related to the dimensions in millimeters of the bounding box of the object. The deviation in millimeters can be calculated as follows:

deviation_in_mm = (w + h + d)/3 * deviation/100

where {{value|w}}, {{value|h}}, {{value|d}} are the bounding box dimensions.

Scripting

See also:

FreeCAD Scripting Basics and scripted objects.

A Part Feature is created with the addObject() method of the document.

import FreeCAD as App

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

For Python subclassing, you should create a Part::FeaturePython object.

import FreeCAD as App

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

Name

See also: Object name for more information on the properties of the Name.

The addObject method has two basic string arguments.

  • The first argument indicates the type of object, in this case, "Part::FeaturePython".
  • The second argument is a string that defines the Name attribute. If it is not provided, it defaults to the same name as the class, that is, "Part__FeaturePython". The Name can only include simple alphanumeric characters, and the underscore, [_0-9a-zA-Z]. If other symbols are given, these will be converted to underscores; for example, "A+B:C*" is converted to "A_B_C_".

Label

If desired, the Label attribute can be changed to a more meaningful text.

  • The Label can accept any UTF8 string, including accents and spaces. Since the Tree view displays the Label, it is a good practice to change the Label to a more descriptive string.
  • By default the Label is unique, just like the Name. However, this behavior can be changed in the preferences editor, Edit → Preferences → General → Document → Allow duplicate object labels in one document. This means that in general the Label may be repeated in the same document; when testing for a specific element the user should rely on the Name rather than on the Label.

{{Document_objects_navi}}

⏵ documentation index > Part > Part Feature