Module callbacks

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

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.

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.

Internal function. Use addAutoSaveDeleteFilter to add a callback

Internal function. Use addAutoSaveFilter to add a callback

Internal function. Use addAutoSaveRestoreFilter to add a callback

autoSaveDeleteFilters

Value:

{'Root': [(<function onAutoSaveDelete at 0x7fada4104f50>, (), {}, None)]}

autoSaveFilters

Value:

{'Root': [(<function onAutoSave at 0x7fada4104e60>, (), {}, None)]}

autoSaveRestoreFilters

Value:

{'Root': [(<function onAutoSaveRestore at 0x7fada4104ed8>, (), {}, None)]}

knobChangeds

Value:

{'C_CameraSolver2_1': [(<function importKeysCallback2_1 at 0x7fadfc14c 5f0>, (), {}, None)], 'C_ColourMatcher2_1': [(<function importKeysCallback2_1 at 0x7fadfc14 c5f0>, (), ...

onCreates

Value:

{'C_Blender2_1': [(<function genericCreateCallback2_1 at 0x7fadfc14c57 8>, (), {}, None)], 'C_CameraIngest2_1': [(<function genericCreateCallback2_1 at 0x7fadfc 14c578>, (), ...

onDestroys

Value:

{'C_CameraIngest2_1': [(<function cameraIngestDestroyCallback2_1 at 0x 7fadfc14c488>, (), {}, None)], 'C_GlobalWarp2_1': [(<function globalWarpDestroyCallback2_1 at 0x7fad fc14c230>, (), ...

onUserCreates

Value:

{'C_CameraIngest2_1': [(<function cameraIngestUserCreateCallback2_1 at 0x7fadfc14c2a8>, (), {}, None)], 'C_VerticalAligner2_1': [(<function verticalAlignerUserCreateCallback 2_1 at 0x7fadfc14c500>, (), ...