GuiCommand: Name: Std Part MenuLocation: None Workbenches: All Version: 0.17 SeeAlso: Std_Group, PartDesign_Body
Std Part
Description
[
Std Part
(internally called App Part) is a general purpose container that keeps together a group of objects so that they can be moved together as a unit in the 3D view.
The Std Part element was developed to be the basic building block to create mechanical assemblies. In particular, it is meant to arrange objects that have a Part TopoShape, like Part Primitives, PartDesign Bodies, and other Part Features. The Std Part provides an Origin object with local X, Y, and Z axes, and standard planes, that can be used as reference to position the contained objects. In addition, Std Parts may be nested inside other Std Parts to create a big assembly from smaller sub-assemblies.
Although it is primarily intended for solid bodies, the Std Part can be used to manage any object that has a Placement property, so it can also contain Mesh Features, sketches, and other objects derived from the App GeoFeature class.
Do not confuse the [
PartDesign Body with the [ Std Part. The first one is a specific object used in the 
PartDesign Workbench, intended to model a single contiguous solid by means of PartDesign Features. On the other hand, the Std Part is not used for modelling, just to arrange different objects in space, with the intention to create assemblies.
The [ Std Part tool is not defined by a particular workbench, but by the base system, thus it is found in the structure toolbar that is available in all workbenches. To group objects arbitrarily without considering their position, use [
Std Group; this object does not affect the placements of the elements that it contains, it is essentially just a folder that is used to keep the Tree view organized.
Left: elements inside a Std Part in the Tree view. Right: objects positioned in space, referred to the Origin of the Std Part.
Usage
- Press the [ Create part button.
- An empty Part is created and automatically becomes active.
- To add objects to the Part, select them in Tree view, and drag and drop them onto the Part.
- To remove objects from the Part, drag them out of the Part, and onto the document label at the top of the Tree view.
- Objects can also be added and removed by editing the Group property of the Part.
Notes
- An object can only belong to a single Part.
- 3D operations like Part Boolean cannot be applied to Parts. For example, you cannot select two Parts, and perform a Part Fuse or Part Cut.
Properties
The Std Part, internally called App Part (App::Part class), is derived from the App GeoFeature (App::GeoFeature class) and inherits all its properties. It also has several additional properties. Notably properties that help it manage information in the context of an assembly, for example, Type, Id, License, LicenseURL and Group.
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}}
-
Type|String: a description for this object. By default, it is an empty string {{value|""}}.
-
Material|Link: the material for this object.
-
Meta|Map|Hidden: map with additional meta information. By default, it is empty {}.
-
Id|String: an identification or part number for this object. By default, it is an empty string {{value|""}}.
-
Uid|UUID|Hidden: the universally unique identifier (UUID) (128-bit number) of the object. This is assigned at creation time.
-
License|String: a field to specify the license for this object. By default, it is an empty string {{value|""}}.
-
LicenseURL|String: a field to specify the web address to the license or contract for this object. By default, it is an empty string {{value|""}}.
-
Color|Color: a tuple of four floating point RGBA values white color.
-
Placement|Placement: the position of the object in the 3D view. The placement is defined by a
Basepoint (vector), and aRotation(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.
-
Origin|Link|Hidden: the App Origin object that is the positional reference for all elements listed in Group.
-
Group|LinkList: a list of referenced objects. By default, it is empty {{value|[]}}.
-
_ Group Touched|Bool|Hidden: whether the group is touched or not.
View
{{TitleProperty|Display Options}}
-
Display Mode|Enumeration: {{value|Group}}.
-
Show In Tree|Bool: if it is
True, the object appears in the Tree view. Otherwise, it is set as invisible. -
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 in the keyboard.
{{TitleProperty|Selection}}
-
On Top When Selected|Enumeration: {{value|Disabled}} (default), {{value|Enabled}}, {{value|Object}}, {{value|Element}}.
-
Selection Style|Enumeration: {{value|Shape}} (default), {{value|BoundBox}}. If the option is {{value|Shape}}, the entire shape (vertices, edges, and faces) will be highlighted in the 3D view; if it is {{value|BoundBox}} only the bounding box will be highlighted.
Detailed explanation
Active status
An open document can contain multiple Parts. But only one Part can be active. The active Part is displayed in the tree view with the background color specified by the Active container value in the preferences editor (by default, light blue). It will also be shown with bold text.
To activate or de-activate a Part:
- Double click on it on the Tree view, or
- Open the context menu (right click) and select Active object.
Document with two Std Parts, of which the second one is active.
Origin
The Origin consists of the three standard axes (X, Y, Z) and three standard planes (XY, XZ and YZ). Sketches and other objects can be attached to these elements when creating them.
Left: Part Origin in the Tree view. Right: representation of the Origin elements in the 3D view.
Note:
the Origin is an App Origin object (App::Origin class), while the axes and planes are objects of type App::Line and App::Plane respectively. Each of these elements can be hidden and unhidden individually with the Space bar; this is useful to choose the correct reference when creating other objects.
Note 2:
all elements inside the Part are referenced to the Part\'s Origin which means that the Part can be moved and rotated in reference to the global coordinate system without affecting the placement of the elements inside.
Visibility Management
The Part\'s visibility supersedes the visibility of any object it contains. If the Part is hidden, the objects it contains will be hidden as well, even if their individual Visibility property is set to True. If the Part is visible, then each object\'s Visibility determines whether the object is shown or not.
The visibility of the Std Part determines whether the objects grouped under it are shown in the 3D view or not. Left: the Part is hidden, so none of the objects will be shown in the 3D view. Right: the Part is visible, so each object controls its own visibility.
Scripting
See also:
FreeCAD Scripting Basics and scripted objects.
See Part Feature for the general information on adding objects to the document.
A Std Part (App Part) is created with the addObject() method of the document. Once a Part exists, other objects can be added to it with the addObject() or addObjects() methods.
import FreeCAD as App
doc = App.newDocument()
part = App.ActiveDocument.addObject("App::Part", "Part")
obj1 = App.ActiveDocument.addObject("PartDesign::Body", "Body")
obj2 = App.ActiveDocument.addObject("Part::Box", "Box")
part.addObjects([obj1, obj2])
App.ActiveDocument.recompute()You cannot create a scripted App::Part. However, you can add App::Part behavior to a scripted Part::FeaturePython object by using the following code:
class MyGroup(object):
def __init__(self, obj=None):
self.Object = obj
if obj:
self.attach(obj)
def dumps(self):
return
def loads(self, _state):
return
def attach(self, obj):
obj.addExtension("App::OriginGroupExtensionPython")
obj.Origin = FreeCAD.ActiveDocument.addObject("App::Origin", "Origin")
def onDocumentRestored(self, obj):
self.Object = obj
class ViewProviderMyGroup(object):
def __init__(self, vobj=None):
if vobj:
vobj.Proxy = self
self.attach(vobj)
else:
self.ViewObject = None
def attach(self, vobj):
vobj.addExtension("Gui::ViewProviderOriginGroupExtensionPython")
self.ViewObject = vobj
def dumps(self):
return None
def loads(self, _state):
return None
App.ActiveDocument.addObject("Part::FeaturePython",
"Group",
MyGroup(),
ViewProviderMyGroup(),
True)⏵ documentation index > Std Part
This page is retrieved from https://github.com/FreeCAD/FreeCAD-documentation/blob/main/wiki/Std_Part.md