GraphNodeΒΆ
class GraphNode
GraphNode is the base class for nodes in a GraphNode
Hierarchy
class GraphNode < class SelectableNode < class DeletableNode < class Node
Children classes : class GraphMacro , class GraphMacroOutput , class RenderGraphNode
Members
| 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
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
string | Name | RW | The node name |
| onpathchanged | ( ) | Called by the framework when the name of this node or of one of its parent is modified |
| eval | (
|
Called by the framework when plug (a node's plug) must be evaluated |
| isselected | ( ) | Tell if the node is selected |
| getparent | ( ) | Get the parent Node of this Node |
| isparent | (
|
Tells if this node is parent of the potential child |
| findparent | (
|
Find the first parent Node of this Node of a specific class |
| getpath | ( ) | Returns the node path as a string that can be reused with findchild |
| findchild | (
|
Find a child node or plug using a path |
| move | (
|
Move a node to a new parent |
| delete | ( ) | Delete a node |
| rename | (
|
Rename a node |
| getname | ( ) | Get the Node name in its parent |
| getchild | (
|
Get a child node by its name |
| isreference | ( ) | Tells if a node comes from a reference project |
| getreference | ( ) | Returns the reference node it is connected to |
| gettopreference | ( ) | Returns the top reference node it is connected to |
| belongstoreference | (
|
Tells if the node belongs to the reference, or a sub reference |
| loadfile | (
|
load a file content in this node. Possible options are: overrideclass to enforce a specific class for the root node. |
| referencefile | (
|
reference a file content in this node. |
| loadtemplate | (
|
load a template file |
| savefile | (
|
load a node to a file |
| getstringcopy | ( ) | Return a copy of the node and its content as a string to be pasted |
| setflags | ( ) | Set the node flags |
| ismoveable | ( ) | Tells if the node can be moved |
| pastestringcopy | (
|
Paste a string copy into this node |
| getreferences | (
[
|
Returns the references in the document sorted depth first. |
| iseditable | ( ) | Indicates if the node can be edited by the user in the UI |
| seteditable | (
|
Change the editable state of the node |
| isindocument | ( ) | Tells if the node is inside a document, or is pending in the void |
Documentation
Create a GraphInput in the node
input The created input
Create a GraphOutput in the node
output The created output
Get an input by its name
name The name of the input to get
input The input with matching name
Return the name of the GraphInput class to use
classname The class name
List the node's inputs
inputs The array of inputs in the node
Get an output by its name
name The name of the output to get
output The output with matching name
Return the name of the GraphOutput class to use
classname The class name
List the node's outputs
outputs The array of outputs in the node
An iterator on node's outputs
iterator
An iterator on node's inputs
iterator
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.)
other The other node
isparent
Remove a GraphInput of the node
string The name of the input to remove
Remove a GraphOutput of the node
string The name of the output to remove