ScriptNode Class Reference

The ScriptNode JavaScript global object. Provides special methods for script nodes. More...

Public Slots

String readNodePath (String &scriptNodeName)
 Returns the node path of the element/read node connected as an input to the script node. More...
 
QScriptValue inputContexts (String &scriptNodeName, double frame=0.0, String &display=String())
 Returns a list of Params3d objects, one element per each transversal paths to the script node from the target display node. Each path may contain specific transformations, and subnode animation transformations, particular to it. More...
 

Detailed Description

The ScriptNode JavaScript global object. Provides special methods for script nodes.

The ScriptNode class provides special methods for interacting with script nodes, in specific, script nodes used for external rendering.

Member Function Documentation

◆ inputContexts

QScriptValue ScriptNode::inputContexts ( String &  scriptNodeName,
double  frame = 0.0,
String &  display = String() 
)
slot

Returns a list of Params3d objects, one element per each transversal paths to the script node from the target display node. Each path may contain specific transformations, and subnode animation transformations, particular to it.

Parameters
scriptNodeName: The name of a script node (Note: E.g. a Blender/Maya script node).
frame: The frame on which to get the contexts. If left empty, the current frame will be used.
display: The name of the target display node. If left empty, the default display will be used.
Returns
Returns a list of Params3d objects.

◆ readNodePath

String ScriptNode::readNodePath ( String &  scriptNodeName)
slot

Returns the node path of the element/read node connected as an input to the script node.

Parameters
scriptNodeName: The name of a script node (Note: E.g. a Blender/Maya script node).
Returns
Returns the node path of the element node, empty otherwise.