Draft AutoGroup: Difference between revisions

From FreeCAD Documentation
(Image caption; translate tags in correct location)
(Marked this version for translation)
Line 13: Line 13:
The AutoGroup tool sets a selected [[Std Group]], or a related element like a [[Draft VisGroup|Draft VisGroup]], [[Arch Site|Arch Site]], [[Arch Building|Arch Building]] or [[Arch BuildingPart|Arch BuildingPart]], as the active auto-group. When an auto-group is set, new objects will be automatically moved to the indicated group upon being created.
The AutoGroup tool sets a selected [[Std Group]], or a related element like a [[Draft VisGroup|Draft VisGroup]], [[Arch Site|Arch Site]], [[Arch Building|Arch Building]] or [[Arch BuildingPart|Arch BuildingPart]], as the active auto-group. When an auto-group is set, new objects will be automatically moved to the indicated group upon being created.


<!--T:8-->
Auto-grouping works with elements created with the [[Draft Workbench|Draft]] and [[Arch Workbench|Arch Workbenches]].
Auto-grouping works with elements created with the [[Draft Workbench|Draft]] and [[Arch Workbench|Arch Workbenches]].


Line 18: Line 19:
[[Image:Draft_AutoGroup_example.png]]
[[Image:Draft_AutoGroup_example.png]]
<translate>
<translate>
<!--T:9-->
{{Caption|Draft Tray which sets the active auto-group by clicking on the folder icon and choosing a group}}
{{Caption|Draft Tray which sets the active auto-group by clicking on the folder icon and choosing a group}}


Line 35: Line 37:
== Scripting == <!--T:6-->
== Scripting == <!--T:6-->


<!--T:10-->
{{Emphasis|See also:}} [[Draft API]] and [[FreeCAD Scripting Basics]].
{{Emphasis|See also:}} [[Draft API]] and [[FreeCAD Scripting Basics]].


Line 44: Line 47:
}}
}}
<translate>
<translate>
<!--T:11-->
* Puts the {{incode|obj}} element in the current auto-group.
* Puts the {{incode|obj}} element in the current auto-group.
* If auto-grouping is disabled (the group is {{incode|None}}), or if [[Draft_ToggleConstructionMode|Construction mode]] is active, or if {{incode|obj}} is already in the auto-group, the function doesn't do anything.
* If auto-grouping is disabled (the group is {{incode|None}}), or if [[Draft_ToggleConstructionMode|Construction mode]] is active, or if {{incode|obj}} is already in the auto-group, the function doesn't do anything.
Line 49: Line 53:
* The function only does something if the graphical interface is active, as the auto-group can only be chosen from the graphical interface.
* The function only does something if the graphical interface is active, as the auto-group can only be chosen from the graphical interface.


<!--T:12-->
Example:
Example:
</translate>
</translate>
Line 68: Line 73:
<translate>
<translate>


<!--T:13-->
{{Draft Tools navi}}
{{Draft Tools navi}}
{{Userdocnavi}}
{{Userdocnavi}}

Revision as of 13:12, 8 January 2019

Other languages:

Draft AutoGroup

Menu location
Draft → Utilities → AutoGroup
Workbenches
Draft, Arch
Default shortcut
None
Introduced in version
0.17
See also
Std Group, Draft VisGroup

Description

The AutoGroup tool sets a selected Std Group, or a related element like a Draft VisGroup, Arch Site, Arch Building or Arch BuildingPart, as the active auto-group. When an auto-group is set, new objects will be automatically moved to the indicated group upon being created.

Auto-grouping works with elements created with the Draft and Arch Workbenches.

File:Draft AutoGroup example.png

Draft Tray which sets the active auto-group by clicking on the folder icon and choosing a group

How to use

  1. Select a Std Group, Construction group, or File:Draft VisGroup.png Draft VisGroup in the tree view.
  2. Press the None button, or go to the menu Draft → Utilities → AutoGroup. If no group is selected, a drop-down menu will display eligible groups to use, or "None".
  3. The button will change with the name of the active auto-group, for example, Group.

Notes:

  • The AutoGroup button is present in the Draft Tray toolbar, which only appears in the Draft and Arch Workbenches.
  • At least one of Std Group, Construction group, or File:Draft VisGroup.png Draft VisGroup must exist before using this tool.
  • To change the auto-group, select another group in the tree view and click Group. If no group is selected you have the option of choosing "None" to turn off auto-grouping.
  • When auto-grouping is active, new Draft and Arch objects will be placed in that group except when Construction mode is on, in which case the new geometry will be placed in the Construction group.
  • Auto-grouping only works for objects created from the graphical user interface; objects created programmatically by macros or the Python console aren't automatically placed in groups. The user always has the possibility of programmatically doing the grouping, regardless of the auto-grouping settings.

Scripting

See also: Draft API and FreeCAD Scripting Basics.

Adding objects to the active auto-group can be done in macros and from the Python console by using the following function: 

autogroup(obj)
  • Puts the obj element in the current auto-group.
  • If auto-grouping is disabled (the group is None), or if Construction mode is active, or if obj is already in the auto-group, the function doesn't do anything.
  • The function will fail if obj is already in another group that is different from the auto-group.
  • The function only does something if the graphical interface is active, as the auto-group can only be chosen from the graphical interface.

Example: 

import FreeCAD, Draft

Polygon1 = Draft.makePolygon(3, 500)
Polygon2 = Draft.makePolygon(3, 1000)
Polygon3 = Draft.makePolygon(5, 1500)

FreeCAD.ActiveDocument.addObject("App::DocumentObjectGroup", "Group") 

# Use the graphical interface to set "Group" for auto-grouping

Draft.autogroup(Polygon1)
Draft.autogroup(Polygon2)
Draft.autogroup(Polygon3)
Draft
User documentation
Retrieved from "http://wiki.freecad.org/index.php?title=Draft_AutoGroup&oldid=396473"