Oink

Python nuke API

The Nuke Python API as implemented in Oink: every function and class.

raw .md

Oink ships a Python module named nuke with the familiar API, so menu.py / init.py files, gizmo callbacks and pipeline scripts run with few or no changes. This page lists everything it provides; anything not listed is not available yet. Scripts run in the backend (the Script Editor panel, menu.py / init.py on the plugin path).

159 functions, 63 classes, 87 constants.

Functions

FunctionDescription
nuke.Boolean_Knob_(*a)
nuke.activeViewer()
nuke.addAfterBackgroundFrameRender(call, args=(), kwargs={}, nodeClass='*')
nuke.addAfterBackgroundRender(call, args=(), kwargs={}, nodeClass='*')
nuke.addAfterFrameRender(call, args=(), kwargs={}, nodeClass='*')
nuke.addAfterRender(call, args=(), kwargs={}, nodeClass='*')
nuke.addAutoSaveDeleteFilter(call, args=(), kwargs={}, nodeClass='*')
nuke.addAutoSaveFilter(call, args=(), kwargs={}, nodeClass='*')
nuke.addAutoSaveRestoreFilter(call, args=(), kwargs={}, nodeClass='*')
nuke.addAutolabel(call, args=(), kwargs={}, nodeClass='*')
nuke.addBeforeBackgroundRender(call, args=(), kwargs={}, nodeClass='*')
nuke.addBeforeFrameRender(call, args=(), kwargs={}, nodeClass='*')
nuke.addBeforeRender(call, args=(), kwargs={}, nodeClass='*')
nuke.addFilenameFilter(call, args=(), kwargs={})
nuke.addFormat(s)
nuke.addKnobChanged(call, args=(), kwargs={}, nodeClass='*')
nuke.addNodePresetExcludePaths(*a)
nuke.addOnCreate(call, args=(), kwargs={}, nodeClass='*')
nuke.addOnDestroy(call, args=(), kwargs={}, nodeClass='*')
nuke.addOnScriptClose(call, args=(), kwargs={}, nodeClass='*')
nuke.addOnScriptLoad(call, args=(), kwargs={}, nodeClass='*')
nuke.addOnScriptSave(call, args=(), kwargs={}, nodeClass='*')
nuke.addOnUserCreate(call, args=(), kwargs={}, nodeClass='*')
nuke.addRenderProgress(call, args=(), kwargs={}, nodeClass='*')
nuke.addToolsetExcludePaths(*a)
nuke.addUpdateUI(call, args=(), kwargs={}, nodeClass='*')
nuke.addValidateFilename(call, args=(), kwargs={})
nuke.alert(prompt)
nuke.allNodes(filter=None, group=None, recurseGroups=False)
nuke.animationEnd()
nuke.animationIncrement()
nuke.animationStart()
nuke.animations()
nuke.ask(prompt, default=False)
nuke.autoplace(n)
nuke.autoplaceSnap(n)
nuke.bound(cls, owner, name, backing, label=None)
nuke.cacheUsage()
nuke.center()
nuke.channels(node=None)
nuke.choice(title, prompt, options, default=0)
nuke.clearDiskCache()
nuke.clearRAMCache()
nuke.clearSelection()
nuke.connectViewer(inputNum, node)
nuke.createNode(node, args=None, inpanel=True)Nuke createNode: connect the selected node to input 0, place below it, select only it,
nuke.critical(prompt)
nuke.debug(msg, *a)
nuke.defaultFontSize()
nuke.defaultNodeColor(cls)
nuke.delete(node)
nuke.display(s, node=None, title='', width=0)
nuke.error(msg, *a)
nuke.execute(nameOrNode, start=None, end=None, incr=1, views=None, continueOnError=False)Render a Write node over frames (beforeRender / before+afterFrameRender / afterRender).
nuke.executeInMainThread(call, args=(), kwargs=None)
nuke.executeInMainThreadWithResult(call, args=(), kwargs=None)
nuke.executeMultiple(nodes, ranges=None, views=None, continueOnError=False)
nuke.executing()
nuke.expression(expr)Evaluate a Nuke expression at the current frame (node_graph/expressions.py).
nuke.extractSelected()
nuke.filename(node, type=None)The node's file knob with its Tcl ([value root.name] ...) evaluated; type=nuke.REPLACE
nuke.filenameFilter(filename)
nuke.flag_words(flags)
nuke.flags_to_names(flags)int flags -> user_knobs flag words (STARTLINE is on by default: only '-STARTLINE' stored).
nuke.formats()
nuke.frame(f=None)
nuke.from_definition(owner, d)Knob object for one user_knobs definition, bound to owner (a Node).
nuke.getClipname(message, pattern=None, default=None, multiple=False)
nuke.getColor(initial=0)
nuke.getFilename(message, pattern=None, default=None, favorites=None, type=None, multiple=False)
nuke.getFramesAndViews(label, default=None, maxviews=0)
nuke.getInput(prompt, default='')
nuke.getNodeClassName()
nuke.invertSelection()
nuke.isnan(v)
nuke.knob(path, value=None, getType=False, getClass=False)
nuke.knobDefault(classknob, value=None)
nuke.knob_class_for_prop(rna, size, name)Nuke knob class for an RNA property of an Oink node.
nuke.layers(node=None)
nuke.load(name)nuke.load('script'): run name(.py) / paste name(.nk/.gizmo) found on the plugin path.
nuke.localizationEnabled(knob=None, *a)Is localization on for this file knob's node (policy not off, system mode not off)?
nuke.memory(cmd=None, *a)
nuke.menu(name)
nuke.message(prompt)
nuke.modified()
nuke.names_to_flags(words)
nuke.nodeCopy(s='%clipboard%')Selected nodes as .nk text to the clipboard ('%clipboard%') or a file.
nuke.nodePaste(s='%clipboard%')Paste .nk text (clipboard or a file) into the comp; pasted nodes become the selection.
nuke.nodesSelected()
nuke.numvalue(path, default=None)
nuke.oc_run_python(code, node=None, mode='eval')Hook for opencomp_core/nk/tcl_eval.py ([python ...], PyScript buttons): run code with
nuke.ofxPluginPath()
nuke.pluginAddPath(path, addToSysPath=True)Add a plugin directory: on sys.path, its init.py runs now, its menu.py after startup
nuke.pluginAppendPath(path, addToSysPath=True)
nuke.pluginExists(name)
nuke.pluginInstallLocation()
nuke.pluginPath()
nuke.rawArgs()
nuke.recentFile(n)
nuke.removeAfterBackgroundFrameRender(call, args=(), kwargs={}, nodeClass='*')
nuke.removeAfterBackgroundRender(call, args=(), kwargs={}, nodeClass='*')
nuke.removeAfterFrameRender(call, args=(), kwargs={}, nodeClass='*')
nuke.removeAfterRender(call, args=(), kwargs={}, nodeClass='*')
nuke.removeAutoSaveDeleteFilter(call, args=(), kwargs={}, nodeClass='*')
nuke.removeAutoSaveFilter(call, args=(), kwargs={}, nodeClass='*')
nuke.removeAutoSaveRestoreFilter(call, args=(), kwargs={}, nodeClass='*')
nuke.removeAutolabel(call, args=(), kwargs={}, nodeClass='*')
nuke.removeBeforeBackgroundRender(call, args=(), kwargs={}, nodeClass='*')
nuke.removeBeforeFrameRender(call, args=(), kwargs={}, nodeClass='*')
nuke.removeBeforeRender(call, args=(), kwargs={}, nodeClass='*')
nuke.removeFilenameFilter(call, args=(), kwargs={})
nuke.removeKnobChanged(call, args=(), kwargs={}, nodeClass='*')
nuke.removeOnCreate(call, args=(), kwargs={}, nodeClass='*')
nuke.removeOnDestroy(call, args=(), kwargs={}, nodeClass='*')
nuke.removeOnScriptClose(call, args=(), kwargs={}, nodeClass='*')
nuke.removeOnScriptLoad(call, args=(), kwargs={}, nodeClass='*')
nuke.removeOnScriptSave(call, args=(), kwargs={}, nodeClass='*')
nuke.removeOnUserCreate(call, args=(), kwargs={}, nodeClass='*')
nuke.removeRenderProgress(call, args=(), kwargs={}, nodeClass='*')
nuke.removeUpdateUI(call, args=(), kwargs={}, nodeClass='*')
nuke.render(nameOrNode, start=None, end=None, incr=1, views=None, continueOnError=False)Render a Write node over frames (beforeRender / before+afterFrameRender / afterRender).
nuke.resetProjectDirectory()
nuke.root()
nuke.scriptClear(*a, **k)
nuke.scriptClose(*a, **k)
nuke.scriptExit(*a)
nuke.scriptName()
nuke.scriptNew(*a, **k)
nuke.scriptOpen(path)Replace the comp with a .nk or .ocomp script; runs onCreate per node + onScriptLoad.
nuke.scriptReadFile(path)Merge a script into the current comp (nuke.scriptReadFile / scriptSource).
nuke.scriptSave(path=None, **kw)
nuke.scriptSaveAndClear(filename=None, ignoreUnsavedChanges=False)
nuke.scriptSaveAs(filename=None, overwrite=-1)
nuke.scriptSource(path)Merge a script into the current comp (nuke.scriptReadFile / scriptSource).
nuke.script_directory()Folder of the open script ('' when untitled).
nuke.selectAll()
nuke.selectedNode()The last selected node; ValueError when nothing is selected (Nuke).
nuke.selectedNodes(filter=None)
nuke.showDag(*a)
nuke.startup()Load plugins like Nuke: ~/.opencomp then every NUKE_PATH / OPENCOMP_PLUGIN_PATH dir —
nuke.tcl(s, *args)Tcl commands: the Tcl module when installed (_host.tcl_eval), else a small subset:
nuke.thisClass()
nuke.thisGroup()
nuke.thisKnob()
nuke.thisNode()
nuke.thisPane()
nuke.thisParent()
nuke.thisView()
nuke.toNode(name)Node by name in the current group; 'Group1.Blur1' / 'root.Blur1' paths; 'root'.
nuke.toolbar(name, create=True)
nuke.tprint(*args, **kwargs)
nuke.updateUI()
nuke.user_def(knob)nk/user_knobs.py definition of a knob object (node.addKnob).
nuke.user_dir()
nuke.usingPerformanceTimers()
nuke.value(path, default=None)nuke.value('Blur1.size') -> '12' (Tcl string, like Nuke).
nuke.warning(msg, *a)
nuke.zoom(*a)
nuke.zoomToFitSelected(*a)

Classes

nuke.AColor_Knob

MethodDescription
Class(self)
animation(self, chan=0, view=None)
animations(self, view=None)
array(self)
arraySize(self)
clearAnimated(self, index=-1, view=None)
clearExpression(self, channel=-1)
clearFlag(self, f)
copyAnimation(self, channel, curve, view=None)
copyAnimations(self, curves, view=None)
debug(self, message)
defaultValue(self)
dimensions(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getKeyIndex(self, time, index=0, view=None)
getKeyList(self, *a)
getKeyTime(self, key, index=0, view=None)
getNumKeys(self, index=0, view=None)
getText(self)
getValue(self, index=0, view=None, time=None)
getValueAt(self, time, index=0, view=None)
hasExpression(self, index=-1, view=None)
height(self)
isAnimated(self, index=-1, view=None)
isEnabled(self)
isKey(self, index=-1, view=None)
isKeyAt(self, time, index=-1, view=None)
label(self)
max(self)
min(self)
name(self)
names(self, n)
node(self)
notDefault(self)
removeKey(self, index=-1, view=None)
removeKeyAt(self, time, index=-1, view=None)
resize(self, w, h=1)
setAnimated(self, index=-1, view=None)
setEnabled(self, b)
setExpression(self, expression, channel=-1, view=None)
setFlag(self, f)
setKeyAt(self, time, index=-1, view=None)
setLabel(self, label)
setName(self, name)
setRange(self, lo, hi)
setTooltip(self, text)
setValue(self, value, index=-1, time=None, view=None)
setValueAt(self, value, time, index=-1, view=None)
setVisible(self, b)
singleValue(self, view=None)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, index=None, view=None, time=None)
valueAt(self, time, index=None, view=None)
visible(self)
warning(self, message)
width(self)

nuke.AnimationCurve

One channel curve of an animated knob (curve id "size" or "gain.0").

MethodDescription
addKey(self, keys)
changeInterpolation(self, keys, interp)
clear(self)
derivative(self, t, n=1)
evaluate(self, t)
expression(self)
fixSlopes(self)
fromScript(self, s)'curve x1 0 x10 5' / '0 1 2' (frame = previous + 1 after the last x).
identifier(self)
integrate(self, t1, t2)
keys(self)
knob(self)
knobAndFieldName(self)
knobIndex(self)
noExpression(self)
removeKey(self, keys)
selected(self)
setExpression(self, expr)
setKey(self, t, y)
size(self)
toScript(self, selected=False)
view(self)

nuke.AnimationKey

nuke.Array_Knob

Numeric knob with N channels (Double/Int/XY/Color/... derive from it).

MethodDescription
Class(self)
animation(self, chan=0, view=None)
animations(self, view=None)
array(self)
arraySize(self)
clearAnimated(self, index=-1, view=None)
clearExpression(self, channel=-1)
clearFlag(self, f)
copyAnimation(self, channel, curve, view=None)
copyAnimations(self, curves, view=None)
debug(self, message)
defaultValue(self)
dimensions(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getKeyIndex(self, time, index=0, view=None)
getKeyList(self, *a)
getKeyTime(self, key, index=0, view=None)
getNumKeys(self, index=0, view=None)
getText(self)
getValue(self, index=0, view=None, time=None)
getValueAt(self, time, index=0, view=None)
hasExpression(self, index=-1, view=None)
height(self)
isAnimated(self, index=-1, view=None)
isEnabled(self)
isKey(self, index=-1, view=None)
isKeyAt(self, time, index=-1, view=None)
label(self)
max(self)
min(self)
name(self)
node(self)
notDefault(self)
removeKey(self, index=-1, view=None)
removeKeyAt(self, time, index=-1, view=None)
resize(self, w, h=1)
setAnimated(self, index=-1, view=None)
setEnabled(self, b)
setExpression(self, expression, channel=-1, view=None)
setFlag(self, f)
setKeyAt(self, time, index=-1, view=None)
setLabel(self, label)
setName(self, name)
setRange(self, lo, hi)
setTooltip(self, text)
setValue(self, value, index=-1, time=None, view=None)
setValueAt(self, value, time, index=-1, view=None)
setVisible(self, b)
singleValue(self, view=None)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, index=None, view=None, time=None)
valueAt(self, time, index=None, view=None)
visible(self)
warning(self, message)
width(self)

nuke.BBox_Knob

MethodDescription
Class(self)
animation(self, chan=0, view=None)
animations(self, view=None)
array(self)
arraySize(self)
clearAnimated(self, index=-1, view=None)
clearExpression(self, channel=-1)
clearFlag(self, f)
copyAnimation(self, channel, curve, view=None)
copyAnimations(self, curves, view=None)
debug(self, message)
defaultValue(self)
dimensions(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getKeyIndex(self, time, index=0, view=None)
getKeyList(self, *a)
getKeyTime(self, key, index=0, view=None)
getNumKeys(self, index=0, view=None)
getText(self)
getValue(self, index=0, view=None, time=None)
getValueAt(self, time, index=0, view=None)
hasExpression(self, index=-1, view=None)
height(self)
isAnimated(self, index=-1, view=None)
isEnabled(self)
isKey(self, index=-1, view=None)
isKeyAt(self, time, index=-1, view=None)
label(self)
max(self)
min(self)
name(self)
names(self, n)
node(self)
notDefault(self)
r(self)
removeKey(self, index=-1, view=None)
removeKeyAt(self, time, index=-1, view=None)
resize(self, w, h=1)
setAnimated(self, index=-1, view=None)
setEnabled(self, b)
setExpression(self, expression, channel=-1, view=None)
setFlag(self, f)
setKeyAt(self, time, index=-1, view=None)
setLabel(self, label)
setName(self, name)
setR(self, v)
setRange(self, lo, hi)
setT(self, v)
setTooltip(self, text)
setValue(self, value, index=-1, time=None, view=None)
setValueAt(self, value, time, index=-1, view=None)
setVisible(self, b)
setX(self, v)
setY(self, v)
singleValue(self, view=None)
t(self)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, index=None, view=None, time=None)
valueAt(self, time, index=None, view=None)
visible(self)
warning(self, message)
width(self)
x(self)
y(self)

nuke.BeginTabGroup_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getText(self)
getValue(self)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value)
setVisible(self, b)
toScript(self, quote=False, context=None)
tooltip(self)
value(self)
visible(self)
warning(self, message)

nuke.Boolean_Knob

MethodDescription
Class(self)
animation(self, chan=0, view=None)
animations(self, view=None)
array(self)
arraySize(self)
clearAnimated(self, index=-1, view=None)
clearExpression(self, channel=-1)
clearFlag(self, f)
copyAnimation(self, channel, curve, view=None)
copyAnimations(self, curves, view=None)
debug(self, message)
defaultValue(self)
dimensions(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getKeyIndex(self, time, index=0, view=None)
getKeyList(self, *a)
getKeyTime(self, key, index=0, view=None)
getNumKeys(self, index=0, view=None)
getText(self)
getValue(self, *a, **k)
getValueAt(self, time, index=0, view=None)
hasExpression(self, index=-1, view=None)
height(self)
isAnimated(self, index=-1, view=None)
isEnabled(self)
isKey(self, index=-1, view=None)
isKeyAt(self, time, index=-1, view=None)
label(self)
max(self)
min(self)
name(self)
node(self)
notDefault(self)
removeKey(self, index=-1, view=None)
removeKeyAt(self, time, index=-1, view=None)
resize(self, w, h=1)
setAnimated(self, index=-1, view=None)
setEnabled(self, b)
setExpression(self, expression, channel=-1, view=None)
setFlag(self, f)
setKeyAt(self, time, index=-1, view=None)
setLabel(self, label)
setName(self, name)
setRange(self, lo, hi)
setTooltip(self, text)
setValue(self, value, *a, **k)
setValueAt(self, value, time, index=-1, view=None)
setVisible(self, b)
singleValue(self, view=None)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, *a, **k)
valueAt(self, time, index=None, view=None)
visible(self)
warning(self, message)
width(self)

nuke.Box3_Knob

MethodDescription
Class(self)
animation(self, chan=0, view=None)
animations(self, view=None)
array(self)
arraySize(self)
clearAnimated(self, index=-1, view=None)
clearExpression(self, channel=-1)
clearFlag(self, f)
copyAnimation(self, channel, curve, view=None)
copyAnimations(self, curves, view=None)
debug(self, message)
defaultValue(self)
dimensions(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getKeyIndex(self, time, index=0, view=None)
getKeyList(self, *a)
getKeyTime(self, key, index=0, view=None)
getNumKeys(self, index=0, view=None)
getText(self)
getValue(self, index=0, view=None, time=None)
getValueAt(self, time, index=0, view=None)
hasExpression(self, index=-1, view=None)
height(self)
isAnimated(self, index=-1, view=None)
isEnabled(self)
isKey(self, index=-1, view=None)
isKeyAt(self, time, index=-1, view=None)
label(self)
max(self)
min(self)
name(self)
node(self)
notDefault(self)
removeKey(self, index=-1, view=None)
removeKeyAt(self, time, index=-1, view=None)
resize(self, w, h=1)
setAnimated(self, index=-1, view=None)
setEnabled(self, b)
setExpression(self, expression, channel=-1, view=None)
setFlag(self, f)
setKeyAt(self, time, index=-1, view=None)
setLabel(self, label)
setName(self, name)
setRange(self, lo, hi)
setTooltip(self, text)
setValue(self, value, index=-1, time=None, view=None)
setValueAt(self, value, time, index=-1, view=None)
setVisible(self, b)
singleValue(self, view=None)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, index=None, view=None, time=None)
valueAt(self, time, index=None, view=None)
visible(self)
warning(self, message)
width(self)

nuke.CascadingEnumeration_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
enumName(self, n)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getText(self)
getValue(self, *a)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
numValues(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value, *a)
setValues(self, items)
setVisible(self, b)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, *a)
values(self)
visible(self)
warning(self, message)

nuke.ChannelMask_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
depth(self)
enabled(self)
enabledChannels(self)
error(self, message)
evaluate(self, time=None)Nuke evaluates TCL in the string; we substitute [frame] and frame padding.
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getEvaluatedValue(self, *a)
getFlag(self, f)
getText(self)
getValue(self, *a, **k)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value, *a, **k)
setVisible(self, b)
splitView(self, *a)
toScript(self, quote=False, context=None)
tooltip(self)
unsplitView(self, *a)
value(self, *a, **k)
visible(self)
warning(self, message)

nuke.Channel_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
depth(self)
enabled(self)
enabledChannels(self)
error(self, message)
evaluate(self, time=None)Nuke evaluates TCL in the string; we substitute [frame] and frame padding.
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getEvaluatedValue(self, *a)
getFlag(self, f)
getText(self)
getValue(self, *a, **k)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value, *a, **k)
setVisible(self, b)
splitView(self, *a)
toScript(self, quote=False, context=None)
tooltip(self)
unsplitView(self, *a)
value(self, *a, **k)
visible(self)
warning(self, message)

nuke.ColorChip_Knob

MethodDescription
Class(self)
animation(self, chan=0, view=None)
animations(self, view=None)
array(self)
arraySize(self)
clearAnimated(self, index=-1, view=None)
clearExpression(self, channel=-1)
clearFlag(self, f)
copyAnimation(self, channel, curve, view=None)
copyAnimations(self, curves, view=None)
debug(self, message)
defaultValue(self)
dimensions(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getKeyIndex(self, time, index=0, view=None)
getKeyList(self, *a)
getKeyTime(self, key, index=0, view=None)
getNumKeys(self, index=0, view=None)
getText(self)
getValue(self, index=0, view=None, time=None)
getValueAt(self, time, index=0, view=None)
hasExpression(self, index=-1, view=None)
height(self)
isAnimated(self, index=-1, view=None)
isEnabled(self)
isKey(self, index=-1, view=None)
isKeyAt(self, time, index=-1, view=None)
label(self)
max(self)
min(self)
name(self)
node(self)
notDefault(self)
removeKey(self, index=-1, view=None)
removeKeyAt(self, time, index=-1, view=None)
resize(self, w, h=1)
setAnimated(self, index=-1, view=None)
setEnabled(self, b)
setExpression(self, expression, channel=-1, view=None)
setFlag(self, f)
setKeyAt(self, time, index=-1, view=None)
setLabel(self, label)
setName(self, name)
setRange(self, lo, hi)
setTooltip(self, text)
setValue(self, value, index=-1, time=None, view=None)
setValueAt(self, value, time, index=-1, view=None)
setVisible(self, b)
singleValue(self, view=None)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, index=None, view=None, time=None)
valueAt(self, time, index=None, view=None)
visible(self)
warning(self, message)
width(self)

nuke.ColorWheel_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getText(self)
getValue(self)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value)
setVisible(self, b)
toScript(self, quote=False, context=None)
tooltip(self)
value(self)
visible(self)
warning(self, message)

nuke.Color_Knob

MethodDescription
Class(self)
animation(self, chan=0, view=None)
animations(self, view=None)
array(self)
arraySize(self)
clearAnimated(self, index=-1, view=None)
clearExpression(self, channel=-1)
clearFlag(self, f)
copyAnimation(self, channel, curve, view=None)
copyAnimations(self, curves, view=None)
debug(self, message)
defaultValue(self)
dimensions(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getKeyIndex(self, time, index=0, view=None)
getKeyList(self, *a)
getKeyTime(self, key, index=0, view=None)
getNumKeys(self, index=0, view=None)
getText(self)
getValue(self, index=0, view=None, time=None)
getValueAt(self, time, index=0, view=None)
hasExpression(self, index=-1, view=None)
height(self)
isAnimated(self, index=-1, view=None)
isEnabled(self)
isKey(self, index=-1, view=None)
isKeyAt(self, time, index=-1, view=None)
label(self)
max(self)
min(self)
name(self)
names(self, n)
node(self)
notDefault(self)
removeKey(self, index=-1, view=None)
removeKeyAt(self, time, index=-1, view=None)
resize(self, w, h=1)
setAnimated(self, index=-1, view=None)
setEnabled(self, b)
setExpression(self, expression, channel=-1, view=None)
setFlag(self, f)
setKeyAt(self, time, index=-1, view=None)
setLabel(self, label)
setName(self, name)
setRange(self, lo, hi)
setTooltip(self, text)
setValue(self, value, index=-1, time=None, view=None)
setValueAt(self, value, time, index=-1, view=None)
setVisible(self, b)
singleValue(self, view=None)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, index=None, view=None, time=None)
valueAt(self, time, index=None, view=None)
visible(self)
warning(self, message)
width(self)

nuke.Disable_Knob

MethodDescription
Class(self)
animation(self, chan=0, view=None)
animations(self, view=None)
array(self)
arraySize(self)
clearAnimated(self, index=-1, view=None)
clearExpression(self, channel=-1)
clearFlag(self, f)
copyAnimation(self, channel, curve, view=None)
copyAnimations(self, curves, view=None)
debug(self, message)
defaultValue(self)
dimensions(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getKeyIndex(self, time, index=0, view=None)
getKeyList(self, *a)
getKeyTime(self, key, index=0, view=None)
getNumKeys(self, index=0, view=None)
getText(self)
getValue(self, *a, **k)
getValueAt(self, time, index=0, view=None)
hasExpression(self, index=-1, view=None)
height(self)
isAnimated(self, index=-1, view=None)
isEnabled(self)
isKey(self, index=-1, view=None)
isKeyAt(self, time, index=-1, view=None)
label(self)
max(self)
min(self)
name(self)
node(self)
notDefault(self)
removeKey(self, index=-1, view=None)
removeKeyAt(self, time, index=-1, view=None)
resize(self, w, h=1)
setAnimated(self, index=-1, view=None)
setEnabled(self, b)
setExpression(self, expression, channel=-1, view=None)
setFlag(self, f)
setKeyAt(self, time, index=-1, view=None)
setLabel(self, label)
setName(self, name)
setRange(self, lo, hi)
setTooltip(self, text)
setValue(self, value, *a, **k)
setValueAt(self, value, time, index=-1, view=None)
setVisible(self, b)
singleValue(self, view=None)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, *a, **k)
valueAt(self, time, index=None, view=None)
visible(self)
warning(self, message)
width(self)

nuke.Double_Knob

MethodDescription
Class(self)
animation(self, chan=0, view=None)
animations(self, view=None)
array(self)
arraySize(self)
clearAnimated(self, index=-1, view=None)
clearExpression(self, channel=-1)
clearFlag(self, f)
copyAnimation(self, channel, curve, view=None)
copyAnimations(self, curves, view=None)
debug(self, message)
defaultValue(self)
dimensions(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getKeyIndex(self, time, index=0, view=None)
getKeyList(self, *a)
getKeyTime(self, key, index=0, view=None)
getNumKeys(self, index=0, view=None)
getText(self)
getValue(self, index=0, view=None, time=None)
getValueAt(self, time, index=0, view=None)
hasExpression(self, index=-1, view=None)
height(self)
isAnimated(self, index=-1, view=None)
isEnabled(self)
isKey(self, index=-1, view=None)
isKeyAt(self, time, index=-1, view=None)
label(self)
max(self)
min(self)
name(self)
node(self)
notDefault(self)
removeKey(self, index=-1, view=None)
removeKeyAt(self, time, index=-1, view=None)
resize(self, w, h=1)
setAnimated(self, index=-1, view=None)
setEnabled(self, b)
setExpression(self, expression, channel=-1, view=None)
setFlag(self, f)
setKeyAt(self, time, index=-1, view=None)
setLabel(self, label)
setName(self, name)
setRange(self, lo, hi)
setTooltip(self, text)
setValue(self, value, index=-1, time=None, view=None)
setValueAt(self, value, time, index=-1, view=None)
setVisible(self, b)
singleValue(self, view=None)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, index=None, view=None, time=None)
valueAt(self, time, index=None, view=None)
visible(self)
warning(self, message)
width(self)

nuke.EndTabGroup_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getText(self)
getValue(self)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value)
setVisible(self, b)
toScript(self, quote=False, context=None)
tooltip(self)
value(self)
visible(self)
warning(self, message)

nuke.Enumeration_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
enumName(self, n)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getText(self)
getValue(self, *a)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
numValues(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value, *a)
setValues(self, items)
setVisible(self, b)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, *a)
values(self)
visible(self)
warning(self, message)

nuke.EvalString_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
evaluate(self, time=None)Nuke evaluates TCL in the string; we substitute [frame] and frame padding.
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getEvaluatedValue(self, *a)
getFlag(self, f)
getText(self)
getValue(self, *a, **k)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value, *a, **k)
setVisible(self, b)
splitView(self, *a)
toScript(self, quote=False, context=None)
tooltip(self)
unsplitView(self, *a)
value(self, *a, **k)
visible(self)
warning(self, message)

nuke.File_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
evaluate(self, time=None)Nuke evaluates TCL in the string; we substitute [frame] and frame padding.
fromScript(self, s)
fromUserText(self, s)
fullyQualifiedName(self, channel=-1)
getEvaluatedValue(self, *a)
getFlag(self, f)
getText(self)
getValue(self, *a, **k)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value, *a, **k)
setVisible(self, b)
splitView(self, *a)
toScript(self, quote=False, context=None)
tooltip(self)
unsplitView(self, *a)
value(self, *a, **k)
visible(self)
warning(self, message)

nuke.Font_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
evaluate(self, time=None)Nuke evaluates TCL in the string; we substitute [frame] and frame padding.
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getEvaluatedValue(self, *a)
getFlag(self, f)
getText(self)
getValue(self, *a, **k)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value, *a, **k)
setVisible(self, b)
splitView(self, *a)
toScript(self, quote=False, context=None)
tooltip(self)
unsplitView(self, *a)
value(self, *a, **k)
visible(self)
warning(self, message)

nuke.Format

MethodDescription
add(self, name)
fromUV(self, u, v)
height(self)
name(self)
pixelAspect(self)
r(self)
scaled(self, sx, sy, tx=0, ty=0)
setHeight(self, h)
setName(self, n)
setPixelAspect(self, pa)
setR(self, v)
setT(self, v)
setWidth(self, w)
setX(self, v)
setY(self, v)
t(self)
toScript(self)
toUV(self, x, y)
width(self)
x(self)
y(self)

nuke.Format_Knob

MethodDescription
Class(self)
actualValue(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getText(self)
getValue(self)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, v, *a)
setVisible(self, b)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, *a)
visible(self)
warning(self, message)

nuke.FrameRange

MethodDescription
first(self)
frames(self)
increment(self)
last(self)
setFirst(self, v)
setLast(self, v)

nuke.FrameRanges

MethodDescription
size(self)
toFrameList(self)

nuke.Gizmo

MethodDescription
Class(self)
addKnob(self, knob)Add a user knob (nuke.XXX_Knob) — stored like .nk addUserKnob knobs (nk/user_knobs.py),
allKnobs(self)
autoplace(self)
bbox(self)
begin(self)
channels(self)
clones(self)
connectInput(self, i, node)
connectSelectedNodes(self, *a)
dependencies(self, what=7)
dependent(self, what=7, forceEvaluate=True)
end(self)
error(self)
exists(self)
expand(self)
firstFrame(self)
forceUpdateLocalization(self)
forceValidate(self)
format(self)
frameRange(self)
fullName(self)
hasError(self)
height(self)
help(self)
hideControlPanel(self)
input(self, i)
inputs(self)Nuke: number of inputs = highest connected input + 1 (or minInputs).
isLocalised(self)
isLocalizationOutdated(self)
isLocalized(self)
isSelected(self)
isValid(self)
knob(self, name)Knob by name (or index into allKnobs()); None when there's none (Nuke).
knobs(self)
lastFrame(self)
localizationProgress(self)
makeGroup(self)Copy to group: the same node, no longer tied to its .gizmo file.
maxInputs(self)
metadata(self, key=None, time=None, view=None)
minInputs(self)
name(self)
node(self, name)
nodes(self)
numKnobs(self)
opCount(self)
optionalInput(self)
output(self)
pixelAspect(self)
readKnobs(self, text)
redraw(self)
removeKnob(self, knob)
resetKnobsToDefault(self)
run(self, fn, *args)
running(self)
sample(self, channel, x, y, dx=1.0, dy=1.0, frame=None, view=None)Pixel value of channel ('rgba.red', 'red', 'r', 0..3) at (x, y), y up (Nuke).
screenHeight(self)
screenWidth(self)
selectOnly(self)
selectedNodes(self)
setInput(self, i, node)
setName(self, name, uncollide=True, updateExpressions=False)
setSelected(self, selected=True)
setXYpos(self, x, y)
setXpos(self, x)
setYpos(self, y)
showControlPanel(self, forceFloat=False)
showInfo(self, s=None)
shown(self)
type(self)
warning(self, message)
width(self)
writeKnobs(self, flags=0)
xpos(self)
ypos(self)

nuke.Group

Group / Gizmo (nodes/utility/group.py: a node with an inner node tree). with group: / group.begin() make createNode / toNode / allNodes work inside it, like Nuke.

MethodDescription
Class(self)
addKnob(self, knob)Add a user knob (nuke.XXX_Knob) — stored like .nk addUserKnob knobs (nk/user_knobs.py),
allKnobs(self)
autoplace(self)
bbox(self)
begin(self)
channels(self)
clones(self)
connectInput(self, i, node)
connectSelectedNodes(self, *a)
dependencies(self, what=7)
dependent(self, what=7, forceEvaluate=True)
end(self)
error(self)
exists(self)
expand(self)
firstFrame(self)
forceUpdateLocalization(self)
forceValidate(self)
format(self)
frameRange(self)
fullName(self)
hasError(self)
height(self)
help(self)
hideControlPanel(self)
input(self, i)
inputs(self)Nuke: number of inputs = highest connected input + 1 (or minInputs).
isLocalised(self)
isLocalizationOutdated(self)
isLocalized(self)
isSelected(self)
isValid(self)
knob(self, name)Knob by name (or index into allKnobs()); None when there's none (Nuke).
knobs(self)
lastFrame(self)
localizationProgress(self)
maxInputs(self)
metadata(self, key=None, time=None, view=None)
minInputs(self)
name(self)
node(self, name)
nodes(self)
numKnobs(self)
opCount(self)
optionalInput(self)
output(self)
pixelAspect(self)
readKnobs(self, text)
redraw(self)
removeKnob(self, knob)
resetKnobsToDefault(self)
run(self, fn, *args)
running(self)
sample(self, channel, x, y, dx=1.0, dy=1.0, frame=None, view=None)Pixel value of channel ('rgba.red', 'red', 'r', 0..3) at (x, y), y up (Nuke).
screenHeight(self)
screenWidth(self)
selectOnly(self)
selectedNodes(self)
setInput(self, i, node)
setName(self, name, uncollide=True, updateExpressions=False)
setSelected(self, selected=True)
setXYpos(self, x, y)
setXpos(self, x)
setYpos(self, y)
showControlPanel(self, forceFloat=False)
showInfo(self, s=None)
shown(self)
type(self)
warning(self, message)
width(self)
writeKnobs(self, flags=0)
xpos(self)
ypos(self)

nuke.Help_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
evaluate(self, time=None)Nuke evaluates TCL in the string; we substitute [frame] and frame padding.
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getEvaluatedValue(self, *a)
getFlag(self, f)
getText(self)
getValue(self, *a, **k)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value, *a, **k)
setVisible(self, b)
splitView(self, *a)
toScript(self, quote=False, context=None)
tooltip(self)
unsplitView(self, *a)
value(self, *a, **k)
visible(self)
warning(self, message)

nuke.Histogram_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getText(self)
getValue(self)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value)
setVisible(self, b)
toScript(self, quote=False, context=None)
tooltip(self)
value(self)
visible(self)
warning(self, message)

nuke.Int_Knob

MethodDescription
Class(self)
animation(self, chan=0, view=None)
animations(self, view=None)
array(self)
arraySize(self)
clearAnimated(self, index=-1, view=None)
clearExpression(self, channel=-1)
clearFlag(self, f)
copyAnimation(self, channel, curve, view=None)
copyAnimations(self, curves, view=None)
debug(self, message)
defaultValue(self)
dimensions(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getKeyIndex(self, time, index=0, view=None)
getKeyList(self, *a)
getKeyTime(self, key, index=0, view=None)
getNumKeys(self, index=0, view=None)
getText(self)
getValue(self, index=0, view=None, time=None)
getValueAt(self, time, index=0, view=None)
hasExpression(self, index=-1, view=None)
height(self)
isAnimated(self, index=-1, view=None)
isEnabled(self)
isKey(self, index=-1, view=None)
isKeyAt(self, time, index=-1, view=None)
label(self)
max(self)
min(self)
name(self)
node(self)
notDefault(self)
removeKey(self, index=-1, view=None)
removeKeyAt(self, time, index=-1, view=None)
resize(self, w, h=1)
setAnimated(self, index=-1, view=None)
setEnabled(self, b)
setExpression(self, expression, channel=-1, view=None)
setFlag(self, f)
setKeyAt(self, time, index=-1, view=None)
setLabel(self, label)
setName(self, name)
setRange(self, lo, hi)
setTooltip(self, text)
setValue(self, value, index=-1, time=None, view=None)
setValueAt(self, value, time, index=-1, view=None)
setVisible(self, b)
singleValue(self, view=None)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, index=None, view=None, time=None)
valueAt(self, time, index=None, view=None)
visible(self)
warning(self, message)
width(self)

nuke.Keyer_Knob

MethodDescription
Class(self)
animation(self, chan=0, view=None)
animations(self, view=None)
array(self)
arraySize(self)
clearAnimated(self, index=-1, view=None)
clearExpression(self, channel=-1)
clearFlag(self, f)
copyAnimation(self, channel, curve, view=None)
copyAnimations(self, curves, view=None)
debug(self, message)
defaultValue(self)
dimensions(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getKeyIndex(self, time, index=0, view=None)
getKeyList(self, *a)
getKeyTime(self, key, index=0, view=None)
getNumKeys(self, index=0, view=None)
getText(self)
getValue(self, index=0, view=None, time=None)
getValueAt(self, time, index=0, view=None)
hasExpression(self, index=-1, view=None)
height(self)
isAnimated(self, index=-1, view=None)
isEnabled(self)
isKey(self, index=-1, view=None)
isKeyAt(self, time, index=-1, view=None)
label(self)
max(self)
min(self)
name(self)
node(self)
notDefault(self)
removeKey(self, index=-1, view=None)
removeKeyAt(self, time, index=-1, view=None)
resize(self, w, h=1)
setAnimated(self, index=-1, view=None)
setEnabled(self, b)
setExpression(self, expression, channel=-1, view=None)
setFlag(self, f)
setKeyAt(self, time, index=-1, view=None)
setLabel(self, label)
setName(self, name)
setRange(self, lo, hi)
setTooltip(self, text)
setValue(self, value, index=-1, time=None, view=None)
setValueAt(self, value, time, index=-1, view=None)
setVisible(self, b)
singleValue(self, view=None)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, index=None, view=None, time=None)
valueAt(self, time, index=None, view=None)
visible(self)
warning(self, message)
width(self)

nuke.Knob

nuke.Knob — base of every knob.

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getText(self)
getValue(self)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value)
setVisible(self, b)
toScript(self, quote=False, context=None)
tooltip(self)
value(self)
visible(self)
warning(self, message)

nuke.Layer

MethodDescription
channels(self)
name(self)

Nuke Link_Knob: shows another knob (value() reads the linked knob).

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getLink(self)
getText(self)
getValue(self)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
makeLink(self, node, knob)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setLink(self, s)
setName(self, name)
setTooltip(self, text)
setValue(self, v, *a)
setVisible(self, b)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, *a)
visible(self)
warning(self, message)

nuke.LookupCurves_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getText(self)
getValue(self)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value)
setVisible(self, b)
toScript(self, quote=False, context=None)
tooltip(self)
value(self)
visible(self)
warning(self, message)

nuke.Menu

MethodDescription
action(self)
addAction(self, action)
addCommand(self, name, command=None, shortcut='', icon='', tooltip='', index=-1, readonly=False, shortcutContext=0, tag=None, tagTarget=None, **kwargs)
addMenu(self, name, icon='', tooltip='', index=-1, **kwargs)
addSeparator(self, index=-1, **kwargs)
clearMenu(self)
findItem(self, name)
icon(self)
invoke(self)Run the item's command (callable or Python text).
isChecked(self)
isEnabled(self)
items(self)
menu(self, name)
name(self)
path(self)
removeItem(self, name)
script(self)
setCheckable(self, b)
setChecked(self, b)
setEnabled(self, b)
setIcon(self, s)
setScript(self, s)
setShortcut(self, s)
setToolTip(self, s)
setTooltip(self, s)
setVisible(self, b)
shortcut(self)
tooltip(self)
updateMenuItems(self)

nuke.MenuItem

MethodDescription
action(self)
icon(self)
invoke(self)Run the item's command (callable or Python text).
isChecked(self)
isEnabled(self)
name(self)
path(self)
script(self)
setCheckable(self, b)
setChecked(self, b)
setEnabled(self, b)
setIcon(self, s)
setScript(self, s)
setShortcut(self, s)
setToolTip(self, s)
setTooltip(self, s)
setVisible(self, b)
shortcut(self)
tooltip(self)

nuke.Multiline_Eval_String_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
evaluate(self, time=None)Nuke evaluates TCL in the string; we substitute [frame] and frame padding.
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getEvaluatedValue(self, *a)
getFlag(self, f)
getText(self)
getValue(self, *a, **k)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value, *a, **k)
setVisible(self, b)
splitView(self, *a)
toScript(self, quote=False, context=None)
tooltip(self)
unsplitView(self, *a)
value(self, *a, **k)
visible(self)
warning(self, message)

nuke.Node

nuke.Node: one node of the comp.

MethodDescription
Class(self)
addKnob(self, knob)Add a user knob (nuke.XXX_Knob) — stored like .nk addUserKnob knobs (nk/user_knobs.py),
allKnobs(self)
autoplace(self)
bbox(self)
begin(self)
channels(self)
clones(self)
connectInput(self, i, node)
dependencies(self, what=7)
dependent(self, what=7, forceEvaluate=True)
end(self)
error(self)
exists(self)
firstFrame(self)
forceUpdateLocalization(self)
forceValidate(self)
format(self)
frameRange(self)
fullName(self)
hasError(self)
height(self)
help(self)
hideControlPanel(self)
input(self, i)
inputs(self)Nuke: number of inputs = highest connected input + 1 (or minInputs).
isLocalised(self)
isLocalizationOutdated(self)
isLocalized(self)
isSelected(self)
isValid(self)
knob(self, name)Knob by name (or index into allKnobs()); None when there's none (Nuke).
knobs(self)
lastFrame(self)
localizationProgress(self)
maxInputs(self)
metadata(self, key=None, time=None, view=None)
minInputs(self)
name(self)
numKnobs(self)
opCount(self)
optionalInput(self)
pixelAspect(self)
readKnobs(self, text)
redraw(self)
removeKnob(self, knob)
resetKnobsToDefault(self)
running(self)
sample(self, channel, x, y, dx=1.0, dy=1.0, frame=None, view=None)Pixel value of channel ('rgba.red', 'red', 'r', 0..3) at (x, y), y up (Nuke).
screenHeight(self)
screenWidth(self)
selectOnly(self)
setInput(self, i, node)
setName(self, name, uncollide=True, updateExpressions=False)
setSelected(self, selected=True)
setXYpos(self, x, y)
setXpos(self, x)
setYpos(self, y)
showControlPanel(self, forceFloat=False)
showInfo(self, s=None)
shown(self)
type(self)
warning(self, message)
width(self)
writeKnobs(self, flags=0)
xpos(self)
ypos(self)

nuke.Obsolete_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getText(self)
getValue(self)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value)
setVisible(self, b)
toScript(self, quote=False, context=None)
tooltip(self)
value(self)
visible(self)
warning(self, message)

nuke.Panel

nuke.Panel(title): addSingleLineInput / addEnumerationPulldown / ... ; show() -> 1 OK, 0 Cancel (or the index of an addButton button); value(name).

MethodDescription
addBooleanCheckBox(self, name, value=False)
addButton(self, name, value=None)
addClipnameSearch(self, name, value='')
addEnumerationPulldown(self, name, value='')
addExpressionInput(self, name, value='')
addFilenameSearch(self, name, value='')
addMultilineTextInput(self, name, value='')
addNotepad(self, name, value='')
addPasswordInput(self, name, value='')
addRGBColorChip(self, name, value=0)
addScriptCommand(self, name, value='')
addSingleLineInput(self, name, value='')
addTextFontPulldown(self, name, value='')
clear(self)
execute(self, name)
setTitle(self, t)
setWidth(self, w)
show(self)
title(self)
value(self, name)
width(self)

nuke.Password_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
evaluate(self, time=None)Nuke evaluates TCL in the string; we substitute [frame] and frame padding.
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getEvaluatedValue(self, *a)
getFlag(self, f)
getText(self)
getValue(self, *a, **k)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value, *a, **k)
setVisible(self, b)
splitView(self, *a)
toScript(self, quote=False, context=None)
tooltip(self)
unsplitView(self, *a)
value(self, *a, **k)
visible(self)
warning(self, message)

nuke.ProgressTask

nuke.ProgressTask(title): a progress dialog with a Cancel button. setMessage / setProgress update it; isCancelled() is True once the user pressed Cancel (the backend reads the UI's answer while the script runs). The dialog closes when the task is deleted.

MethodDescription
isCancelled(self)
setMessage(self, m)
setProgress(self, p)

nuke.Pulldown_Knob

Menu of commands: {'label': 'python code', ...}.

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
commands(self)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
execute(self, label)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getText(self)
getValue(self)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
itemName(self, n)
label(self)
name(self)
node(self)
notDefault(self)
numValues(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value)
setValues(self, items)
setVisible(self, b)
toScript(self, quote=False, context=None)
tooltip(self)
value(self)
values(self)
visible(self)
warning(self, message)

nuke.PyCustom_Knob

Custom Qt widget knob: Qt isn't available in the Electron UI (docs/notes/nuke-python.md).

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
command(self)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
execute(self)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getObject(self)
getText(self)
getValue(self)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setCommand(self, cmd)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, v, *a)
setVisible(self, b)
toScript(self, quote=False, context=None)
tooltip(self)
value(self)
visible(self)
warning(self, message)

nuke.PyScript_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
command(self)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
execute(self)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getText(self)
getValue(self)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setCommand(self, cmd)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, v, *a)
setVisible(self, b)
toScript(self, quote=False, context=None)
tooltip(self)
value(self)
visible(self)
warning(self, message)

nuke.PythonKnob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
evaluate(self, time=None)Nuke evaluates TCL in the string; we substitute [frame] and frame padding.
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getEvaluatedValue(self, *a)
getFlag(self, f)
getText(self)
getValue(self, *a, **k)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value, *a, **k)
setVisible(self, b)
splitView(self, *a)
toScript(self, quote=False, context=None)
tooltip(self)
unsplitView(self, *a)
value(self, *a, **k)
visible(self)
warning(self, message)

nuke.Radio_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
enumName(self, n)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getText(self)
getValue(self, *a)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
numValues(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value, *a)
setValues(self, items)
setVisible(self, b)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, *a)
values(self)
visible(self)
warning(self, message)

nuke.Range_Knob

MethodDescription
Class(self)
animation(self, chan=0, view=None)
animations(self, view=None)
array(self)
arraySize(self)
clearAnimated(self, index=-1, view=None)
clearExpression(self, channel=-1)
clearFlag(self, f)
copyAnimation(self, channel, curve, view=None)
copyAnimations(self, curves, view=None)
debug(self, message)
defaultValue(self)
dimensions(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getKeyIndex(self, time, index=0, view=None)
getKeyList(self, *a)
getKeyTime(self, key, index=0, view=None)
getNumKeys(self, index=0, view=None)
getText(self)
getValue(self, index=0, view=None, time=None)
getValueAt(self, time, index=0, view=None)
hasExpression(self, index=-1, view=None)
height(self)
isAnimated(self, index=-1, view=None)
isEnabled(self)
isKey(self, index=-1, view=None)
isKeyAt(self, time, index=-1, view=None)
label(self)
max(self)
min(self)
name(self)
node(self)
notDefault(self)
removeKey(self, index=-1, view=None)
removeKeyAt(self, time, index=-1, view=None)
resize(self, w, h=1)
setAnimated(self, index=-1, view=None)
setEnabled(self, b)
setExpression(self, expression, channel=-1, view=None)
setFlag(self, f)
setKeyAt(self, time, index=-1, view=None)
setLabel(self, label)
setName(self, name)
setRange(self, lo, hi)
setTooltip(self, text)
setValue(self, value, index=-1, time=None, view=None)
setValueAt(self, value, time, index=-1, view=None)
setVisible(self, b)
singleValue(self, view=None)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, index=None, view=None, time=None)
valueAt(self, time, index=None, view=None)
visible(self)
warning(self, message)
width(self)

nuke.Root

nuke.root(): project settings (scene frame range / fps / format) + the comp tree.

MethodDescription
Class(self)
addKnob(self, knob)Add a user knob (nuke.XXX_Knob) — stored like .nk addUserKnob knobs (nk/user_knobs.py),
allKnobs(self)
autoplace(self)
bbox(self)
begin(self)
channels(self)
clones(self)
connectInput(self, i, node)
connectSelectedNodes(self, *a)
dependencies(self, *a)
dependent(self, *a)
end(self)
error(self)
exists(self)
expand(self)
firstFrame(self)
forceUpdateLocalization(self)
forceValidate(self)
format(self)
fps(self)
frameRange(self)
fullName(self)
hasError(self)
height(self)
help(self)
hideControlPanel(self)
input(self, i)
inputs(self)Nuke: number of inputs = highest connected input + 1 (or minInputs).
isLocalised(self)
isLocalizationOutdated(self)
isLocalized(self)
isSelected(self)
isValid(self)
knob(self, name)Knob by name (or index into allKnobs()); None when there's none (Nuke).
knobs(self)
lastFrame(self)
localizationProgress(self)
maxInputs(self)
metadata(self, key=None, time=None, view=None)
minInputs(self)
modified(self)
name(self)Nuke: the script's file path ('Root' while untitled).
node(self, name)
nodes(self)
numKnobs(self)
opCount(self)
optionalInput(self)
output(self)
pixelAspect(self)
readKnobs(self, text)
redraw(self)
removeKnob(self, knob)
resetKnobsToDefault(self)
run(self, fn, *args)
running(self)
sample(self, *a, **k)Pixel value of channel ('rgba.red', 'red', 'r', 0..3) at (x, y), y up (Nuke).
screenHeight(self)
screenWidth(self)
selectOnly(self)
selectedNodes(self)
setInput(self, *a)
setModified(self, b)
setName(self, *a, **k)
setSelected(self, *a)
setXYpos(self, x, y)
setXpos(self, x)
setYpos(self, y)
showControlPanel(self, forceFloat=False)
showInfo(self, s=None)
shown(self)
type(self)
warning(self, message)
width(self)
writeKnobs(self, flags=0)
xpos(self)
ypos(self)

nuke.Scale_Knob

MethodDescription
Class(self)
animation(self, chan=0, view=None)
animations(self, view=None)
array(self)
arraySize(self)
clearAnimated(self, index=-1, view=None)
clearExpression(self, channel=-1)
clearFlag(self, f)
copyAnimation(self, channel, curve, view=None)
copyAnimations(self, curves, view=None)
debug(self, message)
defaultValue(self)
dimensions(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getKeyIndex(self, time, index=0, view=None)
getKeyList(self, *a)
getKeyTime(self, key, index=0, view=None)
getNumKeys(self, index=0, view=None)
getText(self)
getValue(self, index=0, view=None, time=None)
getValueAt(self, time, index=0, view=None)
hasExpression(self, index=-1, view=None)
height(self)
isAnimated(self, index=-1, view=None)
isEnabled(self)
isKey(self, index=-1, view=None)
isKeyAt(self, time, index=-1, view=None)
label(self)
max(self)
min(self)
name(self)
node(self)
notDefault(self)
removeKey(self, index=-1, view=None)
removeKeyAt(self, time, index=-1, view=None)
resize(self, w, h=1)
setAnimated(self, index=-1, view=None)
setEnabled(self, b)
setExpression(self, expression, channel=-1, view=None)
setFlag(self, f)
setKeyAt(self, time, index=-1, view=None)
setLabel(self, label)
setName(self, name)
setRange(self, lo, hi)
setTooltip(self, text)
setValue(self, value, index=-1, time=None, view=None)
setValueAt(self, value, time, index=-1, view=None)
setVisible(self, b)
singleValue(self, view=None)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, index=None, view=None, time=None)
valueAt(self, time, index=None, view=None)
visible(self)
warning(self, message)
width(self)

nuke.Script_Knob

Button running a script (Nuke: Tcl; we run it as Python, then as Tcl via the Tcl module).

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
command(self)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
execute(self)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getText(self)
getValue(self)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setCommand(self, cmd)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, v, *a)
setVisible(self, b)
toScript(self, quote=False, context=None)
tooltip(self)
value(self)
visible(self)
warning(self, message)

nuke.String_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
evaluate(self, time=None)Nuke evaluates TCL in the string; we substitute [frame] and frame padding.
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getEvaluatedValue(self, *a)
getFlag(self, f)
getText(self)
getValue(self, *a, **k)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value, *a, **k)
setVisible(self, b)
splitView(self, *a)
toScript(self, quote=False, context=None)
tooltip(self)
unsplitView(self, *a)
value(self, *a, **k)
visible(self)
warning(self, message)

nuke.Tab_Knob

A tab (or, with nuke.TABBEGINGROUP etc., a group of knobs).

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getText(self)
getValue(self)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value)
setVisible(self, b)
toScript(self, quote=False, context=None)
tooltip(self)
value(self)
visible(self)
warning(self, message)

nuke.Text_Knob

Label / divider line in a panel (value = its text).

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
evaluate(self, time=None)Nuke evaluates TCL in the string; we substitute [frame] and frame padding.
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getEvaluatedValue(self, *a)
getFlag(self, f)
getText(self)
getValue(self, *a, **k)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value, *a, **k)
setVisible(self, b)
splitView(self, *a)
toScript(self, quote=False, context=None)
tooltip(self)
unsplitView(self, *a)
value(self, *a, **k)
visible(self)
warning(self, message)

nuke.ToolBar

MethodDescription
action(self)
addAction(self, action)
addCommand(self, name, command=None, shortcut='', icon='', tooltip='', index=-1, readonly=False, shortcutContext=0, tag=None, tagTarget=None, **kwargs)
addMenu(self, name, icon='', tooltip='', index=-1, **kwargs)
addSeparator(self, index=-1, **kwargs)
clearMenu(self)
findItem(self, name)
icon(self)
invoke(self)Run the item's command (callable or Python text).
isChecked(self)
isEnabled(self)
items(self)
menu(self, name)
name(self)
path(self)
removeItem(self, name)
script(self)
setCheckable(self, b)
setChecked(self, b)
setEnabled(self, b)
setIcon(self, s)
setScript(self, s)
setShortcut(self, s)
setToolTip(self, s)
setTooltip(self, s)
setVisible(self, b)
shortcut(self)
tooltip(self)
updateMenuItems(self)

nuke.Transform2d_Knob

MethodDescription
Class(self)
animations(self, *a)
clearFlag(self, f)
debug(self, message)
defaultValue(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getText(self)
getValue(self)
hasExpression(self, *a)
isAnimated(self, *a)
isEnabled(self)
isKey(self, *a)
label(self)
name(self)
node(self)
notDefault(self)
setEnabled(self, b)
setFlag(self, f)
setLabel(self, label)
setName(self, name)
setTooltip(self, text)
setValue(self, value)
setVisible(self, b)
toScript(self, quote=False, context=None)
tooltip(self)
value(self)
visible(self)
warning(self, message)

nuke.UV_Knob

MethodDescription
Class(self)
animation(self, chan=0, view=None)
animations(self, view=None)
array(self)
arraySize(self)
clearAnimated(self, index=-1, view=None)
clearExpression(self, channel=-1)
clearFlag(self, f)
copyAnimation(self, channel, curve, view=None)
copyAnimations(self, curves, view=None)
debug(self, message)
defaultValue(self)
dimensions(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getKeyIndex(self, time, index=0, view=None)
getKeyList(self, *a)
getKeyTime(self, key, index=0, view=None)
getNumKeys(self, index=0, view=None)
getText(self)
getValue(self, index=0, view=None, time=None)
getValueAt(self, time, index=0, view=None)
hasExpression(self, index=-1, view=None)
height(self)
isAnimated(self, index=-1, view=None)
isEnabled(self)
isKey(self, index=-1, view=None)
isKeyAt(self, time, index=-1, view=None)
label(self)
max(self)
min(self)
name(self)
names(self, n)
node(self)
notDefault(self)
removeKey(self, index=-1, view=None)
removeKeyAt(self, time, index=-1, view=None)
resize(self, w, h=1)
setAnimated(self, index=-1, view=None)
setEnabled(self, b)
setExpression(self, expression, channel=-1, view=None)
setFlag(self, f)
setKeyAt(self, time, index=-1, view=None)
setLabel(self, label)
setName(self, name)
setRange(self, lo, hi)
setTooltip(self, text)
setValue(self, value, index=-1, time=None, view=None)
setValueAt(self, value, time, index=-1, view=None)
setVisible(self, b)
singleValue(self, view=None)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, index=None, view=None, time=None)
valueAt(self, time, index=None, view=None)
visible(self)
warning(self, message)
width(self)
x(self)
y(self)

nuke.Undo

nuke.Undo: undo groups on Oink's Edit > Undo stack (opencomp_server/undo.py).

MethodDescription
begin(name=None)
cancel()Close the group and take back what it changed.
disable()Stop recording (changes until enable() are not undoable).
disabled()
enable()
end()
isEnabled()
name(name)Name the open group (Edit > Undo <name>).
new()
redo()
redoDescribe(n=0)
redoSize()
redoTruncate()
undo()
undoDescribe(n=0)
undoSize()
undoTruncate()Forget the undo history (nuke.Undo.undoTruncate).

nuke.WH_Knob

MethodDescription
Class(self)
animation(self, chan=0, view=None)
animations(self, view=None)
array(self)
arraySize(self)
clearAnimated(self, index=-1, view=None)
clearExpression(self, channel=-1)
clearFlag(self, f)
copyAnimation(self, channel, curve, view=None)
copyAnimations(self, curves, view=None)
debug(self, message)
defaultValue(self)
dimensions(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getKeyIndex(self, time, index=0, view=None)
getKeyList(self, *a)
getKeyTime(self, key, index=0, view=None)
getNumKeys(self, index=0, view=None)
getText(self)
getValue(self, index=0, view=None, time=None)
getValueAt(self, time, index=0, view=None)
hasExpression(self, index=-1, view=None)
height(self)
isAnimated(self, index=-1, view=None)
isEnabled(self)
isKey(self, index=-1, view=None)
isKeyAt(self, time, index=-1, view=None)
label(self)
max(self)
min(self)
name(self)
node(self)
notDefault(self)
removeKey(self, index=-1, view=None)
removeKeyAt(self, time, index=-1, view=None)
resize(self, w, h=1)
setAnimated(self, index=-1, view=None)
setEnabled(self, b)
setExpression(self, expression, channel=-1, view=None)
setFlag(self, f)
setKeyAt(self, time, index=-1, view=None)
setLabel(self, label)
setName(self, name)
setRange(self, lo, hi)
setTooltip(self, text)
setValue(self, value, index=-1, time=None, view=None)
setValueAt(self, value, time, index=-1, view=None)
setVisible(self, b)
singleValue(self, view=None)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, index=None, view=None, time=None)
valueAt(self, time, index=None, view=None)
visible(self)
warning(self, message)
width(self)

nuke.XYZ_Knob

MethodDescription
Class(self)
animation(self, chan=0, view=None)
animations(self, view=None)
array(self)
arraySize(self)
clearAnimated(self, index=-1, view=None)
clearExpression(self, channel=-1)
clearFlag(self, f)
copyAnimation(self, channel, curve, view=None)
copyAnimations(self, curves, view=None)
debug(self, message)
defaultValue(self)
dimensions(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getKeyIndex(self, time, index=0, view=None)
getKeyList(self, *a)
getKeyTime(self, key, index=0, view=None)
getNumKeys(self, index=0, view=None)
getText(self)
getValue(self, index=0, view=None, time=None)
getValueAt(self, time, index=0, view=None)
hasExpression(self, index=-1, view=None)
height(self)
isAnimated(self, index=-1, view=None)
isEnabled(self)
isKey(self, index=-1, view=None)
isKeyAt(self, time, index=-1, view=None)
label(self)
max(self)
min(self)
name(self)
names(self, n)
node(self)
notDefault(self)
removeKey(self, index=-1, view=None)
removeKeyAt(self, time, index=-1, view=None)
resize(self, w, h=1)
setAnimated(self, index=-1, view=None)
setEnabled(self, b)
setExpression(self, expression, channel=-1, view=None)
setFlag(self, f)
setKeyAt(self, time, index=-1, view=None)
setLabel(self, label)
setName(self, name)
setRange(self, lo, hi)
setTooltip(self, text)
setValue(self, value, index=-1, time=None, view=None)
setValueAt(self, value, time, index=-1, view=None)
setVisible(self, b)
singleValue(self, view=None)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, index=None, view=None, time=None)
valueAt(self, time, index=None, view=None)
visible(self)
warning(self, message)
width(self)
x(self)
y(self)
z(self)

nuke.XY_Knob

MethodDescription
Class(self)
animation(self, chan=0, view=None)
animations(self, view=None)
array(self)
arraySize(self)
clearAnimated(self, index=-1, view=None)
clearExpression(self, channel=-1)
clearFlag(self, f)
copyAnimation(self, channel, curve, view=None)
copyAnimations(self, curves, view=None)
debug(self, message)
defaultValue(self)
dimensions(self)
enabled(self)
error(self, message)
fromScript(self, s)
fullyQualifiedName(self, channel=-1)
getFlag(self, f)
getKeyIndex(self, time, index=0, view=None)
getKeyList(self, *a)
getKeyTime(self, key, index=0, view=None)
getNumKeys(self, index=0, view=None)
getText(self)
getValue(self, index=0, view=None, time=None)
getValueAt(self, time, index=0, view=None)
hasExpression(self, index=-1, view=None)
height(self)
isAnimated(self, index=-1, view=None)
isEnabled(self)
isKey(self, index=-1, view=None)
isKeyAt(self, time, index=-1, view=None)
label(self)
max(self)
min(self)
name(self)
names(self, n)
node(self)
notDefault(self)
removeKey(self, index=-1, view=None)
removeKeyAt(self, time, index=-1, view=None)
resize(self, w, h=1)
setAnimated(self, index=-1, view=None)
setEnabled(self, b)
setExpression(self, expression, channel=-1, view=None)
setFlag(self, f)
setKeyAt(self, time, index=-1, view=None)
setLabel(self, label)
setName(self, name)
setRange(self, lo, hi)
setTooltip(self, text)
setValue(self, value, index=-1, time=None, view=None)
setValueAt(self, value, time, index=-1, view=None)
setVisible(self, b)
singleValue(self, view=None)
toScript(self, quote=False, context=None)
tooltip(self)
value(self, index=None, view=None, time=None)
valueAt(self, time, index=None, view=None)
visible(self)
warning(self, message)
width(self)
x(self)
y(self)

nuke.callbacks

MethodDescription
addAfterBackgroundFrameRender(call, args=(), kwargs={}, nodeClass='*')
addAfterBackgroundRender(call, args=(), kwargs={}, nodeClass='*')
addAfterFrameRender(call, args=(), kwargs={}, nodeClass='*')
addAfterRender(call, args=(), kwargs={}, nodeClass='*')
addAutolabel(call, args=(), kwargs={}, nodeClass='*')
addBeforeBackgroundRender(call, args=(), kwargs={}, nodeClass='*')
addBeforeFrameRender(call, args=(), kwargs={}, nodeClass='*')
addBeforeRender(call, args=(), kwargs={}, nodeClass='*')
addFilenameFilter(call, args=(), kwargs={})
addKnobChanged(call, args=(), kwargs={}, nodeClass='*')
addOnCreate(call, args=(), kwargs={}, nodeClass='*')
addOnDestroy(call, args=(), kwargs={}, nodeClass='*')
addOnScriptClose(call, args=(), kwargs={}, nodeClass='*')
addOnScriptLoad(call, args=(), kwargs={}, nodeClass='*')
addOnScriptSave(call, args=(), kwargs={}, nodeClass='*')
addOnUserCreate(call, args=(), kwargs={}, nodeClass='*')
addRenderProgress(call, args=(), kwargs={}, nodeClass='*')
addUpdateUI(call, args=(), kwargs={}, nodeClass='*')
addValidateFilename(call, args=(), kwargs={})
filenameFilter(filename)
removeAfterBackgroundFrameRender(call, args=(), kwargs={}, nodeClass='*')
removeAfterBackgroundRender(call, args=(), kwargs={}, nodeClass='*')
removeAfterFrameRender(call, args=(), kwargs={}, nodeClass='*')
removeAfterRender(call, args=(), kwargs={}, nodeClass='*')
removeAutolabel(call, args=(), kwargs={}, nodeClass='*')
removeBeforeBackgroundRender(call, args=(), kwargs={}, nodeClass='*')
removeBeforeFrameRender(call, args=(), kwargs={}, nodeClass='*')
removeBeforeRender(call, args=(), kwargs={}, nodeClass='*')
removeFilenameFilter(call, args=(), kwargs={})
removeKnobChanged(call, args=(), kwargs={}, nodeClass='*')
removeOnCreate(call, args=(), kwargs={}, nodeClass='*')
removeOnDestroy(call, args=(), kwargs={}, nodeClass='*')
removeOnScriptClose(call, args=(), kwargs={}, nodeClass='*')
removeOnScriptLoad(call, args=(), kwargs={}, nodeClass='*')
removeOnScriptSave(call, args=(), kwargs={}, nodeClass='*')
removeOnUserCreate(call, args=(), kwargs={}, nodeClass='*')
removeRenderProgress(call, args=(), kwargs={}, nodeClass='*')
removeUpdateUI(call, args=(), kwargs={}, nodeClass='*')

Constants

ADD_VIEWS · AFTER_CONST · AFTER_LINEAR · ALL · ALWAYS_SAVE · ANGLE · BEFORE_CONST · BEFORE_LINEAR · BREAK · CATMULL_ROM · COLOURCHIP_HAS_UNSET · CONSTANT · CUBIC · DISABLED · DONT_CREATE_VIEWS · DONT_SAVE_TO_NODEPRESETS · DO_NOT_WRITE · EARLY_STORE · ENDLINE · EXE_PATH · EXPAND_TO_WIDTH · EXPRESSIONS · FONT · FORCE_RANGE · FROM_SCRIPT · GEO · GRANULAR_UNDO · GUI · HANDLES_ANYWAY · HIDDEN · HIDDEN_INPUTS · HORIZONTAL · IMAGE · INDEPENDENT · INPUTS · INVISIBLE · KNOB_CHANGED_ALWAYS · LINEAR · LINKINPUTS · LOG_SLIDER · MODIFIES_GEOMETRY · MONOCHROME · NODE_KNOB · NO_ALPHA_PULLDOWN · NO_ANIMATION · NO_COLOR_DROPDOWN · NO_HANDLES · NO_KNOB_CHANGED · NO_MULTIVIEW · NO_PROXYSCALE · NO_RERENDER · NO_UNDO · NUKE_VERSION_DATE · NUKE_VERSION_MAJOR · NUKE_VERSION_MINOR · NUKE_VERSION_PHASE · NUKE_VERSION_PHASENUMBER · NUKE_VERSION_RELEASE · NUKE_VERSION_STRING · NUKE_VERSION_TYPE · OPENCOMP · OUTPUT_ONLY · PROFILE_ENGINE · PROFILE_REQUEST · PROFILE_STORE · PROFILE_VALIDATE · READ_ONLY · REPLACE · REPLACE_VIEWS · RESIZABLE · SAVE_MENU · SLIDER · SMOOTH · STARTLINE · STORE_INTEGER · TABBEGINCLOSEDGROUP · TABBEGINGROUP · TABBEGINGROUP_KNOB · TABENDGROUP · TABKNOB · TO_SCRIPT · TO_VALUE · USER_SET_SLOPE · VIEWER · WRITE_ALL · WRITE_NON_DEFAULT_ONLY · WRITE_USER_KNOB_DEFS

On this page