RenderGraph¶

class RenderGraph

A RenderGraph controls the attributes assigned to an object to render

Hierarchy

class RenderGraph < class Graph < class SelectableNode < class DeletableNode < class Node

Members

types.table	CurrentNode	RW	The currently active node
types.string	CurrentPath	RW	The currently active path
types.tags	CurrentTags	RW	The currently active tags
types.bool	Enabled	RW	Enable/disable the rendergraph
nil	Exposed	RW	Dependencies on exposed nodes' Name plug
types.int	Order	RW	Evaluation order oh this rendergraph. Note that the rendergraphs from the references are evaluated first whatever their order.
nil	RenderGraph	RW	The connections to RenderPasses
types.string	SelectionPath	R	The path of the first currently selected node
types.table	SelectionTags	R	The currently selected tags
types.bool	UseCache	RW	Use pattern matching cache during traversal
types.bool	WarnOnMultipleOutputs	RW	Issue a warning if the RenderGraph has multiple outputs

---

Inherited from class Graph

result GraphNode

createmixnode

( )

This method is called when the user wants to combine two outputs or an output and a connection.

---

Inherited from class SelectableNode

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

string

Name

RW

The node name

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

types.table CurrentNode RW

The currently active node

---

types.string CurrentPath RW

The currently active path

---

types.tags CurrentTags RW

The currently active tags

---

types.bool Enabled RW

Enable/disable the rendergraph

---

nil Exposed RW

Dependencies on exposed nodes' Name plug

---

types.int Order RW

Evaluation order oh this rendergraph. Note that the rendergraphs from the references are evaluated first whatever their order.

---

nil RenderGraph RW

The connections to RenderPasses

---

types.string SelectionPath R

The path of the first currently selected node

---

types.table SelectionTags R

The currently selected tags

---

types.bool UseCache RW

Use pattern matching cache during traversal

---

types.bool WarnOnMultipleOutputs RW

Issue a warning if the RenderGraph has multiple outputs

---