Trees       Indices       Help   
Nuke Python API
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, name, color)
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)
Return the FPS rounded to an int.
 
getOCIOColorspaceFamily(...)
nuke.root.getOCIOColorspaceFamily(colorspace) -> Family of colorspace Gets the name of the family to which the specified colorspace belongs, for the root node's current OCIO config.
 
getOCIOColorspaceFromViewTransform(...)
nuke.root.getOCIOColorspaceFromViewTransform(display, view) -> Colorspace name Gets the name of the colorspace to which the specified display and view names are mapped for the root node's current OCIO config.
The i'th input
input(self, i)
Returns: The i'th input.
Gets the maximum number of connected inputs
inputs(self)
Returns: Number of the highest connected input + 1.
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.
float
realFps(self)
The global frames per second setting.
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, subgraphLocked

Inherited from Node: Class, addCallback, addKnob, allKnobs, autoplace, bbox, clearCallbacks, clearCustomIcon, deepSample, deepSampleCount, dependencies, dependent, error, executePythonCallback, fileDependencies, forceUpdateLocalization, forceValidate, format, frameRange, fullName, getNumKnobs, hasError, height, help, hideControlPanel, isCloneable, isLocalizationOutdated, isLocalized, isSelected, knob, knobs, linkableKnobs, localizationProgress, lock, locked, maxInputs, maxOutputs, metadata, minInputs, name, numKnobs, opHashes, parent, performanceInfo, pixelAspect, readKnobs, redraw, removeCallback, removeKnob, resetKnobsToDefault, rootNode, running, sample, screenHeight, screenWidth, selectOnly, setCustomIcon, setName, setSelected, setTab, setXYpos, setXpos, setYpos, showControlPanel, showInfo, shown, treeHasError, unlock, 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__

__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, name, color)

 

Add view.

Parameters:
  • name - String - name of view.
  • color - Optional. String in the format #RGB, #RRGGBB, #RRRGGGBBB, #RRRRGGGGBBBB or a name from the list of colors defined in the list of SVG color keyword names.
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)

 

Return the FPS rounded to an int. This is deprecated. Please use real_fps().

Returns: integer

getOCIOColorspaceFamily(...)

 

nuke.root.getOCIOColorspaceFamily(colorspace) -> Family of colorspace Gets the name of the family to which the specified colorspace belongs, for the root node's current OCIO config.

Parameters:
  • colorspace - Colorspace name.
Returns:
Family name, may be an empty string.

getOCIOColorspaceFromViewTransform(...)

 

nuke.root.getOCIOColorspaceFromViewTransform(display, view) -> Colorspace name Gets the name of the colorspace to which the specified display and view names are mapped for the root node's current OCIO config.

Parameters:
  • display - Display name.
  • view - View name.
Returns:
The corresponding colorspace name.

input(self, i)

 
Parameters:
  • i - Input number.
Returns: The i'th input
The i'th input.
Overrides: Node.input
(inherited documentation)

inputs(self)

 
Returns: Gets the maximum number of connected inputs
Number of the highest connected input + 1. If inputs 0, 1, and 3 are connected, this will return 4.
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.

   Trees       Indices       Help   
Nuke Python API
Generated by Epydoc 3.0.1 on Fri Jul 17 00:45:44 2020 http://epydoc.sourceforge.net