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

Methods:

GraphInput input createinput ( ) Create a GraphInput in the node
GraphOutput output createoutput ( ) Create a GraphOutput in the node
GraphInput input getinput ( string name ) Get an input by its name
string classname getinputclassname ( ) Return the name of the GraphInput class to use
{GraphInput} inputs getinputs ( ) List the node's inputs
GraphOutput output getoutput ( string name ) Get an output by its name
string classname getoutputclassname ( ) Return the name of the GraphOutput class to use
{GraphOutput} outputs getoutputs ( ) List the node's outputs
it iterator inputs ( ) An iterator on node's outputs
it iterator inputs ( ) An iterator on node's inputs
bool isparent isgraphparent ( GraphNode other ) 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.)
nil removeinput ( name string ) Remove a GraphInput of the node
nil removeoutput ( name string ) 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:

nil onpathchanged ( ) Called by the framework when the name of this node or of one of its parent is modified
any value eval ( Plug plug ) Called by the framework when plug (a node's plug) must be evaluated
boolean state isselected ( ) Tell if the node is selected
Node parent getparent ( ) Get the parent Node of this Node
boolean result isparent ( Node child ) Tells if this node is parent of the potential child
Node parent findparent ( string name ) Find the first parent Node of this Node of a specific class
string path getpath ( ) Returns the node path as a string that can be reused with findchild
Node|Plug child findchild ( string path ) Find a child node or plug using a path
nil move ( Node parent ) Move a node to a new parent
nil delete ( ) Delete a node
nil rename ( string name ) Rename a node
[string|number] name getname ( ) Get the Node name in its parent
Node result getchild ( string name ) Get a child node by its name
boolean result isreference ( ) Tells if a node comes from a reference project
Reference reference getreference ( ) Returns the reference node it is connected to
Reference reference gettopreference ( ) Returns the top reference node it is connected to
bool result belongstoreference ( Reference ref ) Tells if the node belongs to the reference, or a sub reference
{Node} result loadfile ( string filename , [ table options ] ) load a file content in this node. Possible options are: overrideclass to enforce a specific class for the root node.
ReferenceBase refnode referencefile ( string name , string refpath , [ table options ] ) reference a file content in this node.
Node result loadtemplate ( string template , string name ) load a template file
bool,string success,error savefile ( string filename ) load a node to a file
string result getstringcopy ( ) Return a copy of the node and its content as a string to be pasted
nil setflags ( ) Set the node flags
bool result ismoveable ( ) Tells if the node can be moved
{Node},string result,error pastestringcopy ( string copy ) Paste a string copy into this node
of table getreferences ( [ topref Reference ] ) Returns the references in the document sorted depth first.
boolean editable iseditable ( ) Indicates if the node can be edited by the user in the UI
nil seteditable ( boolean editable ) Change the editable state of the node

Documentation

GraphInput input createinput ( )

Create a GraphInput in the node

This method creates a new GraphInput in the node, after the last existing one. This method requires the getinputclassname method to be implemented.
Return:

  • input The created input

GraphOutput output createoutput ( )

Create a GraphOutput in the node

This method creates a new GraphOutput in the node, after the last existing one. This method requires the getoutputclassname method to be implemented.
Return:

  • output The created output

GraphInput input getinput ( string name )

Get an input by its name

Arguments:

  • name The name of the input to get

Return:

  • input The input with matching name

string classname getinputclassname ( )

Return the name of the GraphInput class to use

Return:

  • classname The class name

{GraphInput} inputs getinputs ( )

List the node's inputs

Return:

  • inputs The array of inputs in the node

GraphOutput output getoutput ( string name )

Get an output by its name

Arguments:

  • name The name of the output to get

Return:

  • output The output with matching name

string classname getoutputclassname ( )

Return the name of the GraphOutput class to use

Return:

  • classname The class name

{GraphOutput} outputs getoutputs ( )

List the node's outputs

Return:

  • outputs The array of outputs in the node

it iterator inputs ( )

An iterator on node's outputs

Return:

  • iterator

it iterator inputs ( )

An iterator on node's inputs

Return:

  • iterator

bool isparent isgraphparent ( GraphNode other )

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.)

Arguments:

  • other The other node

Return:

  • isparent

nil removeinput ( name string )

Remove a GraphInput of the node

Arguments:

  • string The name of the input to remove

nil removeoutput ( name string )

Remove a GraphOutput of the node

Arguments:

  • string The name of the output to remove