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:

nil

addaov

( {string|table} settings )

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:

ShaderNodeIn input	getinput	( string name )	Gets a child ShaderNodeIn plug by its display name
ShaderNodeOut input	getoutput	( string name )	Gets a child ShaderNodeOut plug by its display name
ShaderNodeIn input	createinput	( string name , type type )	Create a new input
nil	removeinput	( string name )	Remove an input
ShaderNodeOut input	createoutput	( string name )	Create a new output
nil	removeoutput	( string name )	Remove an output
ShaderNode result	addnode	( string filename )	add a node into a shader node by its filename
nil	fillnodetemplateheader	( table template )	Fill the template with standard node template header, like inputs
nil	fillnodetemplatefooter	( table template )	Fill the template with standard node template footer, like inputs and outputs settings
nil	fillnodetemplate	( table template )	Fill the template with custom attributes
nil	fillnodefooter	( table template )	Fill the template footer with custom attributes
nil	fillnodeinputstemplate	( table template )	Fill the template with inputs and ouputs extended controls
ShaderNodeIn aov	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:

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 , [ table options ] )	load a file content in this node. Possible options are: overrideclass to enforce a specific class for the root 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
ReferenceBase refnode	referencefile	( string name , string refpath , [ table options ] )	reference a file content in 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

types.bool Disabled RW

Disables the rendering of this output when true

---

types.bool Solo RW

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.

---

nil addaov ( {string|table} settings )

Add a new AOV

Arguments:

• settings The settings to use, see also LayerOut setaov

---