Std DependencyGraph: Difference between revisions
Renatorivo (talk | contribs) ({{Code|code=) |
(Completed the page, changed some formatting, removed incomplete document template.) |
||
Line 1: | Line 1: | ||
{{Template:UnfinishedDocu}} |
|||
<translate> |
<translate> |
||
<!--T:1--> |
<!--T:1--> |
||
{{GuiCommand|Name=Std DependencyGraph|MenuLocation=[[Std Tools Menu|Tools]] → Dependency graph...||Workbenches=All|Shortcut=|SeeAlso=}} |
{{GuiCommand|Name=Std DependencyGraph|MenuLocation=[[Std Tools Menu|Tools]] → Dependency graph...||Workbenches=All|Shortcut=None|SeeAlso=}} |
||
Line 9: | Line 7: | ||
<!--T:7--> |
<!--T:7--> |
||
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. |
|||
<!--T:8--> |
<!--T:8--> |
||
Line 17: | Line 19: | ||
==Installation== <!--T:9--> |
==Installation== <!--T:9--> |
||
To use the Dependency graph, a third-party software named [http://graphviz.org/ Graphviz] needs to be installed first. |
|||
<!--T:10--> |
|||
⚫ | |||
<!--T:15--> |
<!--T:15--> |
||
===Windows=== |
|||
'''Windows:''' See http://graphviz.org/ |
|||
Download the '''graphviz-2.xx.msi''' installer from the [http://graphviz.org/Download_windows.php Download page] and launch it to install it. |
|||
<!--T:16--> |
|||
⚫ | You |
||
<!--T:11--> |
<!--T:11--> |
||
===Mac/OSX=== |
|||
You can install graphviz using brew: |
You can install graphviz using brew: |
||
</translate> |
</translate> |
||
Line 44: | Line 42: | ||
Now when asked to select the graphviz install directory go to your home directory and select "bin". |
Now when asked to select the graphviz install directory go to your home directory and select "bin". |
||
<!--T:10--> |
|||
===Linux=== |
|||
With version 014.3700 and above you can save/export the displayed dependency graph. |
|||
⚫ | |||
⚫ | |||
⚫ | |||
==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== |
|||
⚫ | |||
# 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: |
|||
⚫ | |||
⚫ | |||
</translate> |
</translate> |
Revision as of 09:20, 5 March 2017
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.
Installation
To use the Dependency graph, a third-party software named Graphviz needs to be installed first.
Windows
Download the graphviz-2.xx.msi installer from the Download page and launch it to install it.
Mac/OSX
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".
Linux
On most Linux distributions (Debian/Ubuntu, Fedora, OpenSUSE), you just need to install the graphviz package from the repositories.
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
- 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
You can save/export the displayed dependency graph as an image file. While the Dependency graph tab is in the foreground:
- Just choose File → Save As to save the graph as a picture (PNG/BMP/GIF/JPG), a vector graphic (SVG) or as a pdf-file (PDF).
- File → Export or Tools → Save picture will NOT work.