Class Node

Returns: Class of node

Class of node.

Returns: a new object with type S, a subtype of T

Overrides: object.__new__

helper for pickle

Overrides: object.__reduce_ex__

(inherited documentation)

repr(x)

Overrides: object.__repr__

str(x)

Overrides: object.__str__

Add knob k to this node or panel.

Parameters:

• k - Knob.

Returns: None

None.

Get a list of all knobs in this node, including nameless knobs.

For example:

>>> b = nuke.nodes.Blur()
>>> b.allKnobs()

Returns: list

List of all knobs.

Note that this doesn't follow the links for Link_Knobs

Automatically place nodes, so they do not overlap.

Returns: None

None.

Bounding box of the node.

Returns: List of x, y, w, h

List of x, y, w, h.

Check whether the output of 'node' can be connected to input i.

Parameters:

• i - Input number.
• node - The node to be connected to input i.

Returns: bool

True if node can be connected, False otherwise.

List channels output by this node.

Returns: String list

String list.

Returns: Number of clones

Number of clones.

Connect the output of 'node' to the i'th input or the next available unconnected input. The requested input is tried first, but if it is already set then subsequent inputs are tried until an unconnected one is found, as when you drop a connection arrow onto a node in the GUI.

Parameters:

• i - Input number to try first.
• node - The node to connect to input i.

Returns: bool

True if a connection is made, False otherwise.

Return pixel values from a deep image. This requires the image to be calculated, so performance may be very bad if this is placed into an expression in a control panel.

Parameters:

• c - Channel name.
• x - Position to sample (X coordinate).
• y - Position to sample (Y coordinate).
• n - Sample index (between 0 and the number returned by deepSampleCount() for this pixel, or -1 for the frontmost).

Returns: Floating point value

Floating point value.

Return number of samples for a pixel on a deep image. This requires the image to be calculated, so performance may be very bad if this is placed into an expression in a control panel.

Parameters:

• x - Position to sample (X coordinate).
• y - Position to sample (Y coordinate).

Returns: Integer value

Integer value.

List all nodes referred to by this node. 'what' is an optional integer (see below).
You can use the following constants or'ed together to select what types of dependencies 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:
nuke.toNode('Blur1').dependencies( nuke.INPUTS | nuke.EXPRESSIONS )
@param what: Or'ed constant of nuke.EXPRESSIONS, nuke.INPUTS and nuke.HIDDEN_INPUTS to select the types of dependencies. The default is to look for all types of connections.
@return: List of nodes.

Returns: List of nodes

List all nodes that read information from this node.  'what' is an optional integer:
         You can use any combination of the following constants or'ed together to select what types of dependent nodes to look 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.

forceEvaluate 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:
nuke.toNode('Blur1').dependent( nuke.INPUTS | nuke.EXPRESSIONS )
@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 forceEvaluate: Specifies whether a full tree evaluation will take place. Defaults to True.
@return: List of nodes.

Returns: List of nodes

True if the node or any in its input tree have an error, or False otherwise.

Error state of the node and its input tree. Deprecated; use hasError or treeHasError instead. Note that this will always return false for viewers, which cannot generate their input trees. Instead, choose an input of the viewer (e.g. the active one), and call treeHasError() on that.

Returns: bool

Parameters:

• start - first frame
• end - last frame Returns the list of input file dependencies for this node and all nodes upstream from this node for the given frame range. The file dependencies are calcuated by searching for Read ops or ops with a File knob. All views are considered and current proxy mode is used to decide on whether full format or proxy files are returned. Note that Write nodes files are also included but precomps, gizmos and external plugins are not. Any time shifting operation such as frameholds, timeblurs, motionblur etc are taken into consideration. @return The return list is a list of nodes and files they require. Eg. [Read1, ['file1.dpx, file2.dpx'] ], [Read2, ['file3.dpx', 'file4.dpx'] ] ]

Returns: List of nodes and filenames

First frame in frame range for this node.

Returns: int

int.

Returns: Force Updates the localized files for this node

None

Format of the node.

Returns: Format

Format.

Frame range for this node.

Returns: FrameRange

FrameRange.

Get the name of this node and any groups enclosing it in 'group.group.name' form.

Returns: str

The fully-qualified name of this node, as a string.

Returns: The number of knobs

The number of knobs.

True if the node itself has an error, regardless of the state of the ops in its input tree, or False otherwise.

Error state of the node itself, regardless of the state of the ops in its input tree. Note that an error on a node may not appear if there is an error somewhere in its input tree, because it may not be possible to validate the node itself correctly in that case.

Returns: bool

Height of the node.

Returns: int

int.

Returns: str

Help for the node.

Returns: None

None

Parameters:

• i - Input number.

Returns: The i'th input

The i'th input.

Returns: Gets the maximum number of connected inputs

Number of the highest connected input + 1. If inputs 0, 1, and 3 are connected, this will return 4.

Returns: Returns if there are changes detected in the source file

true if the Localization source file has changed

Returns: returns True/False whether the node is completely localized

bool

Returns the current selection state of the node. This is the same as checking the 'selected' knob.

Returns: bool

True if selected, or False if not.

Parameters:

• p - A string or an integer.

Returns: The knob named p or the pth knob

The knob named p or the pth knob.

Note that this follows the links for Link_Knobs

Get a dictionary of (name, knob) pairs for all knobs in this node.

For example:

>>> b = nuke.nodes.Blur()
>>> b.knobs()

Returns: dict

Dictionary of all knobs.

Note that this doesn't follow the links for Link_Knobs

Last frame in frame range for this node.

Returns: int

int.

Returns a list of any knobs that may be linked to from the node as well as some meta information about the knob. This may include whether the knob is enabled and whether it should be used for absolute or relative values. Not all of these variables may make sense for all knobs..

Parameters:

• knobType, A, KnobType, describing, the, type, of, knobs, you, want.@return - A list of LinkableKnobInfo that may be empty .

Returns: List

Returns: Checks and reports on progress of localization of the current node

float, between 0.0 (not localized) and 1.0 (localized)

Returns: Maximum number of inputs this node can have

Maximum number of inputs this node can have.

Returns: Maximum number of outputs this node can have

Maximum number of outputs this node can have.

Returns: Maximum number of inputs this node can have

Maximum number of inputs this node can have.

Returns: Maximum number of outputs this node can have

Maximum number of outputs this node can have.

Return the metadata item for key on this node at current output context, or at optional time and view. If key is not specified a dictionary containing all key/value pairs is returned. None is returned if key does not exist on this node.

Parameters:

• key - Optional name of the metadata key to retrieve.
• time - Optional time to evaluate at (default is taken from node's current output context).
• view - Optional view to evaluate at (default is taken from node's current output context).

Returns: value or dict

The requested metadata value, a dictionary containing all keys if a key name is not provided, or None if the specified key is not matched.

Returns: Minimum number of inputs this node can have

Minimum number of inputs this node can have.

Returns: Minimum number of inputs this node can have

Minimum number of inputs this node can have.

Returns: str

Name of node.

Returns: The number of knobs

The number of knobs.

Returns: Number of first optional input

Number of first optional input.

Performance timing must be enabled.

Returns: Returns performance information for this node

A dictionary containing the cumulative performance info for this category, where: callCount = the number of calls made timeTakenCPU = the CPU time spent in microseconds timeTakenWall = the actual time ( wall time ) spent in microseconds

Pixel Aspect ratio of the node.

Returns: int

float.

Returns: bool

True if proxy is enabled, False otherwise.

Read the knobs from a string (TCL syntax).

Parameters:

• s - A string.

Returns: None

None.

Force a redraw of the node.

Returns: None

None.

Remove knob k from this node or panel. Throws a ValueError exception if k is not found on the node.

Parameters:

• k - Knob.

Returns: None

None.

Class method.

Returns: Node rendering when paralled threads are running or None

Node rendering when paralled threads are running or None.

Return pixel values from an image. This requires the image to be calculated, so performance may be very bad if this is placed into an expression in a control panel. Produces a cubic filtered result. Any sizes less than 1, including 0, produce the same filtered result, this is correct based on sampling theory. Note that integers are at the corners of pixels, to center on a pixel add .5 to both coordinates. If the optional dx,dy are not given then the exact value of the square pixel that x,y lands in is returned. This is also called 'impulse filtering'.

Parameters:

• c - Channel name.
• x - Centre of the area to sample (X coordinate).
• y - Centre of the area to sample (Y coordinate).
• dx - Optional size of the area to sample (X coordinate).
• dy - Optional size of the area to sample (Y coordinate).
• frame - Optional frame to sample the node at.

Returns: Floating point value

Floating point value.

Height of the node when displayed on screen in the DAG, at 1:1 zoom, in pixels.

Returns: int

int.

Width of the node when displayed on screen in the DAG, at 1:1 zoom, in pixels.

Returns: int

int.

Set this node to be the only selection, as if it had been clicked in the DAG.

Returns: None

None.

Connect input i to node if canSetInput() returns true.

Parameters:

• i - Input number.
• node - The node to connect to input i.

Returns: bool

True if canSetInput() returns true, or if the input is already correct.

Set name of the node and resolve name collisions if optional named argument 'uncollide' is True.

Parameters:

• name - A string.
• uncollide - Optional boolean to resolve name collisions. Defaults to True.
• updateExpressions - Optional boolean to update expressions in other nodes to point at the new name. Defaults to False.

Returns: None

None

Set the selection state of the node. This is the same as changing the 'selected' knob.

Parameters:

• selected - New selection state - True or False.

Returns: None

None.

Parameters:

• tabIndex - The tab to show (first is 0).

Returns: None

None

Set the (x, y) position of node in node graph.

Parameters:

• x - The x position of node in node graph.
• y - The y position of node in node graph.

Returns: None

None.

Set the x position of node in node graph.

Parameters:

• x - The x position of node in node graph.

Returns: None

None.

Set the y position of node in node graph.

Parameters:

• y - The y position of node in node graph.

Returns: None

None.

Parameters:

• forceFloat - Optional python object. If it evaluates to True the control panel will always open as a floating panel. Default is False.

Returns: None

None

Creates a dialog box showing the result of script s.

Parameters:

• s - A string.

Returns: None

None.

This can be used to skip updates that are not visible to the user.

Returns: true if the properties panel is open

true if the properties panel is open. This can be used to skip updates that are not visible to the user.

True if the node or any in its input tree have an error, or False otherwise.

Error state of the node and its input tree. Note that this will always return false for viewers, which cannot generate their input trees. Instead, choose an input of the viewer (e.g. the active one), and call treeHasError() on that.

Returns: bool

Frame range for the i'th input of this node.

Parameters:

• i - Input number.

Returns: FrameRange

FrameRange. Returns None when querying an invalid input.

Width of the node.

Returns: int

int.

Return a tcl list. If TO_SCRIPT | TO_VALUE is not on, this is a simple list
of knob names. If it is on, it is an alternating list of knob names
and the output of to_script().

Flags can be any of these or'd together:
- nuke.TO_SCRIPT produces to_script(0) values
- nuke.TO_VALUE produces to_script(context) values
- nuke.WRITE_NON_DEFAULT_ONLY skips knobs with not_default() false
- nuke.WRITE_USER_KNOB_DEFS writes addUserKnob commands for user knobs
- nuke.WRITE_ALL writes normally invisible knobs like name, xpos, ypos

@param i: The set of flags or'd together. Default is TO_SCRIPT | TO_VALUE.
@return: String in .nk form.

Returns: String in .nk form

Returns: X position of node in node graph

X position of node in node graph.

Returns: Y position of node in node graph

Y position of node in node graph.