ShaderNodeInΒΆ

class ShaderNodeIn

A ShaderNode input plug, containing information about plug connection to an output, value, type, etc.

Hierarchy

class ShaderNodeIn < class Node

Children classes : class LayerOut , class ShaderNodeExtOut

Members

Plugs:

type Desc RW The type descriptor of the input Value
boolean HideInput RW The visibility of the ShaderNodeIn
nil Plug RW The connection to the parent ShaderNodeOut.
string PlugName RW The display name of the ShaderNodeIn
[float|table] Value RW The value of the shader node Plug when not connected to a ShadeNodeOut

Methods:

nil connect ( ShaderNodeOut output ) Connect a shader node output into this input
nil disconnect ( ) Disconnect this input from its output
ShaderNodeOut|ShaderNodeIn connection getconnected ( ) get the connected shader node input or output
boolean exposed isexposed ( ) Tell if the plug is exposed
nil setexposed ( boolean expose ) Expose this plug

Inherited from class Node

Plugs:

string Name RW The node name

Methods:

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

Documentation

type Desc RW

The type descriptor of the input Value

boolean HideInput RW

The visibility of the ShaderNodeIn

nil Plug RW

The connection to the parent ShaderNodeOut.

string PlugName RW

The display name of the ShaderNodeIn

[float|table] Value RW

The value of the shader node Plug when not connected to a ShadeNodeOut

nil connect ( ShaderNodeOut output )

Connect a shader node output into this input

This method connects the given ShaderNodeOut into the ShaderNodeIn. The input is unexposed if it was exposed, and disconnected if it was connected to another output. This method throws error if the output is not a ShaderNodeOut, if the connection results in a cyclic shading network or if the connected nodes don't belong to the same parent Shader/ShaderNode.
Arguments:

  • output the output to plug into this input

nil disconnect ( )

Disconnect this input from its output

ShaderNodeOut|ShaderNodeIn connection getconnected ( )

get the connected shader node input or output

This method returns the connected plug into this plug. The connected plug may be either an output if a node output is connected into this plug, or a input if the plug is exposed. Use isexposed to check if the plug is exposed.

-- enumerate all input connections
 for input in children (Document, "ShaderNodeIn", nil, true) do
    local connected = input:getconnected ()
    if connected then
        if input:isexposed () then
            print (input:getpath () .. " exposed, connected to " .. connected:getpath ())
        else
            print (input:getpath () .. "  connected to " .. connected:getpath ())
        end
    end
end
Return:

  • connection the plug connected into this input

boolean exposed isexposed ( )

Tell if the plug is exposed

Return:

  • exposed

nil setexposed ( boolean expose )

Expose this plug

Arguments:

  • expose Indicates if the plug must be exposed