Package nuke

Nuke internal. Not for public use.

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 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

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:

• presetName - Name of the preset to use.

Returns: None

bool.

Applies a given user preset to the current node.

Parameters:

• presetName - Name of the preset to use.

Returns: None

bool.

Show a Yes/No dialog.

Parameters:

• prompt - Present the user with this message.

Returns: bool

True if Yes, False otherwise.

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

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

Returns: int

Current memory usage in bytes.

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.

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 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.

Get the path to Nukes default font.

Returns: str

Path to the font.

Get the default node colour.

Parameters:

• s - Node class.

Returns: int

The color as a packed integer (0xRRGGBB00).

The named node is deleted. It can be recovered with an undo.

Parameters:

• n - Node.

Returns: None

None

Deletes a pre-created node preset

Parameters:

• nodeClassName - Name of the node class to create a preset for.
• presetName - Name of the preset to create.

Returns: None

bool.

Deletes a pre-created user node preset

Parameters:

• nodeClassName - Name of the node class to create a preset for.
• presetName - Name of the preset to create.

Returns: None

bool.

Deprecated. Use the Root node.

Deletes a view from the list of views.

Parameters:

• s - View name.

Returns: None

None

List all nodes referred to by the nodes argument. 'what' is an optional integer (see below).
  You can use the following constants or'ed together to select the types of dependencies that are looked for:
         nuke.EXPRESSIONS = expressions
         nuke.INPUTS = visible input pipes
         nuke.HIDDEN_INPUTS = hidden input pipes.
  The default is to look for all types of connections.
  
Example:
  n1 = nuke.nodes.Blur()
  n2 = nuke.nodes.Merge()
  n2.setInput(0, n1)
  deps = nuke.dependencies([n2], nuke.INPUTS | nuke.HIDDEN_INPUTS | nuke.EXPRESSIONS)

List all nodes referred to by the nodes argument. 'what' is an optional integer (see below).
  You can use the following constants or'ed together to select what types of dependent nodes are looked for:
         nuke.EXPRESSIONS = expressions
         nuke.INPUTS = visible input pipes
         nuke.HIDDEN_INPUTS = hidden input pipes.
  The default is to look for all types of connections.
  
  evaluateAll is an optional boolean defaulting to True. When this parameter is true, it forces a re-evaluation of the entire tree.
  This can be expensive, but otherwise could give incorrect results if nodes are expression-linked.
  
  
Example:
  n1 = nuke.nodes.Blur()
  n2 = nuke.nodes.Merge()
  n2.setInput(0, n1)
  ndeps = nuke.dependentNodes(nuke.INPUTS | nuke.HIDDEN_INPUTS | nuke.EXPRESSIONS, [n1])
  
  @param what: Or'ed constant of nuke.EXPRESSIONS, nuke.INPUTS and nuke.HIDDEN_INPUTS to select the types of dependent nodes. The default is to look for all types of connections.
  @param evaluateAll: Specifies whether a full tree evaluation will take place. Defaults to True.
  @return: List of nodes. 

Creates a window showing the result of a python script. The script is executed in the context of the given node, so this and a knob name in expressions refer to that node.

The window will have an 'update' button to run the script again.

Parameters:

• s - Python script.
• node - Node.
• title - Optional title of window.
• width - Optional width of window.

Returns: None

None.

Deprecated. Use Group.run, Group.begin/Group.end pairs or (preferably) the with statement.

Changes the current group to the parent of the current group. Does nothing if the current group is a Root (the main window of a script).

Returns: None

None.

Puts the message into the error console, treating it like an error.

Parameters:

• message - String parameter.

Returns: None

None.

execute(nameOrNode, frameRangeSet, views, continueOnError = False) -> None.

Execute the named Write node over the specified frames.

There are two variants of this function. The first allows you to specify the frames to write range by giving the start frame number, the end frame number and the frame increment. The second allows you to specify more complicated sets of frames by providing a sequence of FrameRange objects.

If Nuke is run with the GUI up, this will pop up a progress meter. If the user hits the cancel button this command will return 'cancelled' error. If Nuke is run from the nuke command line (ie nuke was started with the -t switch) execute() prints a text percentage as it progresses. If the user types ^C it will aborting the execute() and return a 'cancelled' error.

Parameters:

• nameOrNode - A node name or a node object.
• start - Optional start frame. Default is root.first_frame.
• end - Optional end frame. Default is root.last_frame.
• incr - Optional increment. Default is 1.
• views - Optional list of views. Default is None, meaning "all views".

Returns: None

None

Run an instance of Nuke as a monitored sub process. Returns an integer that's used as unique id for the started task. If it failed to launch this will be -1.

Parameters:

• exe_path - Path to Nuke or a script that can take Nuke arguments. You probably want to supply nuke.EXE_PATH.
• nodes - A list of nodes to execute.
• frameRanges - List of frame ranges to execute.
• views - A list of view names to execute.
• limits - A dictionary with system limits, currently uses keys maxThreads and maxCache.
• flipbookToRun - The name of the flipbook application to run after the render, or an empty string if not desired.
• flipbookOptions - A dictionary with options to pass to the flipbook. These should include roi and pixelAspect.

Returns: None

Int.

Execute the current script for a specified frame range. The argument nodes is a sequence of Nuke nodes and ranges is a sequence of range lists. A Nuke range list is a sequence of 3 integers - first, last and incr ( e.g. nuke.execute((w,), ((1,100,1),)) ). The named nodes must all be Write or other executable operators. If no nodes are given then all executable nodes in the current group are executed. Note that DiskCache and Precomp nodes do not get executed with this call, unless explicitly specified.

If Nuke is run with the GUI up, this will pop up a progress meter. If the user hits the cancel button this command will raise a 'cancelled' error. If Nuke is run in terminal mode (with the -t switch) this prints a text percentage as it progresses.

If the user types ^C it will abort the execute() and raise a 'cancelled' error.

Parameters:

• nodes - Node list.
• ranges - Optional start frame. Default is root.first_frame.
• views - Optional list of views. Default is None. Execute for all.

Returns: None

None

Check for the existence of a named item. Function for backwards-compatibility with TCL.

Parameters:

• s - Name of item.

Returns: bool

True if exists, False otherwise.

Moves all nodes from the currently selected group node into its parent group, maintaining node input and output connections, and deletes the group. Returns the nodes that were moved, which will also be selected.

Returns: None

None

Parse a Nuke expression. Runs the same expression parser as is used by animations. This is not the same as the tcl expr parser. The main differences are:

• Only floating point numbers are calculated. There are no strings, boolean, or integer values.
• You can name any knob that returns a floating point value, with a dot-separated name, see knob for details on these names. You may follow the knob name with a time in parenthesis (like a function call) and if it is animated it will be evaluated at that time. If it is animated and no time is given, 'frame' is used.
• The words 'frame', 't', and 'x' evaluate to the frame number of the context node, or the frame number this animation is being evaluated at.
• The word 'y' in an animation expression evaluates to the value the animation would have if the control points were used and there was no expression. Outside an animation expression y returns zero.

Parameters:

• s - The expression, as a string.

Returns: float

The result.

Parse a Nuke expression. Runs the same expression parser as is used by animations. This is not the same as the tcl expr parser. The main differences are:

• Only floating point numbers are calculated. There are no strings, boolean, or integer values.
• You can name any knob that returns a floating point value, with a dot-separated name, see knob for details on these names. You may follow the knob name with a time in parenthesis (like a function call) and if it is animated it will be evaluated at that time. If it is animated and no time is given, 'frame' is used.
• The words 'frame', 't', and 'x' evaluate to the frame number of the context node, or the frame number this animation is being evaluated at.
• The word 'y' in an animation expression evaluates to the value the animation would have if the control points were used and there was no expression. Outside an animation expression y returns zero.

Parameters:

• s - The expression, as a string.

Returns: float

The result.

Disconnects the selected nodes in the group from the tree, and shifts them to the side.

Returns: None

None

Return the filename(s) this node or group is working with.

For a Read or Write operator (or anything else with a filename knob) this will return the current filename, based on the root.proxy settings and which of the fullsize/proxy filenames are filled in. All expansion of commands and variables is done. However by default it will still have %%04d sequences in it, use REPLACE to get the actual filename with the current frame number.

If the node is a group, a search is done for executable (i.e. Write) operators and the value from each of them is returned. This will duplicate the result of calling execute() on the group.

Parameters:

• node - Optional node.
• i - Optional nuke.REPLACE. Will replace %%04d style sequences with the current frame number.

Returns: str

Filename, or None if no filenames are found.

Returns: bool

True if succeeded, False otherwise.

Force the plugin to be fully instantiated.

Parameters:

• n - Optional node argument. Default is the current node.

Returns: None

None

Returns: list

List of all available formats.

Return or set the current frame number. Deprecated. Use Root.frame.

Returns the current frame. Normally this is the frame number set in the root node, typically by the user moving the frame slider in a viewer. If a number is given, it sets the current frame number to that number. If the current context is the root this changes the root frame.

Parameters:

• f - Optional frame number.

Returns: Current frame

Current frame.

Return the Node n as a string. This function is most useful when combining Python and TCL scripts for backwards compatibility reasons.

Parameters:

• n - A Node.

Returns: String

String.

gets a list of all current user presets

Returns: None

a list of tuples containing all nodename/presetname pairs.

Pops up a file chooser dialog box. You can use the pattern to restrict the displayed choices to matching filenames, normal Unix glob rules are used here. getClipname compresses lists of filenames that only differ by an index number into a single entry called a 'clip'.

Parameters:

• prompt - Present the user with this message.
• pattern - Optional file selection pattern.
• default - Optional default filename and path.
• multiple - Optional boolean convertible object to allow for multiple selection.

Returns: list of strings or string

If multiple is True, the user input is returned as a list of strings, otherwise as a single string. If the dialog is cancelled, the return value is None.

Show a color chooser dialog and return the selected color as an int.

The format of the color values is packed 8bit rgb multiplied by 256 (ie in hex: 0xRRGGBB00).

Parameters:

• initial - Optional initial color. Integer with components packed as above.

Returns: int

The selected color.

gets a list of all currently deleted presets

Returns: None

a pyDict containing all nodename/presetname pairs.

@param dir the directory to get sequences from @param splitSequences whether to split sequences or not @param extraInformation whether or not there should be extra sequence information on the sequence name @param returnDirs whether to return a list of directories as well as sequences @param returnHidden whether to return hidden files and directories. Retrieves the filename list .

Returns: str

Array of files.

Pops up a file chooser dialog box. You can use the pattern to restrict the displayed choices to matching filenames, normal Unix glob rules are used here.

Parameters:

• message - Present the user with this message.
• pattern - Optional file selection pattern.
• default - Optional default filename and path.
• favorites - Optional. Restrict favorites to this set. Must be one of 'image', 'script', or 'font'.
• type - Optional the type of browser, to define task-specific behaviors; currently only 'save' is recognised.
• multiple - Optional boolean convertible object to allow for multiple selection. If this is True, the return value will be a list of strings; if not, it will be a single string. The default is

Returns: list of strings or single string

If multiple is True, the user input is returned as a list of strings, otherwise as a single string. If the dialog was cancelled, the return value will be None.

Pops up a dialog with fields for a frame range and view selection.

Parameters:

• label - User message.
• default - Optional value for the input field.
• maxviews - Optional max number of views.

Returns: (ranges, views)

List of ranges and views.

Pops up a dialog box with a text field for an arbitrary string.

Parameters:

• prompt - Present the user with this message.
• default - Default value for the input text field.

Returns: str

String from text field or None if dialog is cancelled.

gets the class name for the currently selected node

Returns: None

a string containing the name.

Gets a list of all paths that are excluded from the search for node presets.

Returns: string list

List of paths.

gets the node preset identifier for the currently selected node

Returns: None

a string containing the ID.

Returns the first pane that contains the named panel or None if it can't be found. Note that the panelName must be exact as described in the layout.xml file or the panel ID. For example, 'Properties.1' or 'Viewer.1 or 'co.uk.thefoundry.WebBrowser'

Returns: Dock

The pane or None.

gets a list of knob values for a given preset

Parameters:

• nodeClassName - Name of the node class to get values for.
• presetName - Name of the preset to get values for.

Returns: None

a pyDict containing all knob name/value pairs.

gets a list of all presets for the currently selected node's class

Returns: None

a pyList containing all nodename/presetname pairs.

Gets the presets menu for the currently selected node.

Returns: Menu or None

The menu, or None if it doesn't exist.

rief Gets the read knob for a node (if it exists).

Parameters:

• node - The node to get the knob for.

Returns: knob

A PyObject containing the read knob if it exists, NULL otherwise

Gets a list of all paths that are excluded from the search for node presets.

Returns: string list

List of paths.

gets a list of knob values for a given preset

Parameters:

• nodeClassName - Name of the node class to get values for.
• presetName - Name of the preset to get values for.

Returns: None

a pyDict containing all knob name/value pairs.

gets a list of all user presets for the currently selected node's class

Returns: None

a pyList containing all nodename/presetname pairs.

Returns the Nuke key assignments as a string formatted for use in nuke.display().

Returns: str

A formatted string.

Deprecated. Use Node.inputs.

Get how many inputs the node has. Normally this is a constant but some nodes have a variable number, the user can keep connecting them and the count will increase. Attempting to set the number will just disconnect all inputs greater or equal to number. For a variable input node this may decrease inputs to the new value. For most nodes this will have no effect on the value of inputs.

Parameters:

• n - Node.
• i - Optional number of inputs requested.

Returns: int

Number of inputs.

Selects all unselected nodes, and deselects all selected ones.

Returns: None

None.

rief Returns or sets the entire state of a knob.

Each individual control on a control panel is called a 'knob'. A knob's name is a dot-separated list. An example of a fully-expanded name of a knob is 'root.Group1.Blur1.size.w'. 'root' is the node name of the outermost group, 'Group1' is a group inside that containing the blur operator, 'Blur1' is the name of a blur operator, 'size' is the name of the actual knob, and 'w' is the name of the 'field' (there are two fields in a blur size, 'w' and 'h').

You can omit a lot of this because all knob names are figured out relative to a 'current knob' and 'current node'. These are set depending on the context of where the scripting is invoked. For menu items the current node is the group that contained the menu, and there is no current knob. For expressions typed into knob fields the current knob is that knob and the current node is the node the knob belongs to.

If a name does not start with 'root' then a search upwards is done for the first word in the name, first against the fields in the current knob, then against the knobs in the current node, then against the nodes in the group containing the current node (or in it if it is a group), on up to the root.

The word 'this' means the current knob or the current node.

The word 'input' means the first (0 or B) input of a node. Ie 'Blur1.input' returns the node connected to the input of Blur1, while 'Blur1.input.input' returns the input of that node.

If you are getting the value for reporting to the user, you probably want to use the value or expression commands.

If the getType argument is specified and is True, it will print out the type of the knob rather than getting or setting the value. The type is an integer, using the same list as addUserKnob.

If the getClass argument is specified and is True, it will print out the type of the knob as a string, e.g. 'Int_Knob', 'Enumeration_Knob', 'XY_Knob'.

If both the getType and getClass arguments are present and are True, getType takes precedence.

Parameters:

• name - The name of the knob.
• value - Optional argument. If this is present, the value will be stored into the knob.
• getType - Optional boolean argument. If True, return the class ID for the knob instead of the knob itself. The class ID is an int.
• getClass - Optional boolean argument. If True, return the class name for the knob instead of the knob itself. The class name is a string.

Returns: None

Set a default value for knobs in nodes that belong to the same class. All knobs with matching names, that are created after this command was issued, will default to the new value. If class. is missing or is "*." then this default applies to all nodes with such a knob. If several values are supplied, the first value which is valid will be used as the default. knobDefault can be used to specify file format specific knobs. These are knobs that are added to Read, Write and other file format dependent nodes when the file name changes. To specify defaults, use the class name, followed by the file format extension, followed by the knob name, all separated by periods. An example is shown below.

Example: nuke.knobDefault("Blur.size", "20")

Example: nuke.knobDefault("Read.exr.compression", "2")

Parameters:

• classknob - String in the form "class.knob" where "class" is the class of Node, i.e. Blur, and "knob" is the name of the knob. This can also include a file extension, as in "class.extension.knob"
• value - Optional string to convert to the default value.

Returns: str

None or String with the default value.

Set an override for a tooltip on a knob.

Example:

   nuke.knobTooltip('Blur.size', '[some text]')

@param classknob: String in the form "class.knob" where "class" is the class of Node, i.e. Blur, and "knob" is the name of the knob.
@param value: String to use as the tooltip
@return: None

Returns: None

Lists the layers in a node. If no node is provided this will list all known layer names in this script.

Parameters:

• node - Optional node parameter.

Returns: string list

A list of layer names.