Std DependencyGraph: Difference between revisions

From FreeCAD Documentation
(Marked this version for translation)
(34 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<languages/>
<div id="itsfree" style="text-align:center; background:#FDE0A8;margin:1em 7em;padding:0.5em 2em;border:2px solid #FF5706;">
<translate>
<!--T:1-->
{{GuiCommand
|Name=Std DependencyGraph
|MenuLocation=[[Std Tools Menu|Tools]] → Dependency graph...
|Workbenches=All
}}


This documentation is not finished. Please help and contribute documentation.


== Description == <!--T:6-->
See [[Std ViewScreenShot]] for good documented Command. [[Gui Command]] gives an overview over commands. And see [[List of Commands]] for other commands.


<!--T:7-->
Go to the [http://www.freecadweb.org/wiki/index.php?title=Main_Page FreeCAD Wiki] to contribute.
The '''Dependency graph''' displays the dependencies between objects in the active document as a graph. As opposed to the Model tree, objects are listed in reverse chronological order, with the first created object at the bottom.


<!--T:18-->
</div>
It can be useful in analyzing a FreeCAD document and locating forks in a tree. The dependency graph layout will depend on which workbench was used to create the objects in the document. For example, in FreeCAD 0.16, a model exclusively made in the PartDesign workbench should display a linear dependency graph with a single vertical branch. A model made with Part operations will have many branches, but for a single part they will join up at the top after Boolean operations. If they don't, it means that they are separate objects.


<!--T:19-->
Tools -> Dependency graph...
The dependency graph is purely a visualization tool, therefore it cannot be edited; it automatically updates if changes are made to the model.


<!--T:8-->
[[Image:DependencyGraph1.png|DependencyGraph1.png]]
[[Image:DependencyGraph1.png|DependencyGraph1.png]]
{{clear}}
{{clear}}
<br>
==Installation==


==Installation== <!--T:9-->
'''Ubuntu Linux:''' You just need to install the graphviz package from the Ubuntu repositories.<br>
To use the Dependency graph, a third-party software named [http://graphviz.org/ Graphviz] needs to be installed first. If you do not have it pre-installed or it is installed in an unconventional location, FreeCAD will display the following dialogue:
'''Windows:''' See http://graphviz.org/


<!--T:30-->
'''Mac/OSX:'''<br>
[[File:FreeCAD-0.17-missing-Graphviz-error-dialogue.png]]
You can install graphviz using brew:
$ brew install graphviz
This installs the graphviz binaries under /usr/local/bin. Unfortunately we can't navigate there from the file dialog that comes up from FreeCAD->Tools->Dependency graph. So let's create a link to /usr/local/bin in our home directory:
$ ln -s /usr/local/bin ~/
Now when asked to select the graphviz install directory go to your home directory and select "bin".


===Windows=== <!--T:15-->
Download the '''graphviz-2.xx.msi''' installer from the [https://graphviz.gitlab.io/_pages/Download/Download_windows.html Graphviz Download page] and launch it to install it.


===Mac/OSX=== <!--T:11-->
[[Category:User Documentation]]
You can install graphviz using [https://brew.sh/ Homebrew]:
[[Category:Command_Reference]]
</translate>
{{Code|code=
brew install graphviz
}}
<translate>
<!--T:12-->
This installs the graphviz binaries under /usr/local/bin. Unfortunately we can't navigate directly there from the file dialog that comes up from FreeCAD → Tools → Dependency graph.
When you get the file selection dialog use the keys Cmd+Shift+G to get an input field for the path. Enter
</translate>
{{Code|code=
/usr/local/bin
}}
<translate>
<!--T:13-->
and confirm the input field and the file selection dialog.

<!--T:21-->
In case the Graphviz binaries are installed in a non-standard location try to find the program with the command
</translate>
{{Code|code=
type dot
}}
<translate>
<!--T:22-->
It will output something like
</translate>
{{Code|code=
dot is /usr/local/bin/dot
}}
<translate>
<!--T:23-->
And therefore you can tell FreeCAD to look in that directory.

===Linux=== <!--T:10-->
On most Linux distributions (Debian/Ubuntu, Fedora, OpenSUSE), you just need to install the graphviz package from the repositories. However, similarly to MacOSX, in cases where the Graphviz binaries are installed in a non-standard location, try to find the program with the command:
</translate>
{{Code|code=
type dot
}}
<translate>
<!--T:24-->
It may output something like
</translate>
{{Code|code=
dot is /usr/local/bin/dot
}}
<translate>
<!--T:25-->
And therefore you can point FreeCAD to look in that directory.

==Configuration== <!--T:16-->
You shouldn't need any configuration of FreeCAD preferences. If FreeCAD cannot find the utility "dot" (from the Graphviz package) then a dialog comes up and asks the user for its path: set the path to the folder that contains the "dot" executable, do not select the executable itself. FreeCAD then tries to start the utility again and in case it succeeds the value is written automatically to the user parameters.

==How to use== <!--T:20-->
# Go to the '''Tools → Dependency graph...''' menu
# A new tab titled '''Dependency graph''' opens over the main area of the FreeCAD window.
# Use the mouse scroll wheel to zoom in / zoom out.
# Use the horizontal slider at the bottom of the screen to pan the view sideways.

==Save/Export== <!--T:17-->
You can save/export the displayed dependency graph as an image file. While the Dependency graph tab is in the foreground:
* Just choose '''File''' → [[Std_SaveAs|Save As]] to save the graph as a picture (PNG/BMP/GIF/JPG), a vector graphic (SVG) or as a PDF document.
* '''File''' → [[Std_Export|Export]] or '''Tools''' → [[Std ViewScreenShot|Save picture]] will '''NOT''' work.

==General principles== <!--T:26-->

<!--T:27-->
* The graph shows objects in reverse chronological order, from the bottom to the top.
* The direction of arrows showing dependencies should always point down, from the child object to the parent object. An arrow pointing up indicates a cyclic dependency, an issue that needs to be resolved.
* A sketch that contains links to [[Sketcher External|external geometry]] will have a number with an "x" suffix besides the arrow linking it to its parent, showing the number of external geometry linked in the sketch.
* Objects can have dependencies to multiple parents. For example, for a model built in PartDesign, a Pocket may be linked to its Sketch and to the Pad feature that came before it.
* Disallowed dependencies (for example, between a Draft/Part operation and an element inside a [[PartDesign Body]]) will show with a red arrow. This type of link usually shows a "Links go out of allowed scope" error in the report view.
* [[Std Part|Part container]] and [[PartDesign Body|PartDesign Body]] enclose their content inside a frame with a randomly colored background. Their Origin also enclose their content (standard planes and axes) in a frame.
* [[Std Group|Group]] is displayed as a single element linked to its content.

==Limitations== <!--T:28-->

<!--T:29-->
* The dependency graph cannot help with issues caused by [[Glossary#Topological Naming|topological naming]]. If a sketch switches faces of a feature after an edit, it is still linked to the feature; even if some features are broken, the dependency graph will remain unchanged.
* A bug in v0.17/v0.18 causes a Body to disappear from the graph and its content to disseminate if a Part or Draft object is created from the Body. This otherwise does not affect the model.

<!--T:31-->
{{Std Base}}
{{Userdocnavi}}
</translate>
{{clear}}
{{clear}}
{{languages | {{it|Std_DependencyGraph/it}} }}

Revision as of 20:00, 21 October 2019

Std DependencyGraph

Menu location
Tools → Dependency graph...
Workbenches
All
Default shortcut
None
Introduced in version
-
See also
None


Description

The Dependency graph displays the dependencies between objects in the active document as a graph. As opposed to the Model tree, objects are listed in reverse chronological order, with the first created object at the bottom.

It can be useful in analyzing a FreeCAD document and locating forks in a tree. The dependency graph layout will depend on which workbench was used to create the objects in the document. For example, in FreeCAD 0.16, a model exclusively made in the PartDesign workbench should display a linear dependency graph with a single vertical branch. A model made with Part operations will have many branches, but for a single part they will join up at the top after Boolean operations. If they don't, it means that they are separate objects.

The dependency graph is purely a visualization tool, therefore it cannot be edited; it automatically updates if changes are made to the model.

DependencyGraph1.png

Installation

To use the Dependency graph, a third-party software named Graphviz needs to be installed first. If you do not have it pre-installed or it is installed in an unconventional location, FreeCAD will display the following dialogue:

Windows

Download the graphviz-2.xx.msi installer from the Graphviz Download page and launch it to install it.

Mac/OSX

You can install graphviz using Homebrew:

brew install graphviz

This installs the graphviz binaries under /usr/local/bin. Unfortunately we can't navigate directly there from the file dialog that comes up from FreeCAD → Tools → Dependency graph. When you get the file selection dialog use the keys Cmd+Shift+G to get an input field for the path. Enter

/usr/local/bin

and confirm the input field and the file selection dialog.

In case the Graphviz binaries are installed in a non-standard location try to find the program with the command

type dot

It will output something like

dot is /usr/local/bin/dot

And therefore you can tell FreeCAD to look in that directory.

Linux

On most Linux distributions (Debian/Ubuntu, Fedora, OpenSUSE), you just need to install the graphviz package from the repositories. However, similarly to MacOSX, in cases where the Graphviz binaries are installed in a non-standard location, try to find the program with the command:

type dot

It may output something like

dot is /usr/local/bin/dot

And therefore you can point FreeCAD to look in that directory.

Configuration

You shouldn't need any configuration of FreeCAD preferences. If FreeCAD cannot find the utility "dot" (from the Graphviz package) then a dialog comes up and asks the user for its path: set the path to the folder that contains the "dot" executable, do not select the executable itself. FreeCAD then tries to start the utility again and in case it succeeds the value is written automatically to the user parameters.

How to use

  1. Go to the Tools → Dependency graph... menu
  2. A new tab titled Dependency graph opens over the main area of the FreeCAD window.
  3. Use the mouse scroll wheel to zoom in / zoom out.
  4. Use the horizontal slider at the bottom of the screen to pan the view sideways.

Save/Export

You can save/export the displayed dependency graph as an image file. While the Dependency graph tab is in the foreground:

  • Just choose FileSave As to save the graph as a picture (PNG/BMP/GIF/JPG), a vector graphic (SVG) or as a PDF document.
  • FileExport or ToolsSave picture will NOT work.

General principles

  • The graph shows objects in reverse chronological order, from the bottom to the top.
  • The direction of arrows showing dependencies should always point down, from the child object to the parent object. An arrow pointing up indicates a cyclic dependency, an issue that needs to be resolved.
  • A sketch that contains links to external geometry will have a number with an "x" suffix besides the arrow linking it to its parent, showing the number of external geometry linked in the sketch.
  • Objects can have dependencies to multiple parents. For example, for a model built in PartDesign, a Pocket may be linked to its Sketch and to the Pad feature that came before it.
  • Disallowed dependencies (for example, between a Draft/Part operation and an element inside a PartDesign Body) will show with a red arrow. This type of link usually shows a "Links go out of allowed scope" error in the report view.
  • Part container and PartDesign Body enclose their content inside a frame with a randomly colored background. Their Origin also enclose their content (standard planes and axes) in a frame.
  • Group is displayed as a single element linked to its content.

Limitations

  • The dependency graph cannot help with issues caused by topological naming. If a sketch switches faces of a feature after an edit, it is still linked to the feature; even if some features are broken, the dependency graph will remain unchanged.
  • A bug in v0.17/v0.18 causes a Body to disappear from the graph and its content to disseminate if a Part or Draft object is created from the Body. This otherwise does not affect the model.