Jump to content

Std LinkMakeGroup

From FreeCAD Documentation

Std LinkMakeGroup

Menu location
None
Workbenches
All
Default shortcut
None
Introduced in version
0.19
See also
Std Part, Std Group, PartDesign Body

Description[edit | edit source]

Std LinkMakeGroup creates a specialized container called a LinkGroup. Unlike a Std Group, a LinkGroup has its own coordinate system (Placement) and can manage the lifecycle of its contents through different modes. It is primarily used for organizing assemblies and managing complex object references.

Historical note[edit | edit source]

This command was originally envisaged for the Assembly 3 third-party workbench, and it was added to FreeCAD's core in v0.19 as part of the App Link introduction. As such, it predates the introduction of FreeCAD's built-in Assembly Workbench in v1.0. Thus some of Std LinkMakeGroup's features may no longer apply to building assemblies when using the Assembly workbench.

Usage[edit | edit source]

With selection[edit | edit source]

  1. Select one or more objects in the Tree View or 3D View.
  2. Right-click on the selection to display the context menu.
  3. Navigate to Link Actions → Link Group in the context menu.
  4. Select one of the options from the menu:
    • Simple Group: Creates an empty LinkGroup and moves the selected objects into it as-is. The DataLinkMode property is set to None.
    • Group With Links: Creates a new Link for every selected object and places these links inside the LinkGroup.
      • The original objects remain in their original location in the Tree View.
      • The DataPlacement of the original objects is copied to the new links so they appear in the same location.
      • The DataLinkMode property of the group is set to Auto Delete.
    • Group With Transform Links: Creates a new Link for every selected object and places them inside the LinkGroup.
      • The original objects remain in their original location in the Tree View.
      • The DataPlacement the original objects is not copied; all new links are reset to the origin (0,0,0).
      • The DataLinkMode property of the group is set to Auto Delete.
      • The DataLinkTransform property of each created link is set to True.

Without selection[edit | edit source]

  1. Right-click on an empty area, either on the Tree View panel or on the 3D View, to display the context menu.
  2. Navigate to Link Actions → Link Group in the context menu.
  3. Select an option from the menu:
    • Simple Group: Creates an empty LinkGroup. The DataLinkMode property is set to None.
    • Group With Links: Creates an empty LinkGroup. The DataLinkMode property is set to Auto Delete.
    • Group With Transform Links: Creates an empty LinkGroup. The DataLinkMode property is set to Auto Delete.

Notes[edit | edit source]

  • To add objects to a LinkGroup after its creation, drag and drop objects into the group in the Tree View.
  • In groups where DataLinkMode is set to Auto Delete, removing an object from the group or dragging it out of the folder will permanently delete that object from the document.
  • When DataLinkTransform is True, the link's DataPlacement becomes a read-only indicator (shown in green). To move the link, you must modify the (usually hidden) DataLink Placement property.

Properties[edit | edit source]

Data[edit | edit source]

Link

  • DataPlacement (Placement): Standard placement of the LinkGroup. Objects inside the group are positioned relative to this coordinate system. In other words, moving a LinkGroup moves all its contents in the 3D View.
  • DataLink Mode (Enumeration): Controls the automated behavior of the group when objects are added or removed:
    • None: The group acts as a simple container. Removing an object from the group does not affect the object's existence in the document.
    • Auto Delete: The group assumes ownership of its contents. If an object is removed from the DataElement List or dragged out of the group in the Tree View, the object is permanently deleted from the document.
    • Auto Link: If a document object is added to the group, the group automatically wraps it in an App Link.
    • Auto UnLink: A selective cleanup mode. It distinguishes between objects that the group created automatically (such as "helper links" generated via the Auto Link mode) and objects that the user manually moved into the group. It will only delete the objects it created itself; any "guest" objects the user added are preserved when they are removed from the group.
  • Data (Hidden)Element List (LinkList): An internal list of references to the document objects contained within the group.
  • Data (Hidden)Visibility List (BoolList): A boolean list that stores the visibility state of each item in the DataElement List. This allows the group to manage the visibility of its contents independently of the objects' own settings. To edit or view this property in the Property

View[edit | edit source]

Link

  • ViewDraw Style (Enumeration)
  • ViewLine Width (FloatConstraint)
  • ViewOverride Material (Bool): it defaults to false; if set to true it will override the DataLinked Object's material, and it will display the colors defined in ViewShape Material.
  • ViewPoint Size (FloatConstraint)
  • ViewSelectable (Bool)
  • ViewShape Material (Material)

Scripting[edit | edit source]

TBD.