Difference between revisions of "Tree view"

From FreeCAD Documentation
Jump to navigation Jump to search
Line 56: Line 56:
*** [[Std_LinkMakeGroup|Simple group]]
*** [[Std_LinkMakeGroup|Simple group]]
*** [[Std_LinkMakeGroup|Group with links]]
*** [[Std_LinkMakeGroup|Group with links]]
***[[Std_LinkMakeGroup|Group with transform links]].
***[[Std_LinkMakeGroup|Group with transform links]]
** [[Std_LinkMake|Make Link]].
** [[Std_LinkMake|Make Link]]
=== Selecting the document === <!--T:19-->
=== Selecting the document === <!--T:19-->

Revision as of 20:22, 25 October 2021

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎polski • ‎português do Brasil • ‎русский • ‎한국어


The tree view appears in the Model tab of the combo view, one of the most important panels in the interface; it shows all user defined objects that are part of a FreeCAD document. The tree view is a representation of the document's structure, and indicates what information is saved to disk.

These objects don't necessarily have to be geometrical shapes visible in the 3D view, but can also be supporting data objects created with any of the workbenches.

FreeCAD Tree view.png

The tree view showing various elements in the document.

Working with the tree view

By default, whenever a new object is created, it is added to the end of the list in the tree view. The tree view allows managing the objects to keep them organized; it permits creating groups, moving objects inside groups, moving groups inside other groups, renaming objects, copying objects, deleting objects, and other operations in the contextual menu (right click) which depend on the currently selected object and the currently active workbench.

Many operations create objects that are dependent on a previously existing object. In this case, the tree view shows this relationship by absorbing the older object inside the new object. Expanding and collapsing the objects in the tree view shows the parametric history of that object. Objects that are deeper inside others are older, while objects that are outside are newer, and are derived from the older objects. By modifying the interior objects, the parametric operations propagate all the way to the top, generating a new result.

FreeCAD Tree view parametric history 1.png FreeCAD Tree view parametric history 2.png

FreeCAD Tree view parametric history 3.png

The topmost object is created by doing parametric operations on objects which themselves were created by previous operations. Expanding the tree many levels reveals the original elements that were used to create the partial solids.


Note: expressions and link actions were added in version 0.19.

Since the tree view lists objects that may be visible in the 3D view, many of the actions are the same to those that can be executed from the 3D view.

When the application starts, the default Start Workbench is active, and no document has been created, right clicking on the tree view shows only one command:

Once a new document has been created the following become active:

In addition, Link actions are available.

Selecting the document

If you select the active document and right click, in addition to Expression actions and Link actions, the following commands appear:

  • Show hidden items: if active, the tree view will show hidden items.
  • Search: shows an input field to search objects inside the selected document.
  • Close document: closes the selected document by calling the application's closeDocument() method.
  • Skip recomputes: if active, the document's objects will not recompute automatically.
    • Allow partial recomputes: if active, the document will allow recompute of only some objects.
  • Mark to recompute: marks all objects of the document as touched, and ready for recompute.
  • Create group: creates a group in the selected document by using the document's addObject() method.

Selecting objects

Once objects are added to the document then in addition to the previous actions, right clicking on an empty part of the tree view will show additional commands; these depend on the type of object and the active workbench.

For example, with the Draft Workbench active, first select an object, then right click on an empty place in the tree view:

  • Toggle visibility: makes the object visible or invisible in the 3D view.
  • Show selection: makes the selected objects visible.
  • Hide selection: makes the selected objects invisible.
  • Toggle selectability: makes the object no longer selectable in the 3D view; use again this command to cancel its effect. It sets the object's Selectable attribute to true or false. Change the property by toggling ViewSelectable in the property editor.
  • Select all instances: selects all instances of this object in the tree view.
  • Appearance: launches the dialog to change color and sizes of lines and vertices, and color of faces.
  • Random color: assigns a random color to the object. It sets the object's ShapeColor attribute to a tuple (r,g,b) with tree random floats between 0 and 1. Change the property by modifying ViewShape Color in the property editor.
  • Cut: disabled if the right-click is not on the object.
  • Copy: copies an object into memory.
  • Paste: pastes the copied object into the document; the copy is added to the end of the tree view.
  • Delete: removes the object from the document, and from the tree view, by calling the document's removeObject() method.
  • Utilities: (optional) additional contextual commands provided by the Draft Workbench.

If an object is selected and a right click is made in the same object additional commands may be available:

  • Transform: launches the transform widget to move or rotate the object.
  • Set colors: sets the colors of the object.
  • Hide item: if active, the selected object will be set as hidden.
  • Add dependent objects to selections: introduced in version 0.20 all depedent objects will be added to the selection. This way one can see the dependencies and also e.g. delete all depending objects at once.
  • Mark to recompute: marks the selected object as touched, and ready for recompute.
  • Recompute: recomputes the selected object.
  • Rename: starts editing the name of the selected object. This allows changing the Label attribute, but not the Name attribute, as the latter is read-only.

Overlay icons

One or more smaller overlay icons can be displayed on top of an object's default icon in the tree view. The available overlay icons and their meaning are listed below. introduced in version 0.19

FreeCAD Tree view recompute.png White check mark on blue background

This indicates that the object has to be recomputed, due to changes made to the model or because the user marked the object in the tree view context menu to be recomputed. In most cases recomputes are triggered automatically, but sometimes they are delayed for performance reasons.

FreeCAD Tree view tip.png White arrow on green background

This indicates the so called Tip of a body. It is usually the last feature in a PartDesign Body and represents the whole body to the world outside of the body, e.g. when the body is exported or used in Part boolean operations. The tip can be changed by the user.

FreeCAD Tree view unattached.png Purple chain link on white background

This is typically shown for sketches, geometric primitives, such as box, cylinder, etc. and Datum geometry. It indicates that the object is not attached to anything. It has no Attachment Offset and gets its position and alignment solely from its Placement property.

There is a Basic Attachment Tutorial explaining how to handle such objects.

FreeCAD Tree view notfullyconstrained.png Yellow X

This is only used for sketches and indicates that the sketch is not fully constrained. Inside of Sketcher the number of remaining degrees of freedom is shown in the solver messages.

FreeCAD Tree view error.png White exclamation mark on red background

This indicates that the object has an error that needs to be fixed. After recomputing the whole document a tooltip describing the error is shown when you hover the mouse over the object in the tree view. Note: All other objects depending on an object in such an error state will not be properly recomputed, thus they may still show some old state.