Package nuke

Return an object representing the active Viewer panel. This is not the same as the Viewer node, this is the viewer UI element.

Returns: ViewerWindow

Object representing the active ViewerWindow

Add code to execute after each frame of a background render.
The call must be in the form of:
def foo(context):
  pass

The context object that will be passed in is a dictionary containing the following elements:
id => The identifier for the task that's making progress
frame => the current frame number being rendered
numFrames => the total number of frames that is being rendered
frameProgress => the number of frames rendered so far.

Please be aware that the current Nuke context will not make sense in the callback (e.g. nuke.thisNode will return a random node).

Add code to execute after any background renders.
The call must be in the form of:
def foo(context):
  pass

The context object that will be passed in is a dictionary containing the following elements:
id => The identifier for the task that's ended

Please be aware that the current Nuke context will not make sense in the callback (e.g. nuke.thisNode will return a random node).

Add a function to modify the autosave filename before Nuke attempts delete the autosave file.

Look at rollingAutoSave.py in the nukescripts directory for an example of using the auto save filters.

Parameters:

• filter - A filter function. The first argument to the filter is the current autosave filename. This function should return the filename to delete or return None if no file should be deleted.

Returns: None

Add a function to modify the autosave filename before Nuke saves the current script on an autosave timeout.

Look at rollingAutoSave.py in the nukescripts directory for an example of using the auto save filters.

Parameters:

• filter - A filter function. The first argument to the filter is the current autosave filename. The filter should return the filename to save the autosave to.

Returns: None

Add a function to modify the autosave restore file before Nuke attempts to restores the autosave file.

Look at rollingAutoSave.py in the nukescripts directory for an example of using the auto save filters.

Parameters:

• filter - A filter function. The first argument to the filter is the current autosave filename. This function should return the filename to load autosave from or it should return None if the autosave file should be ignored.

Returns: None

Add code to execute on every node to produce the text to draw on it in the DAG. Any value other than None is converted to a string and used as the text. None indicates that previously-added functions should be tried

Add code to execute before starting any background renders.
The call must be in the form of:
def foo(context):
  pass

The context object that will be passed in is a dictionary containing the following elements:
id => The identifier for the task that's about to begin

Please be aware that the current Nuke context will not make sense in the callback (e.g. nuke.thisNode will return a random node).

Add a function to modify default colorspaces before Nuke passes them to Readers or Writers.

Functions should have the same positional argument as in the definition of defaultLUTMapper()

All added functions are called in backwards order.

Add a path to the file choosers favorite directory list. The path name can contain environment variables which will be expanded when the user clicks the favourites button

Parameters:

• name - Favourite path entry ('Home', 'Desktop', etc.).
• directory - FileChooser will change to this directory path.
• type - Optional bitwise OR combination of nuke.IMAGE, nuke.SCRIPT, nuke.FONT or nuke.GEO.
• icon - Optional filename of an image to use as an icon.
• tooltip - Optional short text to explain the path and the meaning of the name.
• key - Optional shortcut key.

Returns: None

None.

Add a function to modify filenames before Nuke passes them to the operating system. The first argument to the function is the filename, and it should return the new filename. None is the same as returning the string unchanged. All added functions are called in backwards order.

Create a new image format, which will show up on the pull-down menus for image formats. You must give a width and height and name. The xyrt rectangle describes the image area, if it is smaller than the width and height (for Academy aperture, for example). The pixel aspect is the ratio of the width of a pixel to the height.

Parameters:

• s - String in TCL format "w h ?x y r t? ?pa? name".

Returns: Format or None

Format or None.

Add code to execute when the user changes a knob The knob is availble in nuke.thisKnob() and the node in nuke.thisNode(). This is also called with dummy knobs when the control panel is opened or when the inputs to the node changes. The purpose is to update other knobs in the control panel. Use addUpdateUI() for changes that should happen even when the panel is closed.

@param paths Sequence of paths to exclude Adds a list of paths that will be excluded from Node preset search paths.

Returns: None

None.

Adds the input file extension to the list of extensions that will get displayed as sequences in the file browser.

Parameters:

• fileExtension, the, new, file, extension., Valid, examples, are - 'exr', '.jpg'; invalid examples are: 'somefile.ext'

@param paths Sequence of paths to exclude Adds a list of paths that will be excluded from Toolset search paths.

Returns: None

None.

Add code to execute on every node when things change. This is done during idle, you cannot rely on it being done before it starts updating the viewer

Add a function to validate a filename in Write nodes. The first argument is the filename and it should return a Boolean as to whether the filename is valid or not. If a callback is provided, it will control whether the Render button of Write nodes and the Execute button of WriteGeo nodes is enabled or not.

Deprecated. Use the Root node.

Adds a new view to the list of views.

Parameters:

• s - View name.

Returns: None

None

Show a warning dialog box. Pops up a warning box and waits for the user to hit the OK button.

Parameters:

• prompt - Present user with this message.

Returns: None

None

List of all nodes in a group. If you need to get all the nodes in the script from a context which has no child nodes, for instance a control panel, use nuke.root().nodes().

Parameters:

• filter - Optional. Only return nodes of the specified class.
• group - Optional. If the group is omitted the current group (ie the group the user picked a menu item from the toolbar of) is used.
• recurseGroups - Optional. If True, will also return all child nodes within any group nodes. This is done recursively and defaults to False.

Returns: List

List

Does operations on an animation curve.

The following commands are supported:

• clear deletes all the keys from the animation.
• erase index last_index removes all keyframes between index and last_index
• expression newvalue returns or sets the expression for the animation. The default is 'curve' or 'y' which returns the interpolation of the keys.
• generate start end increment field expression field expression ... generates an animation with start, end, and increment. Multiple field/expression pairs generate a keyframe. Possible field commands are:
  • x sets the frame number for the next keyframe
  • y sets the keyframe value
  • dy sets the left slope
  • ldy sets left and right slope to the same value
  • la and ra are the length of the slope handle in x direction. A value of 1 generates a handle that is one third of the distance to the next keyframe.
• index x returns the index of the last key with x <= t, return -1 for none.
• is_key return non-zero if there is a key with x == t. The actual return value is the index+1.
• move field expression field expression replaces all selected keys in an animation with new ones as explained above in generate
• name returns a user-friendly name for this animation. This will eliminate any common prefix between this animation and all other selected ones, and also replaces mangled names returned by animations with nice ones.
• size returns the number of keys in the animation.
• test errors if no points in the animation are selected
• y index newvalue gets or sets the value of an animation.
• x index newvalue gets or sets the horizontal postion of a key. If the animation contains an expression or keyframes, the new value will be overridden.

See also: animations

Parameters:

• object - The animation curve.
• commands - a varargs-style list of commands, where each command is one of those defined above.

Returns: None

None

Returns the last frame (or x value) for the currently selected animations.

Returns: float

The end frame.

Returns a recommended interval between samples of the currently selected animation.

Returns: float

The recommended interval.

Returns the starting frame (or x value) for the currently selected animations.

Returns: float

The start frame.

Returns a list of animatable things the user wants to work on.

If this is a command being executed from a menu item in a curve editor, a list of the names of all selected curves is returned. If this list is empty a "No curves selected" error is produced.

If this is a command being executed from the pop-up list in a knob then a list of all the fields in the knob is returned.

If this is a command being executed from the right-mouse-button pop-up list in a field of a knob, the name of that field is returned.

Otherwise this produces an error indicating that the command requries a knob context. You can get such a context by doing "in <knob> {command}"

Also see the 'selected' argument to the animation command.

See also: animation, animationStart, animationEnd, animationIncrement

Returns: tuple

A tuple of animatable things.

Applies a given preset to the current node.

Parameters:

• nodeName - Name of the node to apply the preset to.
• presetName - Name of the preset to use.
• node - (optional) a Node object to apply the preset to. If this is provided, the nodeName parameter is ignored.

Returns: None

bool.

Applies a given user preset to the current node.

Parameters:

• nodeName - Name of the node to apply the preset to.
• presetName - Name of the preset to use.
• node - (optional) a Node object to apply the preset to. If this is provided, the nodeName parameter is ignored.

Returns: None

bool.

Show a Yes/No dialog.

Parameters:

• prompt - Present the user with this message.

Returns: bool

True if Yes, False otherwise.

Show a Yes/No/Cancel dialog.

Parameters:

• prompt - Present the user with this question.

Returns: bool

True if Yes, False if No, an exception is thrown if Cancel.

Internal function. Use addAutoSaveDeleteFilter to add a callback

Internal function. Use addAutoSaveFilter to add a callback

Internal function. Use addAutoSaveRestoreFilter to add a callback

Deprecated. Use Node.autoplace.

Automatically place nodes, so they do not overlap.

Parameters:

• n - Node.

Returns: None

None

Move node to the closest grid position.

Parameters:

• n - Node.

Returns: None

None

Performs autoplace of all nodes in current context group.

Returns: None

None. May return exception it top context group has subgraph locked.

Performs autoplace snap of all nodes in current context group.

Returns: None

None. May return exception it top context group has subgraph locked.

Performs autoplace snap of all selected nodes in current context group.

Returns: None

None. May return exception it top context group has subgraph locked.

Get the total amount of memory currently used by the cache.

Returns: int

Current memory usage in bytes.

This function can be used to determine whether it is possible to create a node with the specified node class.

Parameters:

• name - Node name.

Returns: True if the node can be created, or False if not

True if the node can be created, or False if not.

Cancel an in-progress operation. This has the same effect as hitting cancel on the progress panel.

Returns: None

None

Return the center values of a group's display, these values are suitable to be passed to nuke.zoom as the DAG center point. Like so: center = nuke.center() zoom = nuke.zoom() print center[0] print center[1] ## move DAG back to center point without changing zoom. nuke.zoom( zoom, center )

Returns: array with x, then y

Array of x, y.

Deprecated. Use Node.channels.

List channels. The n argument is a Nuke node and if given only the channels output by this node are listed. If not given or None, all channels known about are listed.

Parameters:

• n - Optional node parameter.

Returns: (string)

A list of channel names.

Shows a dialog box with the given title and prompt text, and a combo box containing the given options.

Parameters:

• title - Text to put in the dialog's title bar.
• prompt - Text to display at the top of the dialog.
• options - A list of strings for the user to choose from.
• default - The index (starting from zero) of the option to select first.

Returns: index

An integer index (starting from zero) of the choice the user selected, or None if the dialog was cancelled.

Create a clone node that behaves identical to the original. The node argument is the node to be cloned, args and inpanel are optional arguments similar to createNode. A cloned node shares the exact same properties with its original. Clones share the same set of knobs and the same control panel. However they can have different positions and connections in the render tree. Any clone, including the original, can be deleted at any time without harming any of its clones.

Parameters:

• n - Node.
• args - Optional number of inputs requested.
• inpanel - Optional boolean.

Returns: Node

Node

This makes a clone of all selected nodes, preserving connections between them, and makes only the clones be selected.

Parameters:

• action - Optional and if 'copy' it cuts the resulting clones to the clipboard.

Returns: bool

True if succeeded, False otherwise.

Moves the currently selected nodes to a new group, maintaining their previous connections.

Parameters:

• show - If show is True, the node graph for the new group is shown in the background.

Returns: Group

The new Group node.

Moves the currently selected nodes to a new group, maintaining their previous connections.

Parameters:

• show - If show is True, the node graph for the new group is shown in the background.

Returns: Group

The new Group node.

Deprecated. Use Group.connectSelectedNodes.

Returns: None

None

Connect a viewer input to a node. The argument i is the input number and n is either a Nuke node or None. Some viewer in the current group is found, if there are no viewers one is created. The viewer is then altered to have at least n+1 inputs and then input n is connected to the given node.This function is used by the numeric shortcuts in the DAG view menu.

Parameters:

• inputNum - Input number.
• node - The Node to connect to the input.

Returns: None

None

Creates a new LiveInput and populates the "file" and "liveGroup" knobs according to the filename and LiveGroup name of the parent group

Returns: Node

The new LiveInput_Node.

Creates a node of the specified type and adds it to the DAG.

Parameters:

• node - Node class (e.g. Blur).
• args - Optional string containing a TCL list of name value pairs (like "size 50 quality 19")
• inpanel - Optional boolean to open the control bin (default is True; only applies when the GUI is running).

Returns: Node

Node.

Pops up a scene browser dialog box. Receives the path to an Alembic (abc) file, and displays a hierarchical tree of the nodes within the file. The user can select which nodes they are interseted in, and nodes of the appropriate type will automatically. be created. If a valid scene file nodeName is specified, this node will be populated with the selected tree.

Parameters:

• fileName - Path and filename for an alembic file.
• nodeName - name of a valid scene file node to populate. If the node is invalid, new nodes will be automatically created

Returns: None

Creates a tool preset based on the currently selected nodes. 

@param filename: Saves the preset as a script with the given file name.
 @param overwrite: If 1 (true) always overwrite; if 0 (false) never overwrite; @param rootPath: If specified, use this as the root path to save the Toolset to. If not specified, save to the user's .nuke/Toolsets folder.  otherwise, in GUI mode ask the user, in terminal do same as False. Default  is -1, meaning 'ask the user'.

Returns: None

Puts the message into the error console, treating it like an error. Also pops up an alert dialog to the user, immediately.

Parameters:

• message - String parameter.

Returns: None

None.

Puts the message into the error console, treating it like a debug message, which only shows up when the verbosity level is high enough.

Parameters:

• message - String parameter.

Returns: None

None.

Called by libnuke.
Calls into Node-level callbacks first, then global callbacks

Arguments:
    colorspace   - the name string of the initial colorspace
    dataTypeHint - sometimes Readers/Writer request the default for a
                   particular data-type, i.e. int8, in16, float, etc.
Return:
    The return should be the transformed/modified colorspace name.
    None is the same as returning the string unchanged.

Get the path to Nukes default font.

Returns: str

Path to the font.