GraphViewer¶
- MacroModule¶
author
package
definition
Purpose¶
The module GraphViewer provides a viewer that displays a simplified version of an attached Graph.
Details¶
The viewer displays the nodes and edges of a graph while ignoring the edge skeletons. Edges are represented as connections (arrows) between the predecessor and successor nodes; the actual path of the edges defined by the skeleton positions is not visualized.
Nodes and edges are displayed in different styles depending on their type, allowing root nodes, branch nodes, end nodes, and both cyclic and non-cyclic edges to be distinguished visually. Additionally, the IDs of the nodes and edges can be displayed.
This macro module is intended to serve as a debugging viewer for quickly investigating the structure of a graph.
Windows¶
Default Panel¶
Input Fields¶
inGraph¶
- name: inGraph, type: Graph(MLBase)¶
For accessing this object via scripting, see the Scripting Reference:
MLGraphWrapper.
Parameter Fields¶
Field Index¶
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Visible Fields¶
Show Details¶
- name: showDetails, type: Bool, default: TRUE¶
If checked, the additional controls for adjusting the display of the graph are shown.
Node Size¶
- name: nodeSize, type: Float, default: 1.5, minimum: 0¶
Sets the visual extent of the displayed nodes.
Show node IDs¶
- name: showNodeIds, type: Bool, default: FALSE¶
If checked, the display of the node IDs is enabled.
Arrowhead Size¶
- name: arrowHeadSize, type: Float, default: 1.3, minimum: 0¶
Sets the visual extent of the arrowheads indicating the direction of the edges.
Arrow Line Size¶
- name: arrowLineSize, type: Float, default: 0.2, minimum: 0¶
Sets the thickness of the edge lines.
Show edge IDs¶
- name: showEdgeIds, type: Bool, default: FALSE¶
If checked, the display of the edge IDs is enabled.
Non-cyclic edges¶
- name: nonCyclicEdges, type: Bool, default: TRUE¶
If checked, edges that are not marked as cyclic are displayed.
Cyclic Edges¶
- name: cyclicEdges, type: Bool, default: TRUE¶
If checked, edges that are marked as cyclic are displayed.
Root Nodes¶
- name: rootNodes, type: Bool, default: TRUE¶
If checked, nodes that do not have any incoming non-cyclic edges are displayed.
Branch Nodes¶
- name: branchNodes, type: Bool, default: FALSE¶
If checked, nodes that are neither root nodes nor end nodes are displayed.
End Nodes¶
- name: endNodes, type: Bool, default: FALSE¶
If checked, nodes that do not have any outgoing edges are displayed.
Num Nodes¶
- name: numNodes, type: Integer, persistent: no¶
Shows the total number of nodes in the graph.
Num Edges¶
- name: numEdges, type: Integer, persistent: no¶
Shows the total number of edges in the graph.
Num Roots¶
- name: numRoots, type: Integer, persistent: no¶
Shows the total number of root nodes in the graph.