nuke
Set up the ‘nuke’ module
This initializes Nuke’s internal modules and brings the symbols into this namespace
Functions
activeGroup() -> Group |
|
activeViewer() -> ViewerWindow |
|
Add code to execute after each frame of a background render. The call must be in the form of: def foo(context): pass. |
|
Add code to execute after any background renders. The call must be in the form of: def foo(context): pass. |
|
Add code to execute after each frame of a render |
|
Add code to execute after viewer recording |
|
Add code to execute after any renders |
|
Add code to execute after viewer replay |
|
addAfterUserAddGsv(function) -> bool |
|
addAfterUserAddGsvSet(function) -> bool |
|
addAfterUserRemoveGsv(function) -> bool |
|
addAfterUserRemoveGsvSet(function) -> bool |
|
addAfterUserRenameGsv(function) -> bool |
|
addAfterUserRenameGsvSet(function) -> bool |
|
addAfterUserSetGsvValue(function) -> bool |
|
addAutoSaveDeleteFilter(filter) -> None |
|
addAutoSaveFilter(filter) -> None |
|
addAutoSaveRestoreFilter(filter) -> None |
|
Add code to execute on every node to produce the text to draw on it in the DAG. |
|
Add code to execute before starting any background renders. The call must be in the form of: def foo(context): pass. |
|
Add code to execute before each frame of a render |
|
Add code to execute before viewer recording |
|
Add code to execute before starting any renders |
|
Add code to execute before viewer replay |
|
addBeforeUserAddGsv(function) -> bool |
|
addBeforeUserAddGsvSet(function) -> bool |
|
addBeforeUserRemoveGsv(function) -> bool |
|
addBeforeUserRemoveGsvSet(function) -> bool |
|
addBeforeUserRenameGsv(function) -> bool |
|
addBeforeUserRenameGsvSet(function) -> bool |
|
addBeforeUserSetGsvValue(function) -> bool |
|
Add a function to modify default colorspaces before Nuke passes them to Readers or Writers. |
|
addFavoriteDir(name, directory, type, icon, tooltip, key) -> None. |
|
Add a function to modify filenames before Nuke passes them to the operating system. |
|
addFormat(s) -> Format or None. |
|
Add code to execute when any knob value changes The knob is available in nuke.thisKnob() and the node in nuke.thisNode(). |
|
addNodePresetExcludePaths( paths ) -> None |
|
Add code to execute when a node is created or undeleted |
|
Add code to execute when a node is destroyed |
|
Add code to execute before a script is closed |
|
Add code to execute when a script is loaded |
|
Add code to execute before a script is saved |
|
Add code to execute when user creates a node |
|
Add code to execute when the progress bar updates during any renders |
|
addSequenceFileExtension( fileExtension ) |
|
addToolsetExcludePaths( paths ) -> None |
|
Add code to execute on every node when things change. |
|
Add a function to validate a filename in Write nodes. |
|
addView(s) -> None |
|
alert(prompt) -> None |
|
allNodes(filter, group, recurseGroups) -> list |
|
animation(object, *commands) -> None |
|
animationEnd() -> float. |
|
animationIncrement() -> float |
|
animationStart() -> float |
|
animations() -> tuple |
|
applyPreset(nodeName, presetName) -> None |
|
applyUserPreset(nodeName, presetName) -> None |
|
ask(prompt) -> bool |
|
askWithCancel(prompt) -> bool |
|
Internal function. |
|
Internal function. |
|
Internal function. |
|
autoplace(n) -> None. |
|
autoplaceSnap(n) -> None |
|
autoplace_all() -> None. |
|
autoplace_snap_all() -> None. |
|
autoplace_snap_selected() -> None. |
|
cacheUsage() -> int |
|
canCreateNode(name) -> True if the node can be created, or False if not. |
|
cancel() -> None |
|
center() -> array with x, then y |
|
channels(n=None) -> (string) |
|
choice(title, prompt, options, default = 0) -> index |
|
clearAssetCache() -> None |
|
clearBlinkCache() -> None |
|
clearDiskCache() -> None |
|
clearGeoSelection() -> None |
|
clearRAMCache() -> None |
|
clearTabMenuFavorites() -> None |
|
clearTabMenuWeighting() -> None |
|
clone(n, args, inpanel) -> Node |
|
cloneSelected(action) -> bool |
|
collapseToGroup(show=True) -> Group |
|
collapseToLiveGroup(show=True) -> Group |
|
collapseToVariableGroup(show=True) -> Group |
|
connectNodes() -> None |
|
connectViewer(inputNum, node) -> None |
|
createLiveInput() -> Node |
|
createNode(node, knobs, inpanel) -> Node |
|
createScenefileBrowser( fileName, nodeName ) -> None |
|
createToolset(filename=None, overwrite=-1, rootPath = None) -> None |
|
critical(message)-> None |
|
Finds all assetized File_Knobs in nodes and replaces their entity reference by their respective resolved file path. |
|
debug(message)-> None |
|
Called by libnuke. |
|
defaultFontPathname() -> str |
|
defaultNodeColor(s) -> int |
|
delete(n) -> None |
|
deletePreset(nodeClassName, presetName) -> None |
|
deleteUserPreset(nodeClassName, presetName) -> None |
|
deleteView(s) -> None |
|
List all nodes referred to by the nodes argument. 'what' is an optional integer (see below). |
|
List all nodes referred to by the nodes argument. 'what' is an optional integer (see below). |
|
display(s, node, title, width) -> None. |
|
duplicateSelectedNodes() -> None. |
|
endGroup() -> None |
|
error(message)-> None |
|
Finds all of the gsv terms within a given expression and replaces these |
|
"expand" the string by replacing tcl portions of the string with the final text. |
|
execute(nameOrNode, start, end, incr, views, continueOnError = False) -> None. |
|
executeBackgroundNuke(exe_path, nodes, frameRange, views, limits, continueOnError = False, flipbookToRun = ", flipbookOptions = {}) -> None |
|
Execute the callable 'call' with optional arguments 'args' and named arguments 'kwargs' i n Nuke's main thread and return immediately. |
|
Execute the callable 'call' with optional arguments 'args' and named arguments 'kwargs' in Nuke's main thread and wait for the result to become available. |
|
executeMultiple(nodes, ranges, views, continueOnError=False) -> None |
|
executing() -> Bool. |
|
exists(s) -> bool |
|
expandSelectedGroup() -> None |
|
expression(s) -> float |
|
expression(s) -> float |
|
extractSelected() -> None |
|
filename(node, i) -> str |
|
forceClone() -> bool |
|
forceLoad(n) -> None |
|
Forks a new instance of Nuke optionally with the contents of the named file. |
|
formats() -> list |
|
frame(f) -> Current frame. |
|
fromNode(n) -> String. |
|
getAllUserPresets() -> None |
|
getClipname(prompt, pattern=None, default=None, multiple=False) -> list of strings or string |
|
getColor(initial) -> int |
|
Get a list of all colorspaces listed in an enumeration knob. |
|
getDeletedPresets() -> None |
|
getFileNameList( dir, splitSequences = False, extraInformation = False, returnDirs=True, returnHidden=False ) -> str |
|
getFilename(message, pattern=None, default=None, favorites=None, type=None, multiple=False) -> list of strings or single string |
|
getFonts() -> list of font families and styl. |
|
getFramesAndViews(label, default=None, maxviews=0) -> (ranges, views) |
|
getGeoSelection() -> Returns the selection as a dictionary |
|
getInput(prompt, default) -> str |
|
getNodeClassName() -> None |
|
getNodePresetExcludePaths() -> string list |
|
getNodePresetID() -> None |
|
getOcioColorSpaces() -> returns the list of OCIO colorspaces. |
|
getPaneFor( panelName ) -> Dock |
|
getPresetKnobValues() -> None |
|
getPresets() -> None |
|
getPresetsMenu(Node) -> Menu or None |
|
getReadFileKnob(node) -> knob |
|
getRenderProgress() -> Returns the progress of the render of a frame from 0 - 100 % complete. |
|
getToolsetExcludePaths() -> string list |
|
getUserPresetKnobValues() -> None |
|
getUserPresets(Node) -> None |
|
hotkeys() -> str |
|
inputs(n, i) -> int |
|
invertSelection() -> None |
|
knob(name, value, getType, getClass) -> None |
|
knobDefault(classknob, value) -> str |
|
knobTooltip(classknob, value) -> None |
|
lastHitGroup() -> Group |
|
layers(node=None) -> string list. |
|
licenseInfo() -> Shows information about licenses used by nuke. |
|
link(n, args, inpanel) -> Node |
|
linkSelected(action) -> bool |
|
load(s) -> None |
|
Load a Python file and return the module object |
|
loadToolset(filename=None, overwrite=-1) -> None |
|
localiseFiles(readKnobs) |
|
localizationEnabled(knob) -> bool |
|
makeGroup(show=True) -> Group |
|
maxPerformanceInfo -> Get the max performance info for this session. |
|
menu(name) -> Menu |
|
message(prompt) -> None |
|
modified(status) -> True if modified, False otherwise. |
|
nodeAtPath(path, instanceIndex) -> Node |
|
nodeCopy(s) -> bool |
|
nodeDelete(s) -> True if any nodes were deleted, False otherwise. |
|
nodePaste(s) -> Node |
|
nodeTypes(force_plugin_load=False) -> List |
|
nodesSelected() -> None |
|
numvalue(knob, default=infinity) -> float |
|
oculaPresent() -> bool |
|
ofxAddPluginAliasExclusion(fullOfxEffectName) -> None |
|
ofxMenu() -> bool |
|
nuke.ofxPluginPath() -> String list |
|
ofxRemovePluginAliasExclusion(fullOfxEffectName) -> None |
|
nodesSelected() -> List |
|
pan() -> array with x, then y |
|
performanceProfileFilename() -> File to write performance profile to for this session. |
|
Adds all the paths to the beginning of the Nuke plugin path. |
|
Add a filepath to the end of the Nuke plugin path. |
|
pluginExists(name) -> True if found, or False if not. |
|
pluginInstallLocation() -> string list |
|
pluginPath() -> string list |
|
plugins(switches=0, *pattern)-> list of str |
|
recentFile(index) -> str |
|
redo() -> None |
|
registerFlipbook(s) -> None |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
removeAfterUserAddGsv(function) -> bool |
|
removeAfterUserAddGsvSet(function) -> bool |
|
removeAfterUserRemoveGsv(function) -> bool |
|
removeAfterUserRemoveGsvSet(function) -> bool |
|
removeAfterUserRenameGsv(function) -> bool |
|
removeAfterUserRenameGsvSet(function) -> bool |
|
removeAfterUserSetGsvValue(function) -> bool |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
removeBeforeUserAddGsv(function) -> bool |
|
removeBeforeUserAddGsvSet(function) -> bool |
|
removeBeforeUserRemoveGsv(function) -> bool |
|
removeBeforeUserRemoveGsvSet(function) -> bool |
|
removeBeforeUserRenameGsv(function) -> bool |
|
removeBeforeUserRenameGsvSet(function) -> bool |
|
removeBeforeUserSetGsvValue(function) -> bool |
|
Remove a previously-added callback with the same arguments. |
|
removeFavoriteDir(name, type) -> None. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
Remove a previously-added callback with the same arguments. |
|
execute(nameOrNode, start, end, incr, views, continueOnError = False) -> None. |
|
rescanFontFolders() -> None |
|
resetPerformanceTimers() -> None |
|
restoreWindowLayout(i) -> None. |
|
resumePathProcessing() -> None |
|
root() -> node |
|
runIn(object, cmd) -> bool |
|
sample(n, c, x, y, dx, dy) -> float. |
|
saveEventGraphTimers(filePath) -> None |
|
saveToScript(filename, fileContent) -> None |
|
saveUserPreset(node, presetName) -> None |
|
saveWindowLayout(i=-1) -> None |
|
Clears a Nuke script and resets all the root knobs to user defined knob defaults. |
|
Close the current script or group. |
|
Exit Nuke. |
|
scriptName() -> String |
|
Start a new script. |
|
Opens a new script containing the contents of the named file. |
|
Read nodes from a file. |
|
Read nodes from a string. |
|
scriptSave(filename=None) -> bool |
|
scriptSaveAndClear(filename=None, ignoreUnsavedChanges=False) -> None Calls nuke.scriptSave and nuke.scriptClear :type filename: :param filename: Save to this file name without changing the script name in the project. :type ignoreUnsavedChanges: :param ignoreUnsavedChanges: Optional. If set to True scripSave will be called, ignoring any unsaved changes :return: True when sucessful. False if the user cancels the operation. In this case nuke.scripClear will not be called. |
|
scriptSaveAs(filename=None, overwrite=-1) -> None |
|
scriptSaveToTemp(string) -> string |
|
Same as scriptReadFile(). |
|
selectAll() -> None |
|
Selects all nodes in the tree of the selected nodes. |
|
selectPattern() -> None |
|
selectSimilar(matchType) -> None |
|
selectedNode() -> Node. |
|
selectedNodes(filter, recursive) -> list |
|
setGeoSelection(GeoSelection) -> None |
|
setPreset(nodeClassName, presetName, knobValues) -> None |
|
setReadOnlyPresets(readOnly) -> None |
|
setUserPreset(nodeClassName, presetName, knobValues) -> None |
|
show(n, forceFloat) -> None |
|
showBookmarkChooser(n) -> None |
|
pluginPath() -> string list |
|
showDag(n) -> None |
|
showInfo(n) -> str |
|
showSettings() -> None |
|
splayNodes() -> None |
|
startEventGraphTimers() -> None |
|
startPerformanceTimers() -> None |
|
stopEventGraphTimers() -> None |
|
stopPerformanceTimers() -> None |
|
stripFrameRange(clipname) -> string |
|
suspendPathProcessing() -> None |
|
Close the active dock tab. |
|
Make the next tab in this dock active. |
|
tcl(s, *args) -> str. |
|
thisClass() -> None |
|
thisGroup() -> Group |
|
thisKnob() -> Knob |
|
thisNode() -> Node. |
|
thisPane() -> the active pane. |
|
thisParent() -> Node |
|
thisRoot() -> Root |
|
thisView() -> str |
|
toNode(s) -> Node |
|
toggleFullscreen() -> None |
|
toggleViewers() -> None |
|
toolbar(name, create=True)-> ToolBar |
|
tprint(value, ..., sep=' ', end='', file=sys.stdout) -> None |
|
undo() -> None |
|
unlinkSelected() -> None. |
|
usingOCIO() -> returns true if using OCIO instead of Nuke LUTs. |
|
usingPerformanceTimers() -> True if on, False if off |
|
value(knob, default) -> string. |
|
views() -> List. |
|
waitForThreadsToFinish() -> str |
|
warning(message)-> None |
|
zoom(scale, center, group) -> float |
|
zoomToFitSelected() -> None |
Classes
AColor_Knob |
|
AnimationCurve |
|
A control point for an animation curve. @var x The horizontal position of the point @var y The vertical position of the point @var lslope The derivative to the left of the point. If interpolation does not have USER_SET_SLOPE then this may not be correct until after evaluate() has been called. @var rslope The derivative to the right of the point. If interpolation does not have USER_SET_SLOPE then this may not be correct until after evaluate() has been called. @var la The left 'bicubic' value. This represents the horizontal position of the left bezier handle end, where 1.0 means 1/3 of the distance to the previous point. If both handles for a span are 1.0 then the horizontal interpolation is linear and thus the vertical interpolation a cubic function. The legal values are 0 to 3. Setting outside of this range will produce undefined results. @var ra The right 'bicubic' value, again the legal range is 0 to 3. @var interpolation Used to calculate all the slopes except for the left slope of the first key and the right slope of the last key. Legal values are: - USER_SET_SLOPE: If this bit is on, the slopes are fixed by the user and interpolation and extrapolation are ignored. - CONSTANT: The value of the curve is equal to the y of the point to the left. - LINEAR: slopes point directly at the next key. - SMOOTH: same as CATMULL_ROM but the slopes are clamped so that the convex-hull property is preserved (meaning no part of the curve extends vertically outside the range of the keys on each side of it). This is the default. - CATMULL_ROM: the slope at key n is set to the slope between the control points n-1 and n+1. This is used by lots of software. - cubic: the slope is calculated to the only cubic interpolation which makes the first and second derivatives continuous. This type of interpolation was very popular in older animation software. A different cubic interpolation is figured out for each set of adjacent points with the CUBIC type. - for the smooth, CATMULL_ROM, and CUBIC interpolations, the first and last key have slopes calculated so that the second derivative is zero at them. @var extrapolation controls how to set the left slope of the first point and the right slope of the last point. Notice that this can be set differently on the first and last points, and is also remembered on all internal points so if end points are deleted old behavior is restored). - constant: the left slope of the first point, and the right slope of the last point, are set to zero. - linear: (and all other values): The left slope of the first point is set equal to it's right slope (calculated by the interpolation). the right slope of the last point is set equal to it's left slope. if there is only one point both slopes are set to zero. @var selected True if the point is selected in the curve editor. |
|
A knob which holds an array of values. |
|
A knob which descibes a 3D affine transformation, by combining rotations around each principal axis, scaling, translation, skew and a pivot point. |
|
A knob which holds a bounding box. |
|
Begin a group of tabs. |
|
Bitmask_Knob |
|
BlinkEditorKnob |
|
A knob which holds a boolean value. |
|
A 2-dimensional rectangle. |
|
A 3-dimensional box. |
|
Stores a single value between 0 and some maximum, and manages a set of keywords visible to the user. |
|
ChannelMask_Knob |
|
A knob which lets you select a layer and enable or disable individual channels. |
|
A knob which holds a single unsigned int that describes a user interface colour. |
|
A knob which holds a color. |
|
A knob which holds a boolean value representing the disabled state of a node. |
|
A knob which holds one or more double-precision floating point values. |
|
Stores a single value between 0 and some maximum, and manages a set of Radio Buttons visible to the user. |
|
End a group of tabs. |
|
Stores a single value between 0 and some maximum, and manages a set of keywords visible to the user. |
|
A string-valued knob which evaluates its value as a TCL expression. |
|
Eyedropper_Knob |
|
A knob which holds a filename. |
|
A knob for choosing a font. |
|
A Format. |
|
Format_Knob |
|
A frame range, with an upper and lower bound and an increment. |
|
A sequence of FrameRange objects with convenience functions for iterating over all frames in all ranges. |
|
A knob which holds a font family and style name. |
|
A knob which allows selection of parts of a 3D object. |
|
__init__(self: _nuke.GeoSelection) -> None |
|
Dictionary-style object holding global Nuke state. |
|
A knob which holds the Graph Variables created within the scope of this group. |
|
A hash value for any number of objects. |
|
Help_Knob |
|
Histogram_Knob |
|
IArray_Knob |
|
An info object stores x, y, w and h values. |
|
A knob which holds one or more integer values. |
|
Keyer_Knob |
|
A modifiable control that appears (unless hidden) in the panel for a node. |
|
Constants for use in parameters which require a knob type. |
|
A layer is a set of channels. |
|
Link_Knob |
|
A linkable knob description. |
|
Provide a set of user-editable lookup curves. |
|
Lut |
|
Menu |
|
MenuBar |
|
MenuItem |
|
MultiView_Knob |
|
A knob which evaluates it's string value as a TCL expression. |
|
NodeConstructor |
|
Nodes |
|
For internal use only. |
|
OneView_Knob |
|
Describes a context in which expressions can be evaluated. |
|
Panel |
|
PanelNode |
|
ParticleChannels_Knob |
|
A knob which holds a password string value. |
|
Stores a Prim path expression. |
|
Stores a Prim path. |
|
Progress Task. |
|
Pulldown_Knob |
|
PyCustom_Knob |
|
PyScript_Knob(name, label=None, command=None) A button that executes a Python script. |
|
PythonCustomKnob |
|
A string-valued knob which evaluates its value as a Python expression. |
|
Stores a single value between 0 and some maximum, and manages a set of Radio Buttons visible to the user. |
|
A knob which the minimum and maximum for a range of values. |
|
RunInMainThread |
|
Scale_Knob |
|
Displays a list of items as a hierarchy. |
|
Displays a list of items as a hierarchy. |
|
A button which executes a TCL script. |
|
A knob which holds a string value. |
|
Groups subsequent knobs onto a tab. |
|
A knob which holds a string value. |
|
ToolBar |
|
Transform2d_Knob |
|
A knob which allows selection of a USD prim from a USD file. |
|
A knob which describes a texture coordinate. |
|
Manages Nuke's undo/redo system. |
|
A knob which holds one or more unsigned integer values. |
|
A knob that stores 2 numbers with custom labels. |
|
A knob that stores 3 numbers with custom labels. |
|
A knob that stores 4 numbers with custom labels. |
|
A named view. |
|
ViewView_Knob |
|
ViewerProcess |
|
ViewerWindow |
|
A knob which holds width and height values. |
|
A knob which holds a 3D coordinate. |
|
A knob which describes a 2D position. |
Exceptions
an excpetion that should be thrown when looking up the colorspace |