nuke.ViewerProcess

class nuke.ViewerProcess

Bases: object

Methods

node	nuke.ViewerProcess.node(name, viewer) -> Node.
nodeMonitorOut	nuke.ViewerProcess.nodeMonitorOut(name, viewer) -> Node.
register	nuke.ViewerProcess.register(name, call, args, kwargs) -> None.
registeredNames	nuke.ViewerProcess.registeredNames() -> List.
restoreSelectionAfterReload	nuke.ViewerProcess.restoreSelectionAfterReload() -> None.
storeSelectionBeforeReload	nuke.ViewerProcess.storeSelectionBeforeReload() -> None.
unregister	nuke.ViewerProcess.unregister(name) -> None.

classmethod node(name, viewer) → Node.

Returns a ViewerProcess node. Default is to return the current selected one. This is a class method.

Parameters:

• name – Optional ViewerProcess name.

• viewer – Optional viewer name.

Returns:

Node.

classmethod nodeMonitorOut(name, viewer) → Node.

Returns a ViewerProcess node for Monitor Out. If a viewer has not been specified, returns the current selected one. This is a class method.

Parameters:

• name – Optional ViewerProcess name.

• viewer – Optional viewer name.

Returns:

Node.

classmethod register(name, call, args, kwargs) → None.

Register a ViewerProcess. This is a class method.

Parameters:

• name – Menu name.

• call – Python callable. Must return a Node.

• args – Arguments to call.

• kwargs – Optional named arguments.

Returns:

None.

classmethod registeredNames() → List.

Returns a list containing the names of all currently regisered ViewerProcesses.

Returns:

List.

classmethod restoreSelectionAfterReload() → None.

Restores the viewer process selection after an OCIO or Nuke Config has been reloaded this is normally called after nuke.ViewerProcess.storeSelectionBeforeReload()

Returns:

None.

classmethod storeSelectionBeforeReload() → None.

When the user reloads an OCIO or Nuke config the viewer process selection is stored in the the viewer process object Following the reload you can call nuke.ViewerProcess.restoreSelectionAfterReload() which will then restore the selection instead of the default.

Returns:

None.

classmethod unregister(name) → None.

Unregister a ViewerProcess. This is a class method.

Parameters:

name – Menu name.

Returns:

None.