This commit is contained in:
tamat
2015-07-31 15:42:50 +02:00
parent b96e0d6c66
commit 4a2fdc0cff
9 changed files with 349 additions and 175 deletions

View File

@@ -38,7 +38,7 @@
"plugin_for": [],
"extension_for": [],
"file": "../src/litegraph.js",
"line": 231,
"line": 234,
"description": "LGraph is the class that contain a full graph. We instantiate one and add nodes to it, and then we can run the execution loop.",
"is_constructor": 1
},
@@ -51,7 +51,7 @@
"plugin_for": [],
"extension_for": [],
"file": "../src/litegraph.js",
"line": 1137,
"line": 1155,
"description": "Base Class for all the node type classes",
"params": [
{
@@ -70,7 +70,7 @@
"plugin_for": [],
"extension_for": [],
"file": "../src/litegraph.js",
"line": 2374,
"line": 2397,
"description": "marks as dirty the canvas, this way it will be rendered again",
"is_constructor": 1,
"params": [
@@ -91,7 +91,7 @@
"classitems": [
{
"file": "../src/litegraph.js",
"line": 37,
"line": 38,
"description": "Register a node class so it can be listed when the user wants to create a new one",
"itemtype": "method",
"name": "registerNodeType",
@@ -111,7 +111,7 @@
},
{
"file": "../src/litegraph.js",
"line": 68,
"line": 71,
"description": "Create a node of a given type with a name. The node is not attached to any graph yet.",
"itemtype": "method",
"name": "createNode",
@@ -136,7 +136,7 @@
},
{
"file": "../src/litegraph.js",
"line": 109,
"line": 112,
"description": "Returns a registered node type with a given name",
"itemtype": "method",
"name": "getNodeType",
@@ -155,7 +155,7 @@
},
{
"file": "../src/litegraph.js",
"line": 122,
"line": 125,
"description": "Returns a list of node types matching one category",
"itemtype": "method",
"name": "getNodeType",
@@ -174,7 +174,7 @@
},
{
"file": "../src/litegraph.js",
"line": 144,
"line": 147,
"description": "Returns a list with all the node type categories",
"itemtype": "method",
"name": "getNodeTypesCategories",
@@ -186,7 +186,7 @@
},
{
"file": "../src/litegraph.js",
"line": 255,
"line": 258,
"description": "Removes all nodes from this graph",
"itemtype": "method",
"name": "clear",
@@ -194,7 +194,7 @@
},
{
"file": "../src/litegraph.js",
"line": 300,
"line": 303,
"description": "Attach Canvas to this graph",
"itemtype": "method",
"name": "attachCanvas",
@@ -209,7 +209,7 @@
},
{
"file": "../src/litegraph.js",
"line": 319,
"line": 322,
"description": "Detach Canvas from this graph",
"itemtype": "method",
"name": "detachCanvas",
@@ -224,7 +224,7 @@
},
{
"file": "../src/litegraph.js",
"line": 333,
"line": 336,
"description": "Starts running this graph every interval milliseconds.",
"itemtype": "method",
"name": "start",
@@ -239,7 +239,7 @@
},
{
"file": "../src/litegraph.js",
"line": 360,
"line": 363,
"description": "Stops the execution loop of the graph",
"itemtype": "method",
"name": "stop execution",
@@ -247,7 +247,7 @@
},
{
"file": "../src/litegraph.js",
"line": 382,
"line": 385,
"description": "Run N steps (cycles) of the graph",
"itemtype": "method",
"name": "runStep",
@@ -262,7 +262,7 @@
},
{
"file": "../src/litegraph.js",
"line": 426,
"line": 429,
"description": "Updates the graph execution order according to relevance of the nodes (nodes with only outputs have more relevance than\nnodes with only inputs.",
"itemtype": "method",
"name": "updateExecutionOrder",
@@ -270,7 +270,7 @@
},
{
"file": "../src/litegraph.js",
"line": 524,
"line": 527,
"description": "Returns the amount of time the graph has been running in milliseconds",
"itemtype": "method",
"name": "getTime",
@@ -282,7 +282,7 @@
},
{
"file": "../src/litegraph.js",
"line": 535,
"line": 538,
"description": "Returns the amount of time accumulated using the fixedtime_lapse var. This is used in context where the time increments should be constant",
"itemtype": "method",
"name": "getFixedTime",
@@ -294,7 +294,7 @@
},
{
"file": "../src/litegraph.js",
"line": 546,
"line": 549,
"description": "Returns the amount of time it took to compute the latest iteration. Take into account that this number could be not correct\nif the nodes are using graphical actions",
"itemtype": "method",
"name": "getElapsedTime",
@@ -306,7 +306,7 @@
},
{
"file": "../src/litegraph.js",
"line": 558,
"line": 561,
"description": "Sends an event to all the nodes, useful to trigger stuff",
"itemtype": "method",
"name": "sendEventToAllNodes",
@@ -326,7 +326,7 @@
},
{
"file": "../src/litegraph.js",
"line": 593,
"line": 596,
"description": "Adds a new node instasnce to this graph",
"itemtype": "method",
"name": "add",
@@ -341,7 +341,7 @@
},
{
"file": "../src/litegraph.js",
"line": 642,
"line": 645,
"description": "Removes a node from the graph",
"itemtype": "method",
"name": "remove",
@@ -356,7 +356,7 @@
},
{
"file": "../src/litegraph.js",
"line": 708,
"line": 711,
"description": "Returns a node by its id.",
"itemtype": "method",
"name": "getNodeById",
@@ -371,7 +371,26 @@
},
{
"file": "../src/litegraph.js",
"line": 721,
"line": 723,
"description": "Returns a list of nodes that matches a class",
"itemtype": "method",
"name": "findNodesByClass",
"params": [
{
"name": "classObject",
"description": "the class itself (not an string)",
"type": "Class"
}
],
"return": {
"description": "a list with all the nodes of this type",
"type": "Array"
},
"class": "LGraph"
},
{
"file": "../src/litegraph.js",
"line": 739,
"description": "Returns a list of nodes that matches a type",
"itemtype": "method",
"name": "findNodesByType",
@@ -390,7 +409,7 @@
},
{
"file": "../src/litegraph.js",
"line": 737,
"line": 755,
"description": "Returns a list of nodes that matches a name",
"itemtype": "method",
"name": "findNodesByName",
@@ -409,7 +428,7 @@
},
{
"file": "../src/litegraph.js",
"line": 753,
"line": 771,
"description": "Returns the top-most node in this position of the canvas",
"itemtype": "method",
"name": "getNodeOnPos",
@@ -438,7 +457,7 @@
},
{
"file": "../src/litegraph.js",
"line": 940,
"line": 958,
"description": "Assigns a value to all the nodes that matches this name. This is used to create global variables of the node that\ncan be easily accesed from the outside of the graph",
"itemtype": "method",
"name": "setInputData",
@@ -458,7 +477,7 @@
},
{
"file": "../src/litegraph.js",
"line": 955,
"line": 973,
"description": "Returns the value of the first node with this name. This is used to access global variables of the graph from the outside",
"itemtype": "method",
"name": "setInputData",
@@ -477,7 +496,7 @@
},
{
"file": "../src/litegraph.js",
"line": 992,
"line": 1010,
"description": "returns if the graph is in live mode",
"itemtype": "method",
"name": "isLive",
@@ -485,7 +504,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1025,
"line": 1043,
"description": "Creates a Object containing all the info about this graph, it can be serialized",
"itemtype": "method",
"name": "serialize",
@@ -497,7 +516,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1058,
"line": 1076,
"description": "Configure a graph from a JSON string",
"itemtype": "method",
"name": "configure",
@@ -512,7 +531,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1172,
"line": 1190,
"description": "configure a node from an object containing the serialized info",
"itemtype": "method",
"name": "configure",
@@ -520,7 +539,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1231,
"line": 1249,
"description": "serialize the content",
"itemtype": "method",
"name": "serialize",
@@ -528,7 +547,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1285,
"line": 1303,
"description": "serialize and stringify",
"itemtype": "method",
"name": "toString",
@@ -536,7 +555,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1297,
"line": 1315,
"description": "get the title string",
"itemtype": "method",
"name": "getTitle",
@@ -544,7 +563,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1310,
"line": 1328,
"description": "sets the output data",
"itemtype": "method",
"name": "setOutputData",
@@ -564,8 +583,8 @@
},
{
"file": "../src/litegraph.js",
"line": 1329,
"description": "retrieves the input data from one slot",
"line": 1349,
"description": "retrieves the input data (data traveling through the connection) from one slot",
"itemtype": "method",
"name": "getInputData",
"params": [
@@ -583,7 +602,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1343,
"line": 1364,
"description": "tells you if there is a connection in one input slot",
"itemtype": "method",
"name": "isInputConnected",
@@ -602,7 +621,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1355,
"line": 1377,
"description": "tells you info about an input connection (which node, type, etc)",
"itemtype": "method",
"name": "getInputInfo",
@@ -621,7 +640,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1370,
"line": 1392,
"description": "tells you info about an output connection (which node, type, etc)",
"itemtype": "method",
"name": "getOutputInfo",
@@ -640,7 +659,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1385,
"line": 1407,
"description": "tells you if there is a connection in one output slot",
"itemtype": "method",
"name": "isOutputConnected",
@@ -659,7 +678,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1397,
"line": 1419,
"description": "retrieves all the nodes connected to this output slot",
"itemtype": "method",
"name": "getOutputNodes",
@@ -678,7 +697,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1426,
"line": 1448,
"description": "add a new output slot to use in this node",
"itemtype": "method",
"name": "addOutput",
@@ -695,7 +714,7 @@
},
{
"name": "extra_info",
"description": "this can be used to have special properties of an output (special color, position, etc)",
"description": "this can be used to have special properties of an output (label, special color, position, etc)",
"type": "Object"
}
],
@@ -703,7 +722,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1447,
"line": 1469,
"description": "add a new output slot to use in this node",
"itemtype": "method",
"name": "addOutputs",
@@ -718,7 +737,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1472,
"line": 1494,
"description": "remove an existing output slot",
"itemtype": "method",
"name": "removeOutput",
@@ -733,7 +752,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1486,
"line": 1508,
"description": "add a new input slot to use in this node",
"itemtype": "method",
"name": "addInput",
@@ -745,7 +764,7 @@
},
{
"name": "type",
"description": "string defining the input type (\"vec3\",\"number\",...)",
"description": "string defining the input type (\"vec3\",\"number\",...), it its a generic one use 0",
"type": "String"
},
{
@@ -758,7 +777,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1507,
"line": 1530,
"description": "add several new input slots in this node",
"itemtype": "method",
"name": "addInputs",
@@ -773,7 +792,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1532,
"line": 1555,
"description": "remove an existing input slot",
"itemtype": "method",
"name": "removeInput",
@@ -788,7 +807,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1546,
"line": 1569,
"description": "add an special connection to this node (used for special kinds of graphs)",
"itemtype": "method",
"name": "addConnection",
@@ -818,7 +837,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1559,
"line": 1582,
"description": "computes the size of a node according to its inputs and output slots",
"itemtype": "method",
"name": "computeSize",
@@ -837,7 +856,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1577,
"line": 1600,
"description": "returns the bounding of the object, used for rendering purposes",
"itemtype": "method",
"name": "getBounding",
@@ -849,7 +868,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1587,
"line": 1610,
"description": "checks if a point is inside the shape of a node",
"itemtype": "method",
"name": "isPointInsideNode",
@@ -873,7 +892,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1609,
"line": 1632,
"description": "returns the input slot with a given name (used for dynamic slots), -1 if not found",
"itemtype": "method",
"name": "findInputSlot",
@@ -892,7 +911,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1624,
"line": 1647,
"description": "returns the output slot with a given name (used for dynamic slots), -1 if not found",
"itemtype": "method",
"name": "findOutputSlot",
@@ -911,7 +930,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1639,
"line": 1662,
"description": "connect this node output to the input of another node",
"itemtype": "method",
"name": "connect",
@@ -940,7 +959,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1722,
"line": 1745,
"description": "disconnect one output to an specific node",
"itemtype": "method",
"name": "disconnectOutput",
@@ -964,7 +983,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1789,
"line": 1812,
"description": "disconnect one input",
"itemtype": "method",
"name": "disconnectInput",
@@ -983,7 +1002,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1846,
"line": 1869,
"description": "returns the center of a connection point in canvas coords",
"itemtype": "method",
"name": "getConnectionPos",
@@ -1007,7 +1026,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1978,
"line": 2001,
"description": "Collapse the node to make it smaller on the canvas",
"itemtype": "method",
"name": "collapse",
@@ -1015,7 +1034,7 @@
},
{
"file": "../src/litegraph.js",
"line": 1991,
"line": 2014,
"description": "Forces the node to do not move or realign on Z",
"itemtype": "method",
"name": "pin",
@@ -1023,7 +1042,7 @@
},
{
"file": "../src/litegraph.js",
"line": 2052,
"line": 2075,
"description": "clears all the data inside",
"itemtype": "method",
"name": "clear",
@@ -1031,7 +1050,7 @@
},
{
"file": "../src/litegraph.js",
"line": 2106,
"line": 2129,
"description": "assigns a graph, you can reasign graphs to the same canvas",
"itemtype": "method",
"name": "setGraph",
@@ -1046,7 +1065,7 @@
},
{
"file": "../src/litegraph.js",
"line": 2134,
"line": 2157,
"description": "opens a graph contained inside a node in the current graph",
"itemtype": "method",
"name": "openSubgraph",
@@ -1061,7 +1080,7 @@
},
{
"file": "../src/litegraph.js",
"line": 2161,
"line": 2184,
"description": "closes a subgraph contained inside a node",
"itemtype": "method",
"name": "closeSubgraph",
@@ -1076,7 +1095,7 @@
},
{
"file": "../src/litegraph.js",
"line": 2176,
"line": 2199,
"description": "assigns a canvas",
"itemtype": "method",
"name": "setCanvas",
@@ -1091,7 +1110,7 @@
},
{
"file": "../src/litegraph.js",
"line": 2390,
"line": 2413,
"description": "Used to attach the canvas in a popup",
"itemtype": "method",
"name": "getCanvasWindow",
@@ -1103,7 +1122,7 @@
},
{
"file": "../src/litegraph.js",
"line": 2402,
"line": 2425,
"description": "starts rendering the content of the canvas when needed",
"itemtype": "method",
"name": "startRendering",
@@ -1111,7 +1130,7 @@
},
{
"file": "../src/litegraph.js",
"line": 2425,
"line": 2448,
"description": "stops rendering the content of the canvas (to save resources)",
"itemtype": "method",
"name": "stopRendering",