Package autodesk_toxik :: Module graph :: Class LinkNode

Class LinkNode

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

Node that connects the output of a rendered result tool node in another graph, into this graph. Note that the LinkNode is in fact a GroupNode, but unless you know what you are doing, you shouldn't fiddle with its internal representation.

Nested Classes
	MergeGrouping
	VersionSelectionMode

Instance Methods

getLinkedCompositionId(...)
Returns: The unique id of the composition linked to by this link node.

str

getLinkedCompositionPath(...)
Returns: The path of the composition linked to by this link node.

Output

getLinkedOutput(...)
Returns: The Output of the linked composition version associated with the given link node Output.

Output

getLinkedPrimaryOutput(...)
Returns: The primary output of the linked composition version.

Graph

getLinkedVersion(...)
Returns: The version (Graph) this node links to.

tuple

getTimeParams(self, linkNodeOutput=None)
Gets the following time parameters from the link node for the given output:

VersionSelectionMode

getVersionSelectionMode(...)
Returns: The version selection mode on the link node.

[Node]

merge(...)
Replaces this LinkNode by the content of the graph it currently links to and returns the inserted top level Node(s).

setLinkedComposition(...)
Links to a version in the Composition passed in, using the current link mode to select the linked version.

setLinkedVersion(...)
Sets the composition version (Graph) to link to.

setVersionSelectionMode(...)
Sets the version selection mode on the link node.

updateVersionAndOutputs(...)
Rebinds this link node to the version that matches its current link mode and updates its outputs accordingly.

Inherited from GroupNode: addGroupNode, addInput, addLinkNode, addLinkNodePrimaryVersion, addLinkNodeVersion, addNode, addNodes, addOutput, copyNodes, createNode, createNodeFromPreset, getInferredInputs, getInferredOutputs, getNodeByName, getNodes, getTool, removeInput, removeNode, removeOutput

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

getLinkedCompositionId(...)

Returns:: The unique id of the composition linked to by this link node. The returned id might not refer to an existing composition.

getLinkedCompositionPath(...)

Returns: str: The path of the composition linked to by this link node. The returned path might not refer to an existing composition.

getLinkedOutput(...)

Parameters:

linkNodeOutput (Output)
readWrite (bool) - If set to True, the version that the returned output belongs to is open in read-write mode, otherwise it is open in read-only mode. Defaults to False.

Returns: Output

The Output of the linked composition version associated with the given link node Output. Returns None, if the link node is not linked to a composition version or if the link node output is invalid (doesn't correspond to any output of the linked version).

getLinkedPrimaryOutput(...)

Parameters:

readWrite (bool) - If set to True, the version that the returned output belongs to is open in read-write mode, otherwise it is open in read-only mode. Defaults to False.

Returns: Output

The primary output of the linked composition version. Returns None if the link node is not linked to a composition version.

getLinkedVersion(...)

Parameters:

readWrite (bool) - If set to True, the returned version is open in read-write mode, otherwise it is open in read-only mode. Defaults to False.

Returns: Graph

The version (Graph) this node links to. Returns None if the link node is not linked to a composition version.

getTimeParams(self, linkNodeOutput=None)

Gets the following time parameters from the link node for the given output:

Mark In (integer)
Mark Out (integer; exclusive)
Time Offset (integer)
Repeat Mode (graph.RepeatMode)
Lock Duration (bool)

Parameters:

linkNodeOutput (Output) - The link node output to get the time parameters from. If set to None, the primary output is used.

Returns: tuple

A tuple containing the link node time information as follow: (markIn, markOut, timeOffset, repeatMode, lockDuration).

getVersionSelectionMode(...)

Returns: VersionSelectionMode: The version selection mode on the link node.

merge(...)

Replaces this LinkNode by the content of the graph it currently links to and returns the inserted top level Node(s).

If the link is dangling, the link node is unchanged and an empty list is returned.

Output nodes from the linked graph are not inserted.

Connections to the link node outputs are preserved, except for outputs that are dangling: those that don't have a corresponding output node in the linked graph and those for which the corresponding output node has no input.

Parameters:

grouping (MergeGrouping) - Specifies whether and how to group the inserted nodes (in which case only the group node is returned).
recursive (bool) - A boolean specifying whether link nodes within the linked graphs are merged in recursively.
recursionPredicate (callable) - A callback that is invoked on every link node (LinkNode) found recursively to test whether it must be merged. If set to None, all encountered link nodes are merged.

Returns: [Node]

The list of inserted top level nodes.

setLinkedComposition(...)

Links to a version in the Composition passed in, using the current link mode to select the linked version.

Parameters:

composition (Composition) - If the specified composition is set to None, the link node's composition path is reset.
resetTimeInfo (bool) - A boolean indicating whether the link node time parameters will be reset to the time information of the linked version or remain unchanged (defaults to True).
updateOutputsResultMode (bool) - If set to True (the default), the link node's outputs will have their result mode set to "Rendered" if their linked output is rendered and to "Processing" otherwise.

setLinkedVersion(...)

Sets the composition version (Graph) to link to.

Parameters:

graph (Graph)
resetTimeInfo (bool) - A boolean indicating whether the link node time parameters will be reset to the time information of the linked version or remain unchanged (defaults to True).
updateOutputsResultMode (bool) - If set to True (the default), the link node's outputs will have their result mode set to "Rendered" if their linked output is rendered and to "Processing" otherwise.

setVersionSelectionMode(...)

Sets the version selection mode on the link node.

Parameters:

mode (VersionSelectionMode) - Version selection mode.