BrotherhoodOfNode

A visual graph editor for Unity3D

Install

This project is still under development... But you can use it already!

copy the files from the asset folder to your unity project asset folder
in unity click on window->BrotherhoodOfNode to open the editor window
continue reading and afterwards take a look at Assets.Code.Bon.BonLauncher.cs to learn how the project works
help us make it even better

Features

user friendly editor UI
human readable JSON serialization of the graph
easy creation of custom nodes (extend Node.cs)
tab pages for multiple graphs

Non-Features

nothing but a tool to create graphs and make them persitent (ok.. there are some math related Nodes now)

Usage

Right click to add a node. Middle mouse button to scroll. Right click on a node to delete a node. Click/Drag to connect Sockets. Mouse wheel to zoom.

How To Create A Custom Node

To create your own nodes you need to create a new class. Let's call it MyNode.cs for this example. MyNode now needs to inherit from the class Node. And this class needs the annotation [Serializable] in order to save it as a json file.

using System;
using UnityEngine;

namespace Assets.Code.Bon.Graph.Custom
{
	[Serializable]
	[GraphContextMenuItem("Standard", "MyNode")]
	public class MyNode : Node {

		[SerializeField]
		private int myNumber;

		public MyNode(int id) : base(id)
		{
			// Add the input / output sockets of this Node
			Sockets.Add(new Socket(this, Color.red, SocketDirection.Output));
			Sockets.Add(new Socket(this, Color.red, SocketDirection.Input));
			Sockets.Add(new Socket(this, Color.red, SocketDirection.Input));
			Height = 65;
		}

		// To create your custom UI elements in the Node.
		public override void OnGUI()
		{
			// Use GUI or GUILayout as usual
			// (if your nodes content has changed call: TriggerChangeEvent())
		}
		
		// To return a result of one of the nodes output sockets.
		public override object GetResultOf(Socket outSocket)
		{
			// Check if the assigned socket is ready for a result..
			if (CanGetResultOf(outSocket)) 
			{
				return myNumber;
				// (you usally want to make the result depending on the nodes input sockets)
			}
			else 
			{
				return float.NaN; // return not a number
			}
		}
		
		// To return if the nodes socket is ready for a result.
		public override bool CanGetResultOf(Socket outSocket)
		{
			// In our case just check if all input sockets are connected
			return AllInputSocketsConnected();
		}

		// For custom serialization
		public override void OnSerialization(SerializableNode sNode)
		{	
			// You usually do not need to add custom serialization
			// (if you have class members you want to serialize use: [SerializeField])
		}

		// For custom deserialization
		public override void OnDeserialization(SerializableNode sNode)
		{
			// You usually do not need to add custom deserialization
		}
	}
}

The anotation [GraphContextMenuItem] tells the editor where to add the menu entry for our Node.

Adding Sockets

We created a node class that contains three red Sockets. A Socket needs a parent node as first parameter (this) and a connection type (Color.Red). Only sockets of the same type can be connected. The last boolean parameter tells the socket if it is an input (left) or output socket (right).

Add UI elememts

To add custom UI elements to your node simply use the OnGUI method as usual.

Save nodes as json (serialization / deserializaiton)

If we have got class members (like myNumber) we want to make persistent we need to prefix the annotation [SerializeField] to it. You may also need [System.NonSerialized] to avoid serialization for your memners. Also take a look at: http://docs.unity3d.com/Manual/JSONSerialization.html If you really need a more complex way to serialize your Node you can use the methods OnSerialization and OnDeserialization to add your logic.

How To Receive Graph Events

Every time a Graph is created you should register a IGraphListener in order to receive events of this graph. You can create your own class that inherits from IGraphListener and add your own logic. The default implementation that inherits from IGraphListener is the StandardGraphController.

	public void OnCreate(Graph graph)
	{
		this.graph = graph;
	}

	public void OnLink(Edge edge)
	{
		Debug.Log("OnLink: Node " + edge.Source.Parent.Id + " with Node " + edge.Sink.Parent.Id);
	}

	public void OnUnLink(Socket s01, Socket s02)
	{
		Debug.Log("OnUnLink: Node " + s01.Edge.Source.Parent.Id + " from Node " + s02.Edge.Sink.Parent.Id);
	}

	public void OnNodeAdded(Node node)
	{
		Debug.Log("OnNodeAdded: Node " + node.GetType() + " with id " + node.Id);
	}

	public void OnNodeRemoved(Node node)
	{
		Debug.Log("OnNodeRemoved: Node " + node.GetType() + " with id " + node.Id);
	}

	public void OnNodeChanged(Node node)
	{
		Debug.Log("OnNodeChanged: Node " + node.GetType() + " with id " + node.Id);
	}

Next Up..

fix socket color issue (currently the socket is very transparent)
Remove the tab-pages and implement the possibility of multiple editor windows
Check for recursion in the graph.
Unit tests
A help dialog to explain the controls.
Code style and code documentation (no idea whats the state of the art. Following microsofts or unitys recommendations?)
cleanup code, refactor namespaces

maresalexandru/BrotherhoodOfNode