Switch branches/tags
Nothing to show
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
README.md

README.md

LiteGraph

Here is a list of useful info when working with LiteGraph

LGraphNode

LGraphNode is the base class used for all the nodes classes. To extend the other classes all the methods contained in LGraphNode.prototype are copyed to the classes when registered.

Node slots

Every node could have several slots, stored in node.inputs and node.outputs.

You can add new slots by calling node.addInput or node.addOutput

The main difference between inputs and outputs is that an input can only have one connection link while outputs could have several.

To get information about an slot you can access node.inputs[ slot_index ] or node.outputs[ slot_index ]

Slots have the next information:

  • name: string with the name of the slot (used also to show in the canvas)
  • type: string specifying the data type traveling through this link
  • link or links: depending if the slot is input or ouput contains the id of the link or an array of ids
  • label: optional, string used to rename the name as shown in the canvas.

To retrieve the data traveling through a link you can call node.getInputData or node.getOutputData

Define your Graph Node

When creating a class for a graph node here are some useful points:

  • The constructor should create the default inputs and outputs (use addInput and addOutput)
  • Properties that can be edited are stored in this.properties = {};
  • the onExecute is the method that will be called when the graph is executed
  • you can catch if a property was changed defining a onPropertyChanged
  • you must register your node using LiteGraph.registerNodeType("type/name", MyGraphNodeClass );
  • you can alter the default priority of execution by defining the MyGraphNodeClass.priority (default is 0)
  • you can overwrite how the node is rendered using the onDrawBackground and onDrawForeground

Integration

To integrate in you HTML application:

var graph = new LiteGraph.LGraph();
var graph_canvas = new LiteGraph.LGraphCanvas( canvas, graph );

If you want to start the graph then:

graph.start();