RenderGraphBinop¶
class RenderGraphBinop
A RenderGraphBinop combines its 2 inputs using the current Mode to produce its output. Combining modes are union, intersection, subract and override.
Hierarchy
class RenderGraphBinop < class RenderGraphNode < class GraphNode < class SelectableNode < class DeletableNode < class Node
Members
Plugs:
RW | Mode | types.enum | The merging mode, either "merge", "union", "intersection", "subtract" or "override" |
Inherited from class RenderGraphNode
Plugs:
RW | Invalid | nil | The invalidation plug. Invalidating this plug causes all RenderGraphOutputs of this node to be invalidated. This plug is dependent on all RenderGraphInputs |
RW | State | nil | The node state, either "active", "bypass" or "disabled". When "disabled", all outputs values are nil. When "bypass", all outputs values are the node's first node input's value. |
RW | NodePos | types.table | The node position in the graph, as {x,y} components |
Inherited from class GraphNode
Methods:
| createinput | ( ) | Create a GraphInput in the node |
| createoutput | ( ) | Create a GraphOutput in the node |
| getinput | (
|
Get an input by its name |
| getinputclassname | ( ) | Return the name of the GraphInput class to use |
| getinputs | ( ) | List the node's inputs |
| getoutput | (
|
Get an output by its name |
| getoutputclassname | ( ) | Return the name of the GraphOutput class to use |
| getoutputs | ( ) | List the node's outputs |
| inputs | ( ) | An iterator on node's outputs |
| inputs | ( ) | An iterator on node's inputs |
| isgraphparent | (
|
Indicate if the other node is dependent on this node (i.e. if an output of self is directly/indirectly connected into any input of other.) |
| removeinput | (
|
Remove a GraphInput of the node |
| removeoutput | (
|
Remove a GraphOutput of the node |
Inherited from class SelectableNode
Plugs:
boolean | Selected | R | True if the node is selected. Don't use this plug directly to select a node, use the Document's modifier select method. |
Inherited from class Node
Plugs:
string | Name | RW | The node name |
Methods:
| belongstoreference | (
|
Tells if the node belongs to the reference, or a sub reference |
| delete | ( ) | Delete a node |
| eval | (
|
Called by the framework when plug (a node's plug) must be evaluated |
| findchild | (
|
Find a child node or plug using a path |
| findparent | (
|
Find the first parent Node of this Node of a specific class |
| getchild | (
|
Get a child node by its name |
| getname | ( ) | Get the Node name in its parent |
| getparent | ( ) | Get the parent Node of this Node |
| getpath | ( ) | Returns the node path as a string that can be reused with findchild |
| getreference | ( ) | Returns the reference node it is connected to |
| getreferences | (
[
|
Returns the references in the document sorted depth first. |
| getstringcopy | ( ) | Return a copy of the node and its content as a string to be pasted |
| gettopreference | ( ) | Returns the top reference node it is connected to |
| iseditable | ( ) | Indicates if the node can be edited by the user in the UI |
| ismoveable | ( ) | Tells if the node can be moved |
| isparent | (
|
Tells if this node is parent of the potential child |
| isreference | ( ) | Tells if a node comes from a reference project |
| isselected | ( ) | Tell if the node is selected |
| loadfile | (
|
load a file content in this node. Possible options are: overrideclass to enforce a specific class for the root node. |
| loadtemplate | (
|
load a template file |
| move | (
|
Move a node to a new parent |
| onpathchanged | ( ) | Called by the framework when the name of this node or of one of its parent is modified |
| pastestringcopy | (
|
Paste a string copy into this node |
| referencefile | (
|
reference a file content in this node. |
| rename | (
|
Rename a node |
| savefile | (
|
load a node to a file |
| seteditable | (
|
Change the editable state of the node |
| setflags | ( ) | Set the node flags |
Documentation
The merging mode, either "merge", "union", "intersection", "subtract" or "override"