nuke.Root

Package nuke :: Class Root |
[hide private]
[frames] | no frames]

# Class Root

    object --+
             |
     nuke.Node --+
                 |
        nuke.Group --+
                     |
                    nuke.Root

Instance Methods | [hide private]
__getitem__(x, y) x[y] |
__len__(x) len(x) |
a new object with type S, a subtype of T |
__new__(T, S, ...) |
__repr__(x) repr(x) |
__str__(x) str(x) |
None |
addView(self, s) Add view. |
bool |
canSetInput(self, i, node) Check whether the output of 'node' can be connected to input i. |
String list |
channels(...) nuke.Root.channels() -> Channel list. |
Number of clones |
clones(self) Returns: Number of clones. |
bool |
connectInput(self, i, node) Connect the output of 'node' to the i'th input or the next available unconnected input. |
None |
deleteView(self, s) Delete view. |
Integer |
firstFrame(self) First frame. |
Integer |
fps(self) FPS. |
The i'th input |
input(self, i) Returns: The i'th input. |
Number of inputs |
inputs(self) Returns: Number of inputs. |
Integer |
lastFrame(self) Last frame. |
layers(...) nuke.Root.layers() -> Layer list. |
Maximum number of inputs this node can have |
maximumInputs(self) Returns: Maximum number of inputs this node can have. |
Maximum number of outputs this node can have |
maximumOutputs(self) Returns: Maximum number of outputs this node can have. |
None |
mergeFrameRange(self, a, b) Merge frame range. |
Minimum number of inputs this node can have |
minimumInputs(self) Returns: Minimum number of inputs this node can have. |
True if modified, False otherwise |
modified(self) Get or set the 'modified' flag in a script |
Number of first optional input |
optionalInput(self) Returns: Number of first optional input. |
True if proxy is set, False otherwise |
proxy(self) Returns: True if proxy is set, False otherwise. |
None |
setFrame(self, n) Set frame. |
bool |
setInput(self, i, node) Connect input i to node if canSetInput() returns true. |
None |
setModified(self, b) Set the 'modified' flag in a script. |
None |
setProxy(self, b) Set proxy. |
None |
setView(self, s) Set view. |
Inherited from `Group`: `__enter__`, `__exit__`, `__reduce_ex__`, `begin`, `connectSelectedNodes`, `end`, `expand`, `node`, `nodes`, `numNodes`, `output`, `run`, `selectedNode`, `selectedNodes`, `splaySelectedNodes` Inherited from `Node`: `Class`, `addKnob`, `allKnobs`, `autoplace`, `bbox`, `deepSample`, `deepSampleCount`, `dependencies`, `dependent`, `error`, `forceValidate`, `format`, `frameRange`, `fullName`, `getNumKnobs`, `hasError`, `height`, `help`, `hideControlPanel`, `isSelected`, `knob`, `knobs`, `linkableKnobs`, `maxInputs`, `maxOutputs`, `metadata`, `minInputs`, `name`, `numKnobs`, `opHashes`, `pixelAspect`, `readKnobs`, `redraw`, `removeKnob`, `resetKnobsToDefault`, `running`, `sample`, `screenHeight`, `screenWidth`, `setName`, `setSelected`, `setXYpos`, `setXpos`, `setYpos`, `showControlPanel`, `showInfo`, `shown`, `treeHasError`, `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__

### __new__(T, S, ...) |
Returns: a new object with type S, a subtype of T Overrides: object.__new__

### __repr__(x) (Representation operator) |
repr(x) Overrides: object.__repr__

### __str__(x) (Informal representation operator) |
str(x) Overrides: object.__str__

### addView(self, s) |
Add view. Parameters: `s` - Name of view. Returns: None None.

### canSetInput(self, i, node) |
Check whether the output of 'node' can be connected to input i. Parameters: `i` - Input number. `node` - The node to be connected to input i. Returns: bool True if node can be connected, False otherwise. Overrides: Node.canSetInput (inherited documentation)

### channels(...) |
nuke.Root.channels() -> Channel list. Class method. Returns: String list Channel list. Overrides: Node.channels

### clones(self) |
Returns: Number of clones Number of clones. Overrides: Node.clones (inherited documentation)

### connectInput(self, i, node) |
Connect the output of 'node' to the i'th input or the next available unconnected input. The requested input is tried first, but if it is already set then subsequent inputs are tried until an unconnected one is found, as when you drop a connection arrow onto a node in the GUI. Parameters: `i` - Input number to try first. `node` - The node to connect to input i. Returns: bool True if a connection is made, False otherwise. Overrides: Node.connectInput (inherited documentation)

### deleteView(self, s) |
Delete view. Parameters: `s` - Name of view. Returns: None None.

### firstFrame(self) |
First frame. Returns: Integer Integer. Overrides: Node.firstFrame

### fps(self) |
FPS. Returns: Integer Integer.

### input(self, i) |
Parameters: `i` - Input number. Returns: The i'th input The i'th input. Overrides: Node.input (inherited documentation)

### inputs(self) |
Returns: Number of inputs Number of inputs. Overrides: Node.inputs (inherited documentation)

### lastFrame(self) |
Last frame. Returns: Integer Integer. Overrides: Node.lastFrame

### layers(...) |
nuke.Root.layers() -> Layer list. Class method. Returns: Layer list.

### maximumInputs(self) |
Returns: Maximum number of inputs this node can have Maximum number of inputs this node can have. Overrides: Node.maximumInputs (inherited documentation)

### maximumOutputs(self) |
Returns: Maximum number of outputs this node can have Maximum number of outputs this node can have. Overrides: Node.maximumOutputs (inherited documentation)

### mergeFrameRange(self, a, b) |
Merge frame range. Parameters: `a` - Low-end of interval range. `b` - High-end of interval range. Returns: None None.

### minimumInputs(self) |
Returns: Minimum number of inputs this node can have Minimum number of inputs this node can have. Overrides: Node.minimumInputs (inherited documentation)

### modified(self) |
Get or set the 'modified' flag in a script Returns: True if modified, False otherwise True if modified, False otherwise.

### optionalInput(self) |
Returns: Number of first optional input Number of first optional input. Overrides: Node.optionalInput (inherited documentation)

### proxy(self) |
Returns: True if proxy is set, False otherwise True if proxy is set, False otherwise. Overrides: Node.proxy

### setFrame(self, n) |
Set frame. Parameters: `n` - Frame number. Returns: None None.

### setInput(self, i, node) |
Connect input i to node if canSetInput() returns true. Parameters: `i` - Input number. `node` - The node to connect to input i. Returns: bool True if canSetInput() returns true, or if the input is already correct. Overrides: Node.setInput (inherited documentation)

### setModified(self, b) |
Set the 'modified' flag in a script. Setting the value will turn the indicator in the title bar on/off and will start or stop the autosave timeout. Parameters: `b` - Boolean convertible object. Returns: None None.

### setProxy(self, b) |
Set proxy. Parameters: `b` - Boolean convertible object. Returns: None None.

### setView(self, s) |
Set view. Parameters: `s` - Name of view. Returns: None None.