LabRPS: Created page with "{{Docnav |Part |LinkMake |Std Base |IconL=Std_Part.svg |IconR=Std_LinkMake.svg |IconC=Labrps.svg }} {{GuiCommand |Name=Std Group |MenuLocation=Tree view → Right click on the document name → Create group |Phenomena=All |Shortcut= |Version= |SeeAlso=Std Part }} ==Description== Std Group (internally called App DocumentObjectGroup) is a general purpose cont..."

2024-07-25T20:00:42Z

Created page with "{{Docnav |Part |LinkMake |Std Base |IconL=Std_Part.svg |IconR=Std_LinkMake.svg |IconC=Labrps.svg }} {{GuiCommand |Name=Std Group |MenuLocation=Tree view → Right click on the document name → Create group |Phenomena=All |Shortcut= |Version= |SeeAlso=Std Part }} ==Description== Std Group (internally called App DocumentObjectGroup) is a general purpose cont..."

New page

{{Docnav
|[[Std_Part|Part]]
|[[Std_LinkMake|LinkMake]]
|[[Std_Base|Std Base]]
|IconL=Std_Part.svg
|IconR=Std_LinkMake.svg
|IconC=Labrps.svg
}}

{{GuiCommand
|Name=Std Group
|MenuLocation=[[Tree_view|Tree view]] → Right click on the document name → Create group
|Phenomena=All
|Shortcut=
|Version=
|SeeAlso=[[Std_Part|Std Part]]
}}

==Description==

[[Std_Group|Std Group]] (internally called [[App_DocumentObjectGroup|App DocumentObjectGroup]]) is a general purpose container that allows you to group different types of objects in the [[Tree_view|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 {{MenuCommand|structure toolbar}} that is available in all [[Workbenches|workbenches]].

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

[[File:Std_Group_example.png]]

{{Caption|Various elements inside Std Groups in the tree view.}}

==Usage==

# Do one of the following:
#* Right-click the name of the document in the [[Tree_view|Tree view]] and in the context menu choose {{MenuCommand|Create group...}}.
#* Press the {{Button|[[Image:Std_Group.svg|16px]] [[Std_Group|Create group]]}} button.
# An empty Group is created.
# To add objects to the Group, select them in [[Tree_view|Tree view]], and drag and drop them onto the Group.
# To remove objects from the Group, drag them out of the Group, and onto the document label at the top of the [[Tree_view|Tree view]].
# Objects can also be added and removed by editing the {{PropertyData|Group}} property of the Group.

==Properties==

The [[Std_Group|Std Group]], internally called [[App_DocumentObjectGroup|App DocumentObjectGroup]] ({{incode|App::DocumentObjectGroup}} class), is derived from the basic [[App_DocumentObject|App DocumentObject]] ({{incode|App::DocumentObject}} class) and inherits all its properties.

The Std Group has the same properties as the [[App_FeaturePython#Properties|App FeaturePython]], which is the most basic instance of an [[App_DocumentObject|App DocumentObject]]. It also has the following additional properties in the [[Property_editor|property editor]]. Hidden properties can be shown by using the {{MenuCommand|Show all}} command in the context menu of the [[Property_editor|property editor]].

=== Data ===

{{TitleProperty|Base}}

* {{PropertyData|Group|LinkList}}: a list of referenced objects. By default, it is empty {{value|[]}}.
* {{PropertyData|_ Group Touched|Bool|Hidden}}: whether the group is touched or not.

==Scripting==

{{Emphasis|See also:}} [[LabRPS_Scripting_Basics|LabRPS Scripting Basics]] and [[Scripted_objects|scripted objects]].

See [[Part_Feature|Part Feature]] for the general information on adding objects to the document.

A Std Group ([[App_DocumentObjectGroup|App DocumentObjectGroup]]) is created with the {{incode|addObject()}} method of the document. Once a Group exists, other objects can be added to it with the {{incode|addObject()}} or {{incode|addObjects()}} methods.

{{Code|code=
import LabRPS as App

doc = App.newDocument()
group = App.ActiveDocument.addObject("App::DocumentObjectGroup", "Group")

obj1 = App.ActiveDocument.addObject("Part::Box", "Box1")
obj2 = App.ActiveDocument.addObject("Part::Box", "Box2")

group.addObjects([obj1, obj2])
App.ActiveDocument.recompute()
}}

This basic {{incode|App::DocumentObjectGroup}} doesn't have a Proxy object so it can't be fully used for sub-classing.

For [[Python|Python]] subclassing you should create a {{incode|App::DocumentObjectGroupPython}} object.

{{Code|code=
import LabRPS as App

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

{{Docnav
|[[Std_Part|Part]]
|[[Std_LinkMake|LinkMake]]
|[[Std_Base|Std Base]]
|IconL=Std_Part.svg
|IconR=Std_LinkMake.svg
|IconC=Labrps.svg
}}

{{Std_Base_navi}}
{{Userdocnavi}}

Std Group - Revision history