Trees       Indices       Help   
Nuke Python API
Package nuke :: Class Group
[hide private]
[frames] | no frames]

Class Group

object --+    
         |    
 nuke.Node --+
             |
            nuke.Group
Known Subclasses:
Instance Methods [hide private]
 
__enter__(...)
 
__exit__(...)
 
__getitem__(x, y)
x[y]
 
__len__(x)
len(x)
 
__reduce_ex__(...)
helper for pickle
 
__repr__(x)
repr(x)
 
__str__(x)
str(x)
Group
begin(self)
All python code that follows will be executed in the context of node.
None
connectSelectedNodes(self, backward, inputA)
Connect the selected nodes.
None
end(self)
All python code that follows will no longer be executed in the context of node.
None
expand(self)
Moves all nodes from the group node into its parent group, maintaining node input and output connections, and deletes the group.
Node with name s or None
node(self, s)
Locate a node by name.
List of nodes
nodes(self)
List of nodes in group.
Number of nodes
numNodes(self)
Number of nodes in group.
Node or None
output(self)
Return output node of group.
Result of callable
run(self, callable)
Execute in the context of node.
Node or None
selectedNode(self)
Returns the node the user is most likely thinking about.
Node or None
selectedNodes(self)
Selected nodes.
None
splaySelectedNodes(self, backward, inputA)
Splay the selected nodes.

Inherited from Node: Class, __new__, addKnob, allKnobs, autoplace, bbox, canSetInput, channels, clones, connectInput, deepSample, deepSampleCount, dependencies, dependent, error, fileDependencies, firstFrame, forceValidate, format, frameRange, fullName, getNumKnobs, hasError, height, help, hideControlPanel, input, inputs, isSelected, knob, knobs, lastFrame, linkableKnobs, maxInputs, maxOutputs, maximumInputs, maximumOutputs, metadata, minInputs, minimumInputs, name, numKnobs, opHashes, optionalInput, performanceInfo, pixelAspect, proxy, readKnobs, redraw, removeKnob, resetKnobsToDefault, running, sample, screenHeight, screenWidth, selectOnly, setInput, setName, setSelected, setTab, setXYpos, setXpos, setYpos, showControlPanel, showInfo, shown, treeHasError, upstreamFrameRange, width, writeKnobs, xpos, ypos

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __reduce__, __setattr__, __sizeof__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__getitem__(x, y)
(Indexing operator)

 

x[y]

Overrides: Node.__getitem__

__len__(x)
(Length operator)

 

len(x)

Overrides: Node.__len__

__reduce_ex__(...)

 

helper for pickle

Overrides: object.__reduce_ex__
(inherited documentation)

__repr__(x)
(Representation operator)

 

repr(x)

Overrides: object.__repr__

__str__(x)
(Informal representation operator)

 

str(x)

Overrides: object.__str__

begin(self)

 

All python code that follows will be executed in the context of node. All names are evaluated relative to this object. Must be paired with end.

Returns: Group
Group.

connectSelectedNodes(self, backward, inputA)

 

Connect the selected nodes. @param backward. @param inputA.

Returns: None
None.

end(self)

 

All python code that follows will no longer be executed in the context of node. Must be paired with begin.

Returns: None
None.

expand(self)

 

Moves all nodes from the group node into its parent group, maintaining node input and output connections, and deletes the group. Returns the nodes that were moved, which will also be selected.

Returns: None
None.

node(self, s)

 

Locate a node by name.

Parameters:
  • s - A string.
Returns: Node with name s or None
Node with name s or None.

nodes(self)

 

List of nodes in group.

Returns: List of nodes
List of nodes

numNodes(self)

 

Number of nodes in group.

Returns: Number of nodes
Number of nodes

output(self)

 

Return output node of group.

Returns: Node or None
Node or None.

run(self, callable)

 

Execute in the context of node. All names are evaluated relative to this object.

Parameters:
  • callable - callable to execute.
Returns: Result of callable
Result of callable.

selectedNode(self)

 

Returns the node the user is most likely thinking about. This is the last node the user clicked on, if it is selected. Otherwise it is an 'output' (one with no selected outputs) of the set of selected nodes. If no nodes are selected then None is returned.

Returns: Node or None
Node or None.

selectedNodes(self)

 

Selected nodes.

Returns: Node or None
Node or None.

splaySelectedNodes(self, backward, inputA)

 

Splay the selected nodes. @param backward. @param inputA.

Returns: None
None.

   Trees       Indices       Help   
Nuke Python API
Generated by Epydoc 3.0.1 on Fri Jun 30 18:46:41 2017 http://epydoc.sourceforge.net