node Class Reference

The node JavaScript global object. More...

Public Slots

Node Data.
String root ()
 returns the name of the Top level in the Node View, which is "Top". More...
 
bool isGroup (String &node)
 Return a true or false value indicating if the node is a Group. More...
 
String getName (String &node)
 Return the name of a node. More...
 
String type (String node)
 Return the node type. These are all of the built-in node types available from the Stage node like: READ, COMPOSITE, PEG, QUADMAP, SHADOW, etc. More...
 
int numberOfSubNodes (String &parent)
 Return an integer that indicates the number of nodes contained in a group. More...
 
QScriptValue subNodes (String &parentGroup)
 Return an array of sub nodes. More...
 
String subNode (String &parent, int iSubNode)
 Return the path of a node in a group. Nodes are counted starting with zero. More...
 
String subNodeByName (String &parent, String name)
 Return the full path name of a child node belonging to a parent group. More...
 
String parentNode (String &node)
 Return the path of the parent level of a node contained in a group. More...
 
String noNode ()
 Return the node path to an invalid node. More...
 
bool equals (String node1, String node2)
 Return true or false to indicate if a node path is equal to another. Used to compare node paths. More...
 
String getTextAttr (String node, double atFrame, String attrName)
 Return the value(s) of the node selected attribute(s). More...
 
AttributegetAttr (String node, double atFrame, String attrName)
 Return the Attribute of the given node. The attribute value is for the given frame. More...
 
QList< Attribute * > getAttrList (String node, double atFrame, String attrName=String::null)
 Return a list of Attribute objects of the given node. More...
 
String linkedColumn (String node, String attrName)
 Return the name of the column that an attribute is linked to. If the attribute is not linked to a column, the method returns the null string. More...
 
virtual int coordX (String node)
 Return an integer indicating the X position of a node in the Node View. More...
 
virtual int coordY (String node)
 Return an integer indicating the Y position of a node in the Node View. More...
 
virtual int coordZ (String node)
 Return an integer indicating the Z position of a node in the Node View. More...
 
virtual int width (String node)
 Return the width of a given node. More...
 
virtual int height (String node)
 Return the height of a given node. More...
 
virtual bool setCoord (String node, int x, int y)
 Set the position of a node in the Node View. More...
 
virtual bool setCoord (String node, int x, int y, int z)
 Set the position of a node in the Node View. More...
 
int numberOfInputPorts (String node)
 The number of input ports on the node. More...
 
bool isLinked (String node, int iPort)
 Return true or false to indicate if a port is connected to another node. More...
 
String srcNode (String node, int iPort)
 Return the path for the node that the port is linked to. More...
 
String flatSrcNode (String node, int iPort)
 If the srcNode is a Group, this method returns the path of the node inside the Group node that is the source. If the source is not inside a group, the flatSrcNode method behaves like the srcNode method. More...
 
QScriptValue srcNodeInfo (String &node, int iPort)
 Return the source node path, the port number and the link ID for this destination node is connected to. More...
 
int numberOfOutputPorts (String node)
 The number of output ports on a node. More...
 
int numberOfOutputLinks (String node, int iPort)
 The number of nodes actually linked from the output ports. More...
 
String dstNode (String sourceNode, int iPort, int iLink)
 Return the path of the destination node linked to by the output port on the source node. More...
 
QScriptValue dstNodeInfo (String &sourceNode, int iPort, int iLink)
 Return the path and addition information of the destination node linked to the source node. More...
 
bool groupAtNetworkBuilding (String node)
 Return true if the peg's groupAtNetworkBuilding attribute is true. More...
 
bool addCompositeToGroup (String node)
 Return the value of the "Add Composite To Group" attribute of the peg-node. This method is obsolete. More...
 
Node Editing
String add (String parentGroup, String name, String type, int x, int y, int z)
 Add a node to the Node View. More...
 
String getGroupInputModule (String parentGroup, String name, int x, int y, int z)
 Return existing or add a group multi port in node. More...
 
String getGroupOutputModule (String parentGroup, String name, int x, int y, int z)
 Return existing or add a group multi port out node. More...
 
bool deleteNode (String nodePath, bool deleteTimedValues=false, bool deleteElements=false)
 Delete a single node. Optionally, delete all columns and element associated to that node. The column and element would only be removed when no other nodes refer to them. More...
 
String createGroup (String nodes, String groupName)
 Create a group from the selection of nodes. The list of nodes is a string where the nodes are separated by commas. The actual name of each node in the list of nodes must include the full path of that node. More...
 
String moveToGroup (String nodeName, String groupName)
 Move the specified node within the specified group. More...
 
bool explodeGroup (String groupName)
 Explode a group into its parent group. This method is identical to the "Explode Selected Group" from the Node View. More...
 
bool rename (String node, String newName)
 Change the name of a node. More...
 
bool createDynamicAttr (String node, String type, String attrName, String displayName, bool linkable)
 Create a new attribute for the given node. More...
 
bool removeDynamicAttr (String node, String attrName)
 Remove a dynamic attribute for the given node. More...
 
bool setTextAttr (String node, String attrName, int atFrame, String attrValue)
 Change the value of an attribute in a node. More...
 
bool linkAttr (String node, String attrName, String columnName)
 Link an attribute to a function column in the Xsheet View. More...
 
bool unlinkAttr (String node, String attrName)
 Unlink an attribute from a function column. More...
 
bool link (String srcNode, int srcPort, String dstNode, int dstPort)
 Link a port on a node to a port on another node. More...
 
bool link (String srcNode, int srcPort, String dstNode, int dstPort, bool mayAddOutputPort, bool mayAddInputPort)
 Link a port of a node to a port of another node. This version of the method allows connecting to a group node, or setup the proper connection order. More...
 
bool unlink (String dstNode, int inPort)
 Unlink a port on one node from the port on another node. More...
 
bool setEnable (String node, bool flag)
 Setters and getters for the enable/disable property of a node. More...
 
bool getEnable (String node)
 Return whether a node is enabled or not. More...
 
bool setLocked (String node, bool lock)
 Setters and getters for the lock/unlock property of a node. More...
 
bool getLocked (String node)
 Return the lock flag. More...
 
bool setTimelineTag (String node, bool tag)
 Set the timeline tag flag. More...
 
bool getTimelineTag (String node)
 Return the timeline tag flag. More...
 
StringList getTimelineTagList (String node=QNTR("Top"), StringList list=StringList())
 
bool setColor (String node, ColorRGBA *color)
 Set the node color. More...
 
bool resetColor (String node)
 Reset the node color. More...
 
ColorRGBAgetColor (String node)
 Return the node color. More...
 
bool setAsGlobalDisplay (String node)
 Change the global display used in the application. The node must be the full path of a display node. More...
 
bool setGlobalToDisplayAll ()
 Change the global display used by the application to "Display All" pseudo-display. More...
 
bool setAsDefaultCamera (String node)
 Setters and getters for the default camera. More...
 
String getDefaultCamera ()
 Return the name of the default camera. More...
 
StringList getCameras ()
 Return a list of all cameras within the scene. More...
 
int getMaxVersionNumber (String node)
 
int getVersion (String node)
 
void setVersion (String node, int version)
 
StringList getNodes (StringList &types)
 Return a collection of node paths for nodes of specified types. More...
 
QObject * getMatrix (String node, int frame)
 Return the model matrix of a node. More...
 
QObject * getPivot (String node, int frame)
 Return the pivot of the node. More...
 
ColorOverridegetColorOverride (String node)
 Return the ColorOverride object for the colour override node. More...
 
int getElementId (String nodeName)
 
void explodeElementSymbolsInGroups (String element, bool disableElement, bool clearExposure, String &prefix=String())
 Create a group for each exposure of the element where there is a symbol and will put the content of the symbol in that group. If disable element is TRUE, will disable the element afterwards. If clearExposure is TRUE, will clear the exposures where there were symbols afterwards. Will use prefix as the prefix for the generated group names. More...
 
bool setShowTimelineThumbnails (String node, bool bShow)
 Set the show/hide timeline thumbnails on drawing layers. More...
 
bool getShowTimelineThumbnails (String node)
 Return the show/hide timeline thumbnails flags on drawing layers. More...
 

Detailed Description

The node JavaScript global object.

Nodes are synonymous with Filter, IO, Move and Group in the Node View. With node methods, retrieve values from nodes, effects and composite. Add, link or set their attributes. Nodes can have identical names, so, their full path is needed to identify a them. The full path always starts with the root group name with is Top. Then, the other parent group names follow it separated by a "/". e.g. "Top/MyFirstGroup/MySecondGroup/MyNodeName". The nomenclature is a bit confusing, but node name methods use the path as the node name most of the time. The parentNode method from this class adds the Composite node in the parent group of the selected nodes. The link method, in a loop, connects all selected nodes to the new Composite node. The setCoord method positions a new node in the Node View. The syntax for a node paths is: "Top/Group_Name/Node_Name"

function compose()
{
var n = election.numberOfNodesSelected();
var i, posx, posy;
if (n > 0)
{
var comp = node.add( node.parentNode(selection.selectedNode(0)), "comp", "COMPOSITE", 0, 0, 0);
posx = 0;
posy = -10000;
for (i = 0; i < n; ++i)
{
var selNode = selection.selectedNode(i);
node.link(selNode, 0, comp, i);
posx += node.coordX(selNode);
if (node.coordY(selNode) > posy)
posy = node.coordY(selNode);
}
posx /= n;
posy += 50;
node.setCoord(comp, posx, posy)
}

Member Function Documentation

◆ add

String node::add ( String  parentGroup,
String  name,
String  type,
int  x,
int  y,
int  z 
)
slot

Add a node to the Node View.

Parameters
parentGroupThe path of the parent node into which you want to add this node
nameThe name of the node you will add.
typeThe type of node you will add. The node types are like: READ, COMPOSITE, PEG, QUADMAP, SHADOW, etc.
x: The X position of the node in the Node View.
y: The Y position of the node in the Node View.
z: The Z position of the node in the Node View. This property is important when two nodes overlap

◆ addCompositeToGroup

bool node::addCompositeToGroup ( String  node)
slot

Return the value of the "Add Composite To Group" attribute of the peg-node. This method is obsolete.

Parameters
nodethe path of the node

◆ coordX

virtual int node::coordX ( String  node)
virtualslot

Return an integer indicating the X position of a node in the Node View.

Parameters
nodethe path of the node

◆ coordY

virtual int node::coordY ( String  node)
virtualslot

Return an integer indicating the Y position of a node in the Node View.

Parameters
nodethe path of the node

◆ coordZ

virtual int node::coordZ ( String  node)
virtualslot

Return an integer indicating the Z position of a node in the Node View.

Parameters
nodethe path of the node

◆ createDynamicAttr

bool node::createDynamicAttr ( String  node,
String  type,
String  attrName,
String  displayName,
bool  linkable 
)
slot

Create a new attribute for the given node.

Parameters
nodeThe name of the node.
typeType of attribute to create.
attrNameThe name of the attribute.
displayNameThe name of the attribute as it will appear in the UI
linkableLinkable status.

◆ createGroup

String node::createGroup ( String  nodes,
String  groupName 
)
slot

Create a group from the selection of nodes. The list of nodes is a string where the nodes are separated by commas. The actual name of each node in the list of nodes must include the full path of that node.

The parent of the group is implicitly specified. It will be the same as the parent of the first node in the list.

Parameters
nodesThis a comma delimited list of names of nodes. ( node0,node1,node2)
groupNameThe name of the group to create. The actual group
Returns
The full path of the created group, or an empty string if the creation of the node failed.

◆ deleteNode

bool node::deleteNode ( String  nodePath,
bool  deleteTimedValues = false,
bool  deleteElements = false 
)
slot

Delete a single node. Optionally, delete all columns and element associated to that node. The column and element would only be removed when no other nodes refer to them.

Parameters
nodePaththe path of the node
deleteTimedValuesA boolean that indicates if the columns referenced by that node shall be removed if they are no longer in use.
deleteElementsA boolean that indicates if the element should also be removed, if they are no longer in use.
Returns
True when successful.

◆ dstNode

String node::dstNode ( String  sourceNode,
int  iPort,
int  iLink 
)
slot

Return the path of the destination node linked to by the output port on the source node.

Parameters
sourceNodethe path of the node
iPortThe port number on which you want to find the connected node. This value is between 0 and the results of the numberOfOutputPorts method.
iLinkThe link number whose destination node you want to find. This value is between 0 and the results of the numberOfOutputLinks method.

◆ dstNodeInfo

QScriptValue node::dstNodeInfo ( String &  sourceNode,
int  iPort,
int  iLink 
)
slot

Return the path and addition information of the destination node linked to the source node.

Parameters
sourceNode: the path of the source node.
iPortthe output port number on which you want to find the connected node. This value is between 0 and the results of the numberOfOutputPorts method.
iLinkthe link number whose destination node you want to find. This value is between 0 and the results of the numberOfOutputLinks method.

This method returns an object that contains two attributes node - the path to connected node. port - the port number on which this node is connected to.

◆ equals

bool node::equals ( String  node1,
String  node2 
)
slot

Return true or false to indicate if a node path is equal to another. Used to compare node paths.

Parameters
node1the path of the first node
node2the path of the second node

◆ explodeElementSymbolsInGroups

void node::explodeElementSymbolsInGroups ( String  element,
bool  disableElement,
bool  clearExposure,
String &  prefix = String() 
)
slot

Create a group for each exposure of the element where there is a symbol and will put the content of the symbol in that group. If disable element is TRUE, will disable the element afterwards. If clearExposure is TRUE, will clear the exposures where there were symbols afterwards. Will use prefix as the prefix for the generated group names.

Parameters
elementelement node path
disableElementdisable the exploded element
clearExposureclear the exposure.
prefixadd a prefix to the symbols.

◆ explodeGroup

bool node::explodeGroup ( String  groupName)
slot

Explode a group into its parent group. This method is identical to the "Explode Selected Group" from the Node View.

Parameters
groupNamethe name of the node
Returns
True if successful

◆ flatSrcNode

String node::flatSrcNode ( String  node,
int  iPort 
)
slot

If the srcNode is a Group, this method returns the path of the node inside the Group node that is the source. If the source is not inside a group, the flatSrcNode method behaves like the srcNode method.

Parameters
nodethe path of the node
iPortthe port number on the destination node whose source node you want to find. This value is between 0 and the results of the numberOfInputPorts method.

◆ getAttr

Attribute* node::getAttr ( String  node,
double  atFrame,
String  attrName 
)
slot

Return the Attribute of the given node. The attribute value is for the given frame.

var myAttribute = node.getAttr("Top/myPeg", frame.current(), "POSITION.X");
MessageLog.trace(myAttribute.doubleValue());
Parameters
nodeThe path to the node
atFrameThe frame number at which the attribute value is extracted. This parameter isn't used if the value isn't animated (a local value).
attrNameThe name of the attribute. Access a child attribute by concatenating the parent attribute name with the child name separated by a dot ('.').
Returns
The attribute of the given name.

◆ getAttrList

QList<Attribute*> node::getAttrList ( String  node,
double  atFrame,
String  attrName = String::null 
)
slot

Return a list of Attribute objects of the given node.

Parameters
nodeThe path to the node
atFrameThe frame number at which the attribute value is extracted. This parameter isn't used if the value isn't animated (a local value).
attrNameThe name of the attribute or an empty string for all top level attributes. Access a child attribute by concatenating the parent attribute name with the child name separated by a dot ('.').
Returns
The list of Attribute objects.

◆ getCameras

StringList node::getCameras ( )
slot

Return a list of all cameras within the scene.

◆ getColor

ColorRGBA* node::getColor ( String  node)
slot

Return the node color.

Parameters
nodethe name of the node.

◆ getColorOverride

ColorOverride* node::getColorOverride ( String  node)
slot

Return the ColorOverride object for the colour override node.

Parameters
nodethe name of the node
Returns
ColorOverride object

◆ getDefaultCamera

String node::getDefaultCamera ( )
slot

Return the name of the default camera.

◆ getElementId

int node::getElementId ( String  nodeName)
slot

Return the Element Id of the Node. Has to be an element node, identified with type :: READ Return -1 on fail.

◆ getEnable

bool node::getEnable ( String  node)
slot

Return whether a node is enabled or not.

Parameters
nodethe name of the node

◆ getGroupInputModule

String node::getGroupInputModule ( String  parentGroup,
String  name,
int  x,
int  y,
int  z 
)
slot

Return existing or add a group multi port in node.

◆ getGroupOutputModule

String node::getGroupOutputModule ( String  parentGroup,
String  name,
int  x,
int  y,
int  z 
)
slot

Return existing or add a group multi port out node.

◆ getLocked

bool node::getLocked ( String  node)
slot

Return the lock flag.

Parameters
nodethe name of the node

◆ getMatrix

QObject* node::getMatrix ( String  node,
int  frame 
)
slot

Return the model matrix of a node.

Parameters
nodethe name of the node
frameis the int that specifies the frame number

◆ getMaxVersionNumber

int node::getMaxVersionNumber ( String  node)
slot

Returns the number of versions of the node available.

Parameters
node: the name of the node

◆ getName

String node::getName ( String &  node)
slot

Return the name of a node.

Parameters
nodethe path of the node

◆ getNodes

StringList node::getNodes ( StringList &  types)
slot

Return a collection of node paths for nodes of specified types.

Parameters
typeslist of node types to search for

Example usage:

var sl = ["READ", "WRITE", "COLOR_OVERRIDE_TVG"];
var nl = node.getNodes(sl);
for (var i = 0; i < nl.length; ++i)
{
var path = nl[[i];
if (node.type(path) == "COLOR_OVERRIDE_TVG")
{
System.println("Colour Override: " + node.getName(path));
var conode = node.getColorOverride(path);
}
else if (node.type(path) == "READ")
{
System.println("Read: " + node.getName(path));
}
else if (node.type(path) == "WRITE")
{
System.println("Write: " + node.getName(path));
}
}

◆ getPivot

QObject* node::getPivot ( String  node,
int  frame 
)
slot

Return the pivot of the node.

Parameters
nodethe name of the node
frameis the int that specified the frame number
Returns
3d point

◆ getShowTimelineThumbnails

bool node::getShowTimelineThumbnails ( String  node)
slot

Return the show/hide timeline thumbnails flags on drawing layers.

Parameters
nodeThe name of the node.

◆ getTextAttr

String node::getTextAttr ( String  node,
double  atFrame,
String  attrName 
)
slot

Return the value(s) of the node selected attribute(s).

Parameters
nodethe path of the node
atFramethe frame number from which you want to extract the attribute value. If the value is static, you must still pass a value. You can, for example, pass 1 to take the value at the first frame.
attrNameThe attribute whose value you want.

Use the attribute PALETTES.NUMBER to return the number of palettes in the colour override node palette list. Use the attribute PALETTES.x to return the palette at index x from the colour override node palette list. x is a number between 0 and the number of palettes in the list, minus one. If x is not given (argument is "PALETTES") or x is not valid (< 0 or out of range) then 0 is assumed.

◆ getTimelineTag

bool node::getTimelineTag ( String  node)
slot

Return the timeline tag flag.

Parameters
nodethe name of the node

◆ getTimelineTagList

StringList node::getTimelineTagList ( String  node = QNTR("Top"),
StringList  list = StringList() 
)
slot

◆ getVersion

int node::getVersion ( String  node)
slot

Return the current version of the node. The node may have multiple versions if their rendering output have changed over time.

Parameters
nodethe name of the node

◆ groupAtNetworkBuilding

bool node::groupAtNetworkBuilding ( String  node)
slot

Return true if the peg's groupAtNetworkBuilding attribute is true.

Parameters
nodethe path of the node

◆ height

virtual int node::height ( String  node)
virtualslot

Return the height of a given node.

This width / height parameter is useful for computing the position of nodes in the Node View. It uses the same unit system as the coordX() and coordY() methods.

Parameters
nodethe path of the node

◆ isGroup

bool node::isGroup ( String &  node)
slot

Return a true or false value indicating if the node is a Group.

Parameters
nodethe path of the node

◆ isLinked

bool node::isLinked ( String  node,
int  iPort 
)
slot

Return true or false to indicate if a port is connected to another node.

Parameters
nodethe path of the node
iPortThe number of the port whose link status you want to check. This value is between 0 and the results of the numberOfInputPorts method.

◆ link [1/2]

bool node::link ( String  srcNode,
int  srcPort,
String  dstNode,
int  dstPort 
)
slot

Link a port on a node to a port on another node.

Parameters
srcNodeThe path of the node whose output port you want to link to a destination node.
srcPortThe port that you want to link to the input port on the destination node. This value is between 0 and the results of the numberOfOutputPorts method.
dstNodeThe path of the node whose input port you want to link to the source node.
dstPortThe port on the destination node that you want to link to the output port from the source node. This value is between 0 and the results of the numberOfInputPorts method.

◆ link [2/2]

bool node::link ( String  srcNode,
int  srcPort,
String  dstNode,
int  dstPort,
bool  mayAddOutputPort,
bool  mayAddInputPort 
)
slot

Link a port of a node to a port of another node. This version of the method allows connecting to a group node, or setup the proper connection order.

// Get a node parent and children. The node will be inserted in a group and the parent/children will be connected to the group.
var myNewGroupPath = "Top/MyGroup/MyNewGroup";
var myNodePath = "Top/MyGroup/Drawing";
var srcNodePath = node.srcNode(myNodePath, 0);
var dstNodePaths = [];
for(var i = 0; i < node.numberOfOutputLinks(myNodePath, 0); i++)
{
dstNodePaths.push(node.dstNode(myNodePath, 0, i));
}
// Move the node into the group.
// moveToGroup creates a composite on which to connect the READ node automatically.
node.moveToGroup(myNodePath, myNewGroupPath);
// Connect the new group to the parent/children of the node.
node.link(srcNodePath, 0, myNewGroupPath, 0, false, true);
for(var i = 0; i < dstNodePaths.length; i++)
{
node.link(myNewGroupPath, 0, dstNodePaths[i], 0, true, true);
}
Parameters
srcNodeThe path of the node whose output port you want to link to a destination node.
srcPortThe port that you want to link to the input port on the destination node. This value is between 0 and the results of the numberOfOutputPorts method.
dstNodeThe path of the node whose input port you want to link to the source node.
dstPortThe port on the destination node that you want to link to the output port from the source node. This value is between 0 and the results of the numberOfInputPorts method.
mayAddOutputPortused by group multiport nodes - automatically create a new output port for these nodes.
mayAddInputPortused by group multiport and composite - automatically create input ports for these nodes.

◆ linkAttr

bool node::linkAttr ( String  node,
String  attrName,
String  columnName 
)
slot

Link an attribute to a function column in the Xsheet View.

Parameters
nodeThe name of the node
attrNameThe name of the attribute
columnNameThe name of the column that you want to link to the attribute

◆ linkedColumn

String node::linkedColumn ( String  node,
String  attrName 
)
slot

Return the name of the column that an attribute is linked to. If the attribute is not linked to a column, the method returns the null string.

Parameters
nodethe path of the node
attrNameThe attribute you want to check to see if it is linked to a column

◆ moveToGroup

String node::moveToGroup ( String  nodeName,
String  groupName 
)
slot

Move the specified node within the specified group.

This method is equivalent to the drag and drop of a node to a group from the timeline. If an element node is moved into a group, a composite node will automatically be created to connect the element node.

node.moveToGroup("Top/MyGroup/Drawing", "Top/MyGroup/MyNewGroup");
Parameters
nodeNameThe path to the node to group.
groupNameThe path of the target group.

◆ noNode

String node::noNode ( )
slot

Return the node path to an invalid node.

Methods that return a node path will return this value if an error occurred.

var parentNodePath = node.parentNode("Top/MyNode");
if(parentNodePath == node.noNode())
return; // something wrong happened

◆ numberOfInputPorts

int node::numberOfInputPorts ( String  node)
slot

The number of input ports on the node.

Parameters
nodethe path of the node

◆ numberOfOutputLinks

int node::numberOfOutputLinks ( String  node,
int  iPort 
)
slot

The number of nodes actually linked from the output ports.

Parameters
nodethe path of the node
iPortThe port number on which you want to locate the node that is connected to it. This value is between 0 and the results of the numberOfInputPorts method.

◆ numberOfOutputPorts

int node::numberOfOutputPorts ( String  node)
slot

The number of output ports on a node.

Parameters
nodethe path of the node

◆ numberOfSubNodes

int node::numberOfSubNodes ( String &  parent)
slot

Return an integer that indicates the number of nodes contained in a group.

Parameters
parentthe path of the parent node

◆ parentNode

String node::parentNode ( String &  node)
slot

Return the path of the parent level of a node contained in a group.

Parameters
nodethe path of the node

◆ removeDynamicAttr

bool node::removeDynamicAttr ( String  node,
String  attrName 
)
slot

Remove a dynamic attribute for the given node.

Parameters
nodethe name of the node.
attrNamethe name of the attribute.

◆ rename

bool node::rename ( String  node,
String  newName 
)
slot

Change the name of a node.

Parameters
nodethe name of the node
newNameThe new name for the node.

◆ resetColor

bool node::resetColor ( String  node)
slot

Reset the node color.

Parameters
nodeThe name of the node.

◆ root

String node::root ( )
slot

returns the name of the Top level in the Node View, which is "Top".

◆ setAsDefaultCamera

bool node::setAsDefaultCamera ( String  node)
slot

Setters and getters for the default camera.

Set the default camera in the scene. Returns whether successful or not.

Parameters
nodethe name of the camera

◆ setAsGlobalDisplay

bool node::setAsGlobalDisplay ( String  node)
slot

Change the global display used in the application. The node must be the full path of a display node.

Parameters
nodeThe full path of a display node
Returns
True if successful. False if the display node was not found or an invalid name was provided.

◆ setColor

bool node::setColor ( String  node,
ColorRGBA color 
)
slot

Set the node color.

Parameters
nodeThe name of the node.
colorThe new color set for the node.

◆ setCoord [1/2]

virtual bool node::setCoord ( String  node,
int  x,
int  y 
)
virtualslot

Set the position of a node in the Node View.

Parameters
nodethe path of the node
xThe X position of the node in the Node View
yThe Y position of the node in the Node View

◆ setCoord [2/2]

virtual bool node::setCoord ( String  node,
int  x,
int  y,
int  z 
)
virtualslot

Set the position of a node in the Node View.

Parameters
nodethe path of the node
xThe X position of the node in the Node View
yThe Y position of the node in the Node View
zThe Z position of the node in the Node View

◆ setEnable

bool node::setEnable ( String  node,
bool  flag 
)
slot

Setters and getters for the enable/disable property of a node.

Set the enable flag of the node.

Parameters
nodethe name of the node
flagtrue or false

◆ setGlobalToDisplayAll

bool node::setGlobalToDisplayAll ( )
slot

Change the global display used by the application to "Display All" pseudo-display.

Returns
True if successful.

◆ setLocked

bool node::setLocked ( String  node,
bool  lock 
)
slot

Setters and getters for the lock/unlock property of a node.

Set the lock flag

Parameters
nodethe name of the node
lockif true, lock the node.

◆ setShowTimelineThumbnails

bool node::setShowTimelineThumbnails ( String  node,
bool  bShow 
)
slot

Set the show/hide timeline thumbnails on drawing layers.

Parameters
nodeThe name of the node.
bShowTrue to show thumbnails.

◆ setTextAttr

bool node::setTextAttr ( String  node,
String  attrName,
int  atFrame,
String  attrValue 
)
slot

Change the value of an attribute in a node.

Additions specific to the Colour Override node: Use the attribute PALETTES.CLEAR to clear the palette list in the colour override node. Use the attribute PALETTES.ADD to add a palette to the palette list of the colour override node. Use the attribute PALETTES.REMOVE to remove a palette from the palette list of the colour override node.

Parameters
nodeThe name of the node
attrNameThe name of the attribute whose value you want to change.
atFrameThe frame number at which you set the value.
attrValueThe new value of the attribute

◆ setTimelineTag

bool node::setTimelineTag ( String  node,
bool  tag 
)
slot

Set the timeline tag flag.

Parameters
nodethe name of the node
tagnew tag state of the node.

◆ setVersion

void node::setVersion ( String  node,
int  version 
)
slot

Set the version of the node to use.

Parameters
nodethe name of the node
versionthe new version of the node

◆ srcNode

String node::srcNode ( String  node,
int  iPort 
)
slot

Return the path for the node that the port is linked to.

Parameters
nodethe path of the node
iPorthe port number on the destination node whose source node you want to find. This value is between 0 and the results of the numberOfInputPorts method.

◆ srcNodeInfo

QScriptValue node::srcNodeInfo ( String &  node,
int  iPort 
)
slot

Return the source node path, the port number and the link ID for this destination node is connected to.

Parameters
nodethe path to the source node.
iPortthe port number of which you want to locate the node that is connected to it. This value is between 0 and the result of 'numberOfInputPorts()' method.

This method is similar to srcNode(), however, it returns an object that contains 3 attribute. node - the path of the source node this destination node is linked to. This is the same value as the value returned by 'srcNode()'. port - this is the output port number in the source node that this destination node is connected to. link - this is the link number in the output port of the source node for this connection.

◆ subNode

String node::subNode ( String &  parent,
int  iSubNode 
)
slot

Return the path of a node in a group. Nodes are counted starting with zero.

Parameters
parentthe path of the parent node
iSubNodeAn integer representing the numerical value of the node. This value must be between 0 and the numberOfSubNodes method for that point.

◆ subNodeByName

String node::subNodeByName ( String &  parent,
String  name 
)
slot

Return the full path name of a child node belonging to a parent group.

The existence of the parent group is validated as well as the existence of the child node in that parent. Use this method instead of manually concatenating the full path name of child nodes.

Parameters
parentFully qualified path of the parent group.
nameThe actual node name suffix. This one is only the short name, not the full path of the node

◆ subNodes

QScriptValue node::subNodes ( String &  parentGroup)
slot

Return an array of sub nodes.

Parameters
parentGroupthe path of the parent node

◆ type

String node::type ( String  node)
slot

Return the node type. These are all of the built-in node types available from the Stage node like: READ, COMPOSITE, PEG, QUADMAP, SHADOW, etc.

Parameters
nodethe path of the node

◆ unlink

bool node::unlink ( String  dstNode,
int  inPort 
)
slot

Unlink a port on one node from the port on another node.

Parameters
dstNodeThe path of the node whose input port you want to unlink from the source node.
inPortThe input port that you want to unlink. This value is between 0 and the results of the numberOfInputPorts method.

◆ unlinkAttr

bool node::unlinkAttr ( String  node,
String  attrName 
)
slot

Unlink an attribute from a function column.

Parameters
nodethe name of the node
attrNameThe name of the attribute that you want to unlink.

◆ width

virtual int node::width ( String  node)
virtualslot

Return the width of a given node.

This width / height parameter is useful for computing the position of nodes in the Node View. It uses the same unit system as the coordX() and coordY() methods.

Parameters
nodethe path of the node