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
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 |
| connect | (
|
Connect a shader node output into this input |
| disconnect | ( ) | Disconnect this input from its output |
| getconnected | ( ) | get the connected shader node input or output |
| isexposed | ( ) | Tell if the plug is exposed |
| setexposed | (
|
Expose this plug |
Inherited from class Node
string | Name | RW | The node name |
| 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 |
| isindocument | ( ) | Tells if the node is inside a document, or is pending in the void |
| 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 type descriptor of the input Value
The visibility of the ShaderNodeIn
The connection to the parent ShaderNodeOut.
The display name of the ShaderNodeIn
The value of the shader node Plug when not connected to a ShadeNodeOut
Connect a shader node output into this input
output the output to plug into this input
Disconnect this input from its output
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
connection the plug connected into this input
Tell if the plug is exposed
exposed
Expose this plug
expose Indicates if the plug must be exposed