GraphInputΒΆ

class GraphInput

An input in a GraphNode

Hierarchy

class GraphInput < class GraphPlug < class Node

Children classes : class RenderGraphInput

Members

Methods:

nil connect ( GraphOutput output ) Override Connect an output to this input
nil disconnect ( ) Override Disconnect whatever is connected to this input
GraphInput|GraphOutput connected getconnected ( ) Override Get whatever is connected to this input
GraphOutput connected getconnectedoutput ( ) Get the connected output (an exposed input returns nil in this case)
bool exposed isexposed ( ) Override Indicate if this input is exposed in the parent macro/graph
bool true isinput ( ) Returns true
nil setexposed ( bool state ) Override Expose/unexpose the input in the parent macro/graph

Inherited from class GraphPlug

Methods:

Plug nameplug getnameplug ( ) Override Return the node's plug that contains the name of the GraphPlug
Plug plug getconnectionplug ( ) Override Return the node's plug that is used to connect to another GraphPlug

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

nil connect ( GraphOutput output )

Override Connect an output to this input

Arguments:

  • output The output to connect to this input

nil disconnect ( )

Override Disconnect whatever is connected to this input

GraphInput|GraphOutput connected getconnected ( )

Override Get whatever is connected to this input

Return:

  • connected

GraphOutput connected getconnectedoutput ( )

Get the connected output (an exposed input returns nil in this case)

Return:

  • connected

bool exposed isexposed ( )

Override Indicate if this input is exposed in the parent macro/graph

Return:

  • exposed

bool true isinput ( )

Returns true

Return:

  • true

nil setexposed ( bool state )

Override Expose/unexpose the input in the parent macro/graph

Arguments:

  • state