Package autodesk_toxik :: Module graph :: Class GroupNode

Class GroupNode

 object --+        
          |        
Boost.Python.instance --+    
              |    
           Node --+
                  |
                 GroupNode

Known Subclasses:

LinkNode

Node that represents a group of other nodes. Group nodes are nodes that exist to provide structure within a graph.

Instance Methods

GroupNode

addGroupNode(...)
Creates a group node in this group and adds the given nodes to it.

Input

addInput(...)
Creates and adds a dynamic input with the specified name and data type.

GroupNode

addLinkNode(self, comp_or_graph)
Add a link node in this group.

LinkNode

addLinkNodePrimaryVersion(...)
Add a link node in this group, connected to the primary version of the given composition.

LinkNode

addLinkNodeVersion(...)
Add a link node in this group, connected to the argument version.

addNode(...)
Adds a Node in this graph to this group node.

addNodes(...)
Adds a list of nodes in this graph to this group node.

Output

addOutput(...)
Creates and adds a dynamic output with the specified name and data type.

[Node]

copyNodes(...)
Copies a list of nodes into new nodes in this group node.

Node

createNode(...)
Creates a node with the specified tool and adds it to this group.

Node

createNodeFromPreset(...)
Creates and adds a new node instantiated from the given tool preset in this group node.

[Input]

getInferredInputs(...)
Returns: A list of the inputs to sockets that are outside of this group node but that are not boundary nodes.

[Output]

getInferredOutputs(...)
Returns: A list of the outputs to sockets that are outside of this group node but that are not boundary nodes.

Node

getNodeByName(...)
Returns: The specified node by name at the level of this group.

[Node]

getNodes(...)
Returns: A list of the nodes (Node derived instances) at the level of this group.

Tool

getTool(...)
Returns: The tool for this group node.

removeInput(...)
Removes the specified dynamic input.

removeNode(...)
Remove the specified node from this group node.

removeOutput(...)
Removes the specified dynamic output.

Inherited from Node: __cmp__, __getitem__, __init__, __reduce__, __rshift__, addAnchor, addValue, enableSchematicThumbnail, getAnchors, getGraph, getGroup, getId, getInput, getInputs, getName, getOutput, getOutputs, getPrimaryImageInput, getPrimaryImageOutput, getPrimaryInput, getPrimaryOutput, getQualifiedName, getSchematicPosition, getValue, getValues, hasAnchor, isSchematicThumbnailEnabled, removeAnchor, removeValue, setAnchors, setName, setSchematicPosition

Inherited from Boost.Python.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

addGroupNode(...)

Creates a group node in this group and adds the given nodes to it.

Parameters:

nodes (list of Node) - The nodes to add. This list of nodes can be empty (default=[]), in which case an empty group node is created.
isVisual (bool) - A boolean indicating whether the created group node shows its internal schematic (False by default).

Returns: GroupNode

The created group node.

addInput(...)

Creates and adds a dynamic input with the specified name and data type.

Parameters:

name (str)
dataType (DataTypeType)

Returns: Input

The created dynamic input.

addLinkNode(self, comp_or_graph)

Add a link node in this group. If the argument is a composition, connect the link node to the primary version of an external composition. If the argument is a version (composition graph), connect the link node to that version.

Parameters:

comp_or_graph (Composition or Graph)

Returns: GroupNode

The GroupNode.

Raises:

RuntimeError - If the first parameter is not a Composition or Graph.

addLinkNodePrimaryVersion(...)

Add a link node in this group, connected to the primary version of the given composition.

Parameters:

comp (Composition)

Returns: LinkNode

The link node.

addLinkNodeVersion(...)

Add a link node in this group, connected to the argument version.

Parameters:

graph (Graph)

Returns: LinkNode

The link node.

addNode(...)

Adds a Node in this graph to this group node.

Parameters:

node (Node)

addNodes(...)

Adds a list of nodes in this graph to this group node.

Parameters:

nodeList (list of Node)

addOutput(...)

Creates and adds a dynamic output with the specified name and data type.

Parameters:

name (str)
dataType (DataTypeType)

Returns: Output

The created dynamic output.

copyNodes(...)

Copies a list of nodes into new nodes in this group node. The source nodes can come from the destination graph or some other graph.

Parameters:

nodeList (list of Node)

Returns: [Node]

The list of copied nodes.

createNode(...)

Creates a node with the specified tool and adds it to this group.

Parameters:

tool (Tool)

Returns: Node

The created node.

createNodeFromPreset(...)

Creates and adds a new node instantiated from the given tool preset in this group node.

Parameters:

presetFilePath (str) - Absolute path to the ".txpreset" tool preset file to load.

Returns: Node

The new Node.

Raises:

GraphError - If the tool preset file cannot be loaded.

getInferredInputs(...)

Returns: [Input]: A list of the inputs to sockets that are outside of this group node but that are not boundary nodes.

getInferredOutputs(...)

Returns: [Output]: A list of the outputs to sockets that are outside of this group node but that are not boundary nodes.

getNodeByName(...)

Parameters:

name (str) - Node name.

Returns: Node

The specified node by name at the level of this group.

getNodes(...)

Parameters:

tool (Tool or str) - Optional Tool or tool name. If specified, this function will return the list of the tool nodes (ToolNode) matching the specified tool at the level of this group. If unspecified, all nodes in the group will be returned.

Returns: [Node]

A list of the nodes (Node derived instances) at the level of this group.

getTool(...)

Returns: Tool: The tool for this group node.

removeInput(...)

Removes the specified dynamic input.

Parameters:

input (Input) - The dynamic input to remove.

removeNode(...)

Remove the specified node from this group node.

Parameters:

node (Node)

removeOutput(...)

Removes the specified dynamic output.

Parameters:

output (Output) - The dynamic output to remove.