solarianz/unityplayablegraphmonitortool

A tool for monitoring the PlayableGraph in real-time within the Unity Editor.

Unity PlayableGraph Monitor

中文

A tool for monitoring the PlayableGraph in real-time within the Unity Editor.

Features

• Display the topology of the selected PlayableGraph (supports large PlayableGraphs)
• Use the left mouse button to click on a node to display its detailed data
• Use the middle mouse button to drag the view
• Use the mouse scroll wheel to zoom in/out the view
• Display the assets and playback progress of AnimationClip and AudioClip nodes
• Display the animation job type of AnimationScriptPlayable nodes
• Supports to add extra text labels to Playable nodes
• Supports to set the maximum refresh rate of the view
• Supports to manually drag nodes to adjust the layout
• Supports to display PlayableGraphs with circular references (manually adjust the node layout required)

Screenshots

Supported Unity Version

Unity 2019.4 and later.

Installation

Install this package for free via OpenUPM

or

Buy this package from Unity Asset Store to support this project.

How to use

Open the PlayableGraph Monitor in Unity Editor menu Window/Analysis/PlayableGraph Monitor. In the top-left popup list, select a PlayableGraph to view its topology. Use the left mouse button to click on a node to display its details in the embedded Inspector.

Adding extra labels to Playable nodes

Use the PlayableGraphMonitorWindow.Open(IReadOnlyDictionary<PlayableHandle, string>) or PlayableGraphMonitorWindow.TrySetNodeExtraLabelTable(IReadOnlyDictionary<PlayableHandle, string>) method to add additional text labels to Playable nodes.

Manually dragging nodes to adjust the layout

After disabling the Auto Layout option in the toolbar of the monitor window, you can manually drag nodes to adjust the layout.

PlayableGraph with circular references

When there are circular references in the nodes of a PlayableGraph, the monitoring tool cannot automatically calculate the node layout. If you find that the monitoring tool fails to layout nodes properly, check the console log to see if it indicates circular references in the PlayableGraph. In this case, you can disable the Auto Layout option, and then manually drag nodes to identify the circular references in the PlayableGraph.

It should be noted that if there is a group of Playables where each Playable serves as an input to another one or more Playables in the group (i.e., there is no root Playable), and none of them are connected to a PlayableOutput, then this group of Playables will not appear in the graph view and may not trigger any error messages.

Improve the display performance of large PlayableGraph

The following methods can significantly improve performance when displaying a large PlayableGraph:

• Disable the Inspector option(or do not select any nodes)
• Disable the Clip Progress option
• Decrease the maximum refresh rate
• Disable the Keep updating edges when mouse leave GraphView option in the context menu(when disabled, the color of edges will no longer change according to their weight when the mouse leaves the graph area)

unityplayablegraphmonitortool's Issues

Use special colors to indicate edges whose weight is less than 0 or greater than 1

Use special colors to indicate edges whose weight is less than 0 or greater than 1.

Show job type on AnimationScriptPlayable node

Use internal PlayableHandle.GetPlayableType() method.

The "Select Node" menu has merged options with the same name

Optimize PlayableOutput Layout

Add a drop-down menu to the toolbar for quick access to output nodes.

Useful when browsing a large PlayableGraph.

AnimationClipPlayableNode won't update its clip object

AnimationClipPlayableNode won't update its clip object.

Optimize Performance

增加按HandleHashCode查找节点的功能

Extra data to add custom label to node

Extra data to add custom label to node: Dictionary<PlayableHandle, string> .

Node won't update its inputs order and weight when PlayableGraph hierarchy changed

Node won't update its inputs order and weight when PlayableGraph hierarchy changed.

Can you please add auto clean-up of the graph tool on Editor going into PlayMode?

Can you please add auto clean-up of the graph tool on Editor going into PlayMode?
Currently, graph stays at is was after exiting play mode, which is very useful, but then we need to start again whole editor or recompile to clean-up before going into next playmode session.
It would be very nice to clean-up all graphs and all cache on editor going into playmode.

Exception on changed graph tree

When I change the input/output count of the playable mixer, the following exception raised.

ArgumentOutOfRangeException: Index was out of range. Must be non-negative and less than the size of the collection.
Parameter name: index
System.Collections.Generic.List`1[T].get_Item (System.Int32 index) (at :0)
GBG.PlayableGraphMonitor.Editor.Node.PlayableNode.Update () (at Assets/ThirdParty/UnityPlayableGraphMonitorTool-1.0.8/Editor/Scripts/Node/PlayableNode.cs:46)
GBG.PlayableGraphMonitor.Editor.Node.PlayableOutputNode.Update () (at Assets/ThirdParty/UnityPlayableGraphMonitorTool-1.0.8/Editor/Scripts/Node/PlayableOutputNode.cs:82)
GBG.PlayableGraphMonitor.Editor.GraphView.PlayableGraphView.UpdateView () (at Assets/ThirdParty/UnityPlayableGraphMonitorTool-1.0.8/Editor/Scripts/GraphView/PlayableGraphView.cs:107)
GBG.PlayableGraphMonitor.Editor.GraphView.PlayableGraphView.Update (UnityEngine.Playables.PlayableGraph playableGraph) (at Assets/ThirdParty/UnityPlayableGraphMonitorTool-1.0.8/Editor/Scripts/GraphView/PlayableGraphView.cs:38)
GBG.PlayableGraphMonitor.Editor.PlayableGraphMonitorWindow.Update () (at Assets/ThirdParty/UnityPlayableGraphMonitorTool-1.0.8/Editor/Scripts/Window/PlayableGraphMonitorWindow.cs:51)
UnityEditor.HostView.SendUpdate () (at <6a5b55f2e18b419e9faedac06ac6af94>:0)
UnityEditor.EditorApplication.Internal_CallUpdateFunctions () (at <6a5b55f2e18b419e9faedac06ac6af94>:0)

Display the MiniMap of the PlayableGraph

将Edge更新设置从右上角菜单移动到Toolbar

Dublicated graph item

Display more PlayableOutput details

Display more PlayableOutput details.

PlayableOutput:

• UObject PlayableOutput.GetReferenceObject()
• UObject PlayableOutput.GetUserData()
• int PlayableOutput.GetSourceOutputPort()

AnimationPlayableOutput:

• Animator AnimationPlayableOutput.GetTarget()
• AnimationStreamSource AnimationPlayableOutput.GetAnimationStreamSource()
• ushort AnimationPlayableOutput.GetSortingOrder()

AudioPlayableOutput:

• bool AudioPlayableOutput.GetEvaluateOnSeek()
• AudioSource AudioPlayableOutput.GetTarget()

TexturePlayableOutput:

• RenderTexture TexturePlayableOutput.GetTarget()