RenderLayerΒΆ
class RenderLayer
A Layer output node
Hierarchy
class RenderLayer < class ShaderOutputNode < class ShaderNode < class SelectableNode < class Node
Members
Plugs:
types.bool | Disabled | RW | Disables the rendering of this output when true |
types.bool | Solo | RW | Is the group in the solo mode ? |
Methods:
| addaov | (
|
Add a new AOV |
Inherited from class ShaderNode
Plugs:
string | Code | RW | The shader node default BOOTS code |
string | CodeRT | RW | The shader node BOOTS code specialized for OpenGL |
{float,float} | NodePos | RW | The shader node position in shader view |
boolean | Collapsed | RW | The shader node collapse state, true for collapsed, false for expanded |
Methods:
| getinput | (
|
Gets a child ShaderNodeIn plug by its display name |
| getoutput | (
|
Gets a child ShaderNodeOut plug by its display name |
| createinput | (
|
Create a new input |
| removeinput | (
|
Remove an input |
| createoutput | (
|
Create a new output |
| removeoutput | (
|
Remove an output |
| addnode | (
|
add a node into a shader node by its filename |
| fillnodetemplateheader | (
|
Fill the template with standard node template header, like inputs |
| fillnodetemplatefooter | (
|
Fill the template with standard node template footer, like inputs and outputs settings |
| fillnodetemplate | (
|
Fill the template with custom attributes |
| fillnodefooter | (
|
Fill the template footer with custom attributes |
| fillnodeinputstemplate | (
|
Fill the template with inputs and ouputs extended controls |
| addaov | ( ) | create a new aov |
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:
| 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
Disables the rendering of this output when true
Is the group in the solo mode ?
If at least one render pass is in the solo mode, only those passes will be computed.
If no render pass are in the solo mode, all the render passes are computed.
Add a new AOV
Arguments:
settings The settings to use, see also LayerOut setaov