Std Group

Description
Std Group (internally called App DocumentObjectGroup) is a general purpose container that allows you to group different types of objects in the tree view, regardless of their data type. It is used as a simple folder to categorize and organize the objects in your model, in order to keep a logical structure. Std Groups may be nested inside other Std Groups.

The Std Group tool is not defined by a particular workbench, but by the base system, thus it is found in the that is available in all workbenches.

To group 3D objects as a single unit, with the intention of creating assemblies, use Std Part instead.



Usage

 * 1) Click on the name of the document in the tree view, open the context menu (right click), and choose.
 * 2) Alternatively, press the  button in the structure toolbar. An empty Group is created.
 * 3) To add objects to a Group, select them in tree view, and then drag and drop them over the Group.
 * 4) To remove objects from a Group, drag them out of the Group, and onto the document label at the top of the tree view.

Properties
The Std Group, internally called App DocumentObjectGroup ( class), is derived from the basic App DocumentObject ( class) and inherits all its properties.

The Std Group has the same properties as the App FeaturePython, which is the most basic instance of an App DocumentObject. It also has the following additional properties in the property editor. Hidden properties can be shown by using the command in the context menu of the property editor.

Data

 * : a list of referenced objects. By default, it is empty.
 * : whether the group is touched or not.

Inheritance
A Std Group is formally an instance of the class, whose parent is the basic App DocumentObject ( class), and is augmented with a Group extension.



Scripting
See also: FreeCAD Scripting Basics and scripted objects.

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

A Std Group (App DocumentObjectGroup) is created with the method of the document. Once a Group exists, other objects can be added to it with the or  methods.

This basic doesn't have a Proxy object so it can't be fully used for sub-classing.

For Python subclassing you should create a object.

For example, a FEM Analysis is an object with a custom icon and additional properties.

Links

 * Use case in Arch Tutorial
 * Document structure
 * Organizing your model