Harmony
Scripting Interface Documentation
node Class Reference

The node JavaScript global object. More...

Public Slots

Node Data.
String root ()
 returns the name of the Top level in the network, which is "Top". More...
 
bool isGroup (String &node)
 returns a true or false value indicating if the node is a Group. More...
 
String getName (String &node)
 returns the name of a node More...
 
String type (String node)
 returns 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)
 returns 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)
 returns the path of a node in a group. Nodes are counted starting with zero More...
 
String subNodeByName (String &parent, String name)
 This function returns the full path name of a child node belonging to a parent group. This function will validate that the parent group exists and that the child node exists in that parent. This function should be used instead of manually concatenating the full path name of child nodes. More...
 
String parentNode (String &node)
 returns the path of the parent level of a node contained in a group More...
 
String noNode ()
 returns the null string that is returned by other functions when there is an error. More...
 
bool equals (String node1, String node2)
 returns 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)
 returns the value(s) of the node selected attribute(s). More...
 
AttributegetAttr (String node, double atFrame, String attrName)
 returns a Attribute object that represents the node selected attribute(s). More...
 
QList< Attribute * > getAttrList (String node, double atFrame, String attrName=String::null)
 returns a list of Attribute objects in specified node or node complex attribute. More...
 
String linkedColumn (String node, String attrName)
 returns the name of the column that an attribute is linked to. If the attribute is not linked to a column, the function returns the null string. More...
 
virtual int coordX (String node)
 returns an integer indicating the X position of a node in the network More...
 
virtual int coordY (String node)
 returns an integer indicating the Y position of a node in the network More...
 
virtual int coordZ (String node)
 returns an integer indicating the Z position of a node in the network More...
 
virtual int width (String node)
 returns the width of a given node. This width / height parameter is useful for computing the position of nodes in the Network view. It uses the same unit system as the coordX() and coordY() functions. More...
 
virtual int height (String node)
 returns the height of a given node. This width / height parameter is useful for computing the position of nodes in the Network view. It uses the same unit system as the coordX() and coordY() functions. More...
 
virtual bool setCoord (String node, int x, int y)
 sets the position of a node in the network. More...
 
virtual bool setCoord (String node, int x, int y, int z)
 sets the position of a node in the network. More...
 
int numberOfInputPorts (String node)
 the number of input ports on the node. More...
 
bool isLinked (String node, int iPort)
 returns true or false to indicate if a port is connected to another node. More...
 
String srcNode (String node, int iPort)
 returns 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 function returns the path of the node inside the Group node that is the source. If the source is not inside a group, the flatSrcNode function behaves like the srcNode function. More...
 
QScriptValue srcNodeInfo (String &node, int iPort)
 returns 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)
 returns 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)
 returns the path and addition information of the destination node linked to the source node. More...
 
bool groupAtNetworkBuilding (String node)
 returns true if the peg's groupAtNetworkBuilding attribute is true. More...
 
bool addCompositeToGroup (String node)
 returns 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)
 adds a node to the network. 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. This function returns true when successful. 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. The function returns the full path of the created group, or an empty string if the creation of the node failed. More...
 
String moveToGroup (String nodeName, String groupName)
 moves the specified node within the specified group. Similar to performing a drag and drop of a node to a group from the timeline. More...
 
bool explodeGroup (String groupName)
 Explode a group into its parent group. This function is identical to the "Explode Selected Group" from the Network view. More...
 
bool rename (String node, String newName)
 changes 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)
 changes the value of an attribute in a node. More...
 
bool linkAttr (String node, String attrName, String columnName)
 links an attribute to a function column in the Xsheet View. More...
 
bool unlinkAttr (String node, String attrName)
 unlinks an attribute from a function column. More...
 
bool link (String srcNode, int srcPort, String dstNode, int dstPort)
 links 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)
 links a port on a node to a port on another node. Fancy version that allow easier connecting to a group node, or setup the proper connection order. More...
 
bool unlink (String dstNode, int inPort)
 unlinks 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)
 returns 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)
 returns the lock flag More...
 
bool setTimelineTag (String node, bool tag)
 sets the timeline tag flag More...
 
bool getTimelineTag (String node)
 returns the timeline tag flag More...
 
StringList getTimelineTagList (String node=QNTR("Top"), StringList list=StringList())
 
bool setColor (String node, ColorRGBA *color)
 sets the node color More...
 
bool resetColor (String node)
 resets the node color More...
 
ColorRGBAgetColor (String node)
 returns the node color More...
 
bool setAsGlobalDisplay (String node)
 This function changes the global display used in the application. The node must be the full path of a display node. More...
 
bool setGlobalToDisplayAll ()
 This function changes 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 ()
 returns the name of the default camera. More...
 
StringList getCameras ()
 Returns 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)
 Returns a collection of node paths for nodes of specified types. More...
 
QObject * getMatrix (String node, int frame)
 returns the model matrix of a node. More...
 
QObject * getPivot (String node, int frame)
 returns the pivot of the node More...
 
ColorOverridegetColorOverride (String node)
 returns the ColorOverride object for the colour override node More...
 
int getElementId (String nodeName)
 
void explodeElementSymbolsInGroups (String element, bool disableElement, bool clearExposure, String &prefix=String())
 This function creates 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)
 sets 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 network. 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

adds a node to the network.

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

returns 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

returns an integer indicating the X position of a node in the network

Parameters
nodethe path of the node

◆ coordY

virtual int node::coordY ( String  node)
virtualslot

returns an integer indicating the Y position of a node in the network

Parameters
nodethe path of the node

◆ coordZ

virtual int node::coordZ ( String  node)
virtualslot

returns an integer indicating the Z position of a node in the network

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 function returns the full path of the created group, or an empty string if the creation of the node failed.

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

◆ 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. This function returns true when successful.

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.

◆ dstNode

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

returns 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 function.
iLinkThe link number whose destination node you want to find. This value is between 0 and the results of the numberOfInpuftLinks function.

◆ dstNodeInfo

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

returns 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 numberOfOutputPorts().
iLinkthe link number whose destination node you want to find. This value is between 0 and the results of the numberOfInputLinks() function.

This function 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

returns 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

This function creates 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 function is identical to the "Explode Selected Group" from the Network view.

This function returns true if successful.

Parameters
groupNamethe name of the node

◆ flatSrcNode

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

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

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 function.

◆ getAttr

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

returns a Attribute object that represents 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.

◆ getAttrList

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

returns a list of Attribute objects in specified node or node complex attribute.

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 container attribute or an empty string if you want all top level attributes.

◆ getCameras

StringList node::getCameras ( )
slot

Returns a list of all cameras within the scene.

◆ getColor

ColorRGBA* node::getColor ( String  node)
slot

returns the node color

Parameters
nodethe name of the node.

◆ getColorOverride

ColorOverride* node::getColorOverride ( String  node)
slot

returns the ColorOverride object for the colour override node

Parameters
nodethe name of the node
Returns
ColorOverride object

◆ getDefaultCamera

String node::getDefaultCamera ( )
slot

returns 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

returns 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

returns the lock flag

Parameters
nodethe name of the node

◆ getMatrix

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

returns 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

returns the name of a node

Parameters
nodethe path of the node

◆ getNodes

StringList node::getNodes ( StringList &  types)
slot

Returns 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

returns 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

returns 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

returns 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

Returns 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

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

Parameters
nodethe path of the node

◆ height

virtual int node::height ( String  node)
virtualslot

returns the height of a given node. This width / height parameter is useful for computing the position of nodes in the Network view. It uses the same unit system as the coordX() and coordY() functions.

Parameters
nodethe path of the node

◆ isGroup

bool node::isGroup ( String &  node)
slot

returns 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

returns 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 function.

◆ link [1/2]

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

links a port on a node to a port on another node.

Parameters
srcNode: The 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 function.
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 function.

◆ link [2/2]

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

links a port on a node to a port on another node. Fancy version that allow easier connecting to a group node, or setup the proper connection order.

Parameters
srcNode: The 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 function.
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 function.
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

links 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

returns the name of the column that an attribute is linked to. If the attribute is not linked to a column, the function 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

moves the specified node within the specified group. Similar to performing a drag and drop of a node to a group from the timeline.

Parameters
nodeNamethe name of the node
groupNameThe path of the group.

◆ noNode

String node::noNode ( )
slot

returns the null string that is returned by other functions when there is an error.

◆ 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 function.

◆ 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

returns 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

returns 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

changes the name of a node.

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

◆ resetColor

bool node::resetColor ( String  node)
slot

resets the node color

Parameters
nodeThe name of the node.

◆ root

String node::root ( )
slot

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

◆ setAsDefaultCamera

bool node::setAsDefaultCamera ( String  node)
slot

Setters and getters for the default camera.

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

Parameters
nodethe name of the camera

◆ setAsGlobalDisplay

bool node::setAsGlobalDisplay ( String  node)
slot

This function changes the global display used in the application. The node must be the full path of a display node.

This function returns true if successful. It returns false if the display node was not found or an invalid name was provided.

Parameters
nodeThe full path of a display node

◆ setColor

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

sets 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

sets the position of a node in the network.

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

◆ setCoord [2/2]

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

sets the position of a node in the network.

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

◆ setEnable

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

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

sets the enable flag of the node.

Parameters
nodethe name of the node
flag: true or false

◆ setGlobalToDisplayAll

bool node::setGlobalToDisplayAll ( )
slot

This function changes the global display used by the application to "Display All" pseudo-display.

This function returns true if successful.

◆ setLocked

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

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

sets the lock flag

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

◆ setShowTimelineThumbnails

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

sets 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

changes 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.
attrValue: new value

◆ setTimelineTag

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

sets the timeline tag flag

Parameters
nodethe name of the node
tag: new 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

returns 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 function.

◆ srcNodeInfo

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

returns 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()' function.

This function 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

returns 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 function for that point.

◆ subNodeByName

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

This function returns the full path name of a child node belonging to a parent group. This function will validate that the parent group exists and that the child node exists in that parent. This function should be used 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

returns 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

unlinks 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 function.

◆ unlinkAttr

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

unlinks 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

returns the width of a given node. This width / height parameter is useful for computing the position of nodes in the Network view. It uses the same unit system as the coordX() and coordY() functions.

Parameters
nodethe path of the node