nukescripts

Various Nuke scripts

Functions

`addDropDataCallback`	Add a function to the list of callbacks.
`addSnapFunc`	Add a new snapping function to the list.
`allNodes`	Return an iterator which yields all nodes in the current script.
`allNodesWithGeoSelectKnob`
`allign_nodes`
`animation_loop`
`animation_negate`
`animation_reverse`
`anySelectedPoint`	Return a selected point from the active viewer or the first viewer with a selection.
`anySelectedVertexInfo`	Returns a single VertexInfo for a selected point.
`autoBackdrop`	Automatically puts a backdrop behind the selected nodes.
`autocrop`	Run the CurveTool's AutoCrop function on each selected node over the specified frame range and channels.
`averageNormal`	averageNormal(selectionThreshold -> _nukemath.Vector3 Return a _nukemath.Vector3 which is the average of the normals of all selected points
`average_normal`	Return a _nukemath.Vector3 which is the average of the normals of all selected points
`branch`
`cache_particles_panel`
`calcAveragePosition`	Calculate the average position of all points.
`calcBounds`
`calcRotationVector`
`calc_average_position`	Calculate the average position of all points.
`calc_bounds`	Get the size of the bounding box of all the selected points Avoid zero size to allow inverse scaling (1/scale)
`calc_rotation_vector`	Get the rotation vector
`callSnapFunc`	Call the snapping function on a node.
`cameraClass`	Returns the correct camera class for the 3D system in use.
`cameraProjectionMatrix`	Calculate the projection matrix for the camera based on its knob values.
`checkAllPointCollinear`	Iterates through the points the point and checks if all of them are collinear.
`checkUdimValue`
`check_all_point_collinear`	Iterates through the points the point and checks if all of them are collinear.
`clearAllCaches`	Clears all caches.
`clear_selection_recursive`	Sets all nodes to unselected, including in child groups.
`color_nodes`	Set all selected nodes to be the same colour as the first selected node.
`connect_selected_to_viewer`	Connect the selected node to the given input index of the active viewer.
`copy_knobs`
`copy_stage`	Returns a copy of the given stage.
`createCamera`	Create a camera node based on the values set in the given unreal reader node
`createNodeLocal`	Create a node within the context of the last hit group.
`createReadNode`	Create a read node for the rendered output
`create_camera_here`
`create_curve`
`create_read`	Create a Read node for a file selected from the file browser.
`create_viewsplitjoin`
`cut_paste_file`
`declone`
`degrees`	rtype `list`
`dropData`	Handle data drops by invoking the list of callback functions until one has handled the event
`ensure_frame_range`	If frames is not iterable (i.e it's a single number) we create an array with the single frame
`executeDeferred`
`executeInMainThread`	Execute the callable 'call' with optional arguments 'args' and named arguments 'kwargs' i n Nuke's main thread and return immediately.
`executeInMainThreadWithResult`	Execute the callable 'call' with optional arguments 'args' and named arguments 'kwargs' in Nuke's main thread and wait for the result to become available.
`execute_panel`
`export_nodes_as_script`
`extract`	Disconnect all arrows between selected and unselected nodes, and move selected nodes to the right.
`findMaxVersionForFileName`	Helper function for finding the max version of a paticular script in it's current directory.
`findNextName`
`findNextNodeName`
`flipbook`	Runs an arbitrary command on the images output by a node.
`framecycler_this`	Run framecycler on a Read or Write node.
`fuzzyIsZero`	Returns true if a value is very close to zero.
`fuzzyVector3Add`	Adds two vectors ensuring the coordinates are actually 0.0 if they are 0.0001 of zero.
`fuzzy_is_zero`	Returns true if a value is very close to zero.
`fuzzy_vector3_add`	Adds two vectors ensuring the coordinates are actually 0.0 if they are 0.0001 of zero.
`geo_to_selection`	Translate/rotate/scale the specified node to the average position of the current vertex selection on the stage.
`getAxisKnobPrefix`	Determine the correct knob name prefix for the Axis knob names by checking the originating knob that triggered the snap menu action.
`getLUTPath`	Returns a path to a LUT file for the given flipbook.
`getSelection`
`get_axis_pivot_rotate_knob`	Get the axis pivot_rotate knob
`get_axis_pivot_translate_knob`	Get the axis pivot_translate knob
`get_axis_rotate_knob`	Get the axis rotate knob
`get_axis_scaling_knob`	Get the axis scaling knob
`get_axis_translate_knob`	Get the axis translate knob
`get_axis_uniform_scaling_knob`	Get the axis uniform_scale knob
`get_fully_qualified_name`	Returns the full name of the node, including any parents, separated by periods.
`get_node_transform_matrix`	Generates the transformation matrix for a given node based on its knob values.
`get_prim_world_rotation_zxy`	Get xyz rotation angles in radians for the prim in world space assuming zxy rotation order
`get_reads`	Returns file names from all Read nodes.
`get_rotate_enabled`	Get whether rotation is enabled by the snap knob with the given prefix
`get_scale_enabled`	Get whether scale is enabled by the snap knob with the given prefix
`get_script_data`
`get_selected_prim_path`	Get the currently selected prim
`get_stage_from_active_viewer`	Gets the stage from the active viewer with the specified frame range.
`get_translate_enabled`	Get whether translation is enabled by the snap knob with the given prefix
`get_vertex_selection`	Build a GeoVertexSelection from GeoVertexInfos
`get_world_point_on_bbox`	Return points inside or on the bounding box of a prim in world space
`getallnodeinfo`
`goofy_title`	Returns a random message for use as an untitled script name.
`goto_frame`
`groupmake`	Builds a group from the current node selection.
`humanReadable`	Returns a string containing the number of bytes and the ISO/IEC units used.
`import_boujou`	Nuke 5.0 Py import_boujou.
`import_script`
`infoviewer`
`isAudioFilename`
`isDeepFilename`
`isGeoFilename`
`isSceneBrowserFilename`
`leastSignificantAxis`	Given a Vector3, returns the least significant axis position, being x, y and z 0, 1 and 2 respectively.
`least_significant_axis`	Given a Vector3, returns the least significant axis position, being x, y and z 0, 1 and 2 respectively.
`load_all_plugins`	Scan all of Nuke's plugin load paths and attempt to load any .dylib, .so, or .dll files as a plugin, skipping any files listed in PLUGINS_FILTER.
`makeBlinkscriptEditorKnob`
`makeParticleBlinkscriptEditorKnob`
`makeScriptEditorKnob`
`need_stage_copy`	This method will either return true if a copy of the stage is needed, false otherwise.
`new3D`	Checks if the node is using the new 3D system.
`nodeIsInside`	Checks whether the node geometry is inside backdropNode
`node_copypaste`
`node_delete`
`on_snap_knob`	Called by the snap knobs to perform a pivot_to_selection/pivot_to_bbox/geo_to_selection operation.
`parseUdimFile`	Parsing a filename string in search of the udim number.
`pivot_to_bbox`	Translate and optionally rotate the specified node's Pivot Point to a chosen point on the currently selected prim's bounding box.
`pivot_to_selection`	Translate and/or rotate the specified node's Pivot Point to the average position/rotation of the current vertex selection on the stage.
`planeRotation`	Calculate the rotations around the X, Y and Z axes that will align a plane perpendicular to the Z axis with the given triangle.
`plane_rotation`	Calculate the rotations around the X, Y and Z axes in radians that will align a plane perpendicular to the Z axis with the given triangle.
`precomp_copyToGroup`
`precomp_open`
`precomp_render`
`precomp_selected`
`print_callback_info`	Returns a list of all currently active callbacks, with the following optional arguments: verbose=False : prints the documentation as well as the callback callbackTypes=None : limit the callback info to a particular callback type (e.g. ['OnCreates']).
`projectPoint`	Project the given 3D point through the camera to get 2D pixel coordinates.
`projectPoints`	projectPoint(camera, points) -> list of nuke.math.Vector2
`projectSelectedPoints`	Using the specified camera, project all of the selected points into 2D pixel coordinates and return their locations.
`radians`	rtype `list`
`register`	Register a flipbook.
`registerLUTPath`	Register a LUT for a specific flipbook.
`remove_inputs`
`render_panel`
`replaceHashes`	Replace any sequences of 1 or more hash marks (#) with a printf-style %0nd specifier.
`rotateMatrixXYZ`	Generates a rotation XYZ matrix from the input vector.
`rotateMatrixZXY`	Generates a rotation ZXY matrix from the input vector.
`rotatePivotSelectionToPoints`
`rotatePivotToPoints`	Rotate the specified node's Pivot Point to the average of the current vertex selection normals in the active viewer.
`rotatePivotToPointsVerified`
`rotateToPointsVerified`
`rotate_geo_to_points_verified`	Rotate the geometry to the vertex selection (does not check for required conditions)
`rotate_matrix_xyz`	Generates a rotation XYZ matrix from the input vector.
`rotate_matrix_zxy`	Generates a rotation ZXY matrix from the input vector.
`rotate_pivot_to_angles_verified`	Rotate the pivot to rotation angles without affecting the geometry's position
`rotate_pivot_to_points_verified`	Rotate the pivot to the vertex selection without affecting the geometry's position
`scaleToPointsVerified`
`scale_geo_to_points_verified`	Scale the geometry to the vertex selection (does not check for required conditions)
`scalingMatrix`	Generates a scaling matrix from the input vector.
`scaling_matrix`	Generates a scaling matrix from the input vector.
`script_and_write_nodes_version_up`
`script_command`
`script_data`
`script_directory`
`script_version_up`	Increments the versioning in the script name and the path of the timeline write nodes, then saves the new version.
`search_replace`	Search/Replace in Reads and Writes.
`select_by_name`	Menu command to select nodes by a glob-pattern name.
`select_similar`	Included only for compatibility.
`selectedPoints`	Return an iterator which yields the position of every point currently selected in the Viewer in turn.
`selectedVertexInfos`	Return an iterator which yields a tuple of the index and position of each point currently selected in the Viewer in turn.
`selected_vertex_infos`	selectedVertexInfos(selectionThreshold) -> iterator
`set_fileknob_version`	Sets version of the filename knob to the passed in version.
`setupPyOpenGL`	Configure PyOpenGL for use with Nuke.
`should_animate`	Returns whether we need to animate the knob by checking how many frames we are going to affect and whether we want to animate even if only a single frame will be affected.
`showExecuteDialog`	Present a dialog that executes the given list of nodes.
`showRenderDialog`	Present a dialog that renders the given list of nodes.
`showReportDialog`	Creates a tree containing memory information from tracked allocations.
`showname`	Shows the current script path and, if the selected node is a Read or Write node, the filename from it.
`splitInSequence`
`start`	Open a URL or file.
`swapAB`	Swaps the first two inputs of a node.
`timeline_write_version_set`	Sets the version number in the file path of the 'timeline' write node
`toggle`	"Inverts" some flags on the selected nodes.
`transformMatrix`	Generates the transformation matrix for a given node based on its knob values.
`translateMatrix`	Generates a translation matrix from the input vector.
`translatePivotSelectionToPoints`
`translatePivotToPoints`	Translate the specified node's Pivot Point to the average position of the current vertex selection in the active viewer.
`translatePivotToPointsVerified`
`translateRotatePivot`	Pivot translation and rotation must keep the object stationary and in order to do that compensation values must be placed in the geometry translate and rotate.
`translateRotatePivotSelectionToPoints`
`translateRotatePivotToPoints`	Translate the specified node's Pivot Point to the average position of the current vertex selection and rotate the pivot to align Z to match the average normals in the active viewer.
`translateRotatePivotToPointsVerified`
`translateRotateScaleSelectionToPoints`
`translateRotateScaleThisNodeToPoints`
`translateRotateScaleToPoints`	Translate the specified node to the average position of the current vertex selection in the active viewer, rotate to the orientation of the (mean squares) best fit plane for the selection and scale to the extents of the selection.
`translateRotateScaleToPointsVerified`
`translateRotateSelectionToPoints`
`translateRotateThisNodeToPoints`
`translateRotateToPoints`	Translate the specified node to the average position of the current vertex selection in the active viewer and rotate to the orientation of the (mean squares) best fit plane for the selection.
`translateRotateToPointsVerified`
`translateSelectionToPoints`
`translateThisNodeToPoints`
`translateToPoints`	Translate the specified node to the average position of the current vertex selection in the active viewer.
`translateToPointsVerified`
`translate_geo_to_points_verified`	Translate the geometry to the vertex selection (does not check for required conditions)
`translate_matrix`	Generates a translation matrix from the input vector.
`translate_pivot_to_points_verified`	Translate the pivot to the vertex selection without affecting the geometry's position
`translate_pivot_to_world_pos_verified`	Translate the pivot to world position without affecting the geometry's position
`translate_rotate_pivot`	Pivot translation and rotation must keep the object stationary and in order to do that compensation values must be placed in the geometry translate and rotate.
`transpose`
`transpose_matrix3`	Transpose Matrix3 in place
`udimStr`
`udim_group`
`udim_import`	Imports a sequence of UDIM files and creates the node material tree needed.
`update_plugin_menu`
`uv2udim`
`verifyNodeOrder`
`verifyNodeToSnap`
`verifyVertexSelection`
`verify_node_order`	Verify the transform/rotation order
`verify_node_to_snap`	Check knobs exist and current transform/rotation order is supported
`verify_vertex_selection_for_rotation`	GeoSelection should have at least 3 selected vertices for rotation
`verify_vertex_selection_not_empty`	GeoSelection should have at least 1 selected vertex.
`version_down`	All new version_down that uses the version_get/set functions.
`version_get`	Extract version information from filenames used by DD (and Weta, apparently) These are _v# or /v# or .v# where v is a prefix string, in our case we use "v" for render version and "c" for camera track version.
`version_latest`	Like version_up, but only goes up to the highest numbered version that exists.
`version_set`	Changes version information from filenames used by DD (and Weta, apparently) These are _v# or /v# or .v# where v is a prefix string, in our case we use "v" for render version and "c" for camera track version.
`version_up`	All new version_up that uses the version_get/set functions.

Classes

`BlinkscriptEditorTab`
`BlinkscriptEditorWidgetKnob`
`FlipbookApplication`	An interface, for so far as Python supports it.
`FlipbookFactory`
`FlipbookLUTPathRegistry`	A registery of all LUT files against LUTs for each specific flipbook.
`GeoVertexInfo`	Information on a single vertex in the selection
`GeoVertexSelection`	Selection container
`InputHighlighter`	Initialize self.
`Iterable`
`LineNumberArea`	Initialize self.
`NukeProfiler`
`ParticleBlinkscriptEditorTab`	Initialize self.
`ParticleBlinkscriptEditorWidgetKnob`
`PrecompOptions`
`PrecompOptionsDialog`
`PythonPanel`
`QApplication`	__init__(self) -> None __init__(self, arg__1: Sequence[str]) -> None
`QDialog`	__init__(self, parent: Optional[PySide6.QtWidgets.QWidget] = None, f: PySide6.QtCore.Qt.WindowType = Default(Qt.WindowFlags)) -> None
`QLabel`	__init__(self, parent: Optional[PySide6.QtWidgets.QWidget] = None, f: PySide6.QtCore.Qt.WindowType = Default(Qt.WindowFlags)) -> None __init__(self, text: str, parent: Optional[PySide6.QtWidgets.QWidget] = None, f: PySide6.QtCore.Qt.WindowType = Default(Qt.WindowFlags)) -> None
`QPlainTextEdit`	__init__(self, parent: Optional[PySide6.QtWidgets.QWidget] = None) -> None __init__(self, text: str, parent: Optional[PySide6.QtWidgets.QWidget] = None) -> None
`QSplitter`	__init__(self, arg__1: PySide6.QtCore.Qt.Orientation, parent: Optional[PySide6.QtWidgets.QWidget] = None) -> None __init__(self, parent: Optional[PySide6.QtWidgets.QWidget] = None) -> None
`QVBoxLayout`	__init__(self) -> None __init__(self, parent: PySide6.QtWidgets.QWidget) -> None
`QWidget`	__init__(self, parent: Optional[PySide6.QtWidgets.QWidget] = None, f: PySide6.QtCore.Qt.WindowType = Default(Qt.WindowFlags)) -> None
`Qt`
`ReportTree`	Initialize self.
`ScriptEditor`	Initialize self.
`ScriptEditorWidgetKnob`
`ScriptInputArea`	Initialize self.
`StringIO`	Text I/O implementation using an in-memory buffer.
`TableDelegate`	Initialize self.
`UDIMErrorDialog`	Initialize self.
`UDIMFile`
`UDIMOptionsDialog`	Initialize self.
`ValueLabel`	Initialize self.
`VersionConflictDialog`	Dialog which gives the user options for resolving version conflicts
`VersionHelper`	Helper class for storing the new version information
`VertexInfo`
`VertexSelection`

`nukescripts.ViewerProcess`
`nukescripts.all_plugins`
`nukescripts.animation`
`nukescripts.applymaterial`	Functions used by the ApplyMaterial node
`nukescripts.autobackdrop`
`nukescripts.blinkscripteditor`
`nukescripts.bookmarks`
`nukescripts.cache`
`nukescripts.camera`
`nukescripts.camerapresets`
`nukescripts.cameratracker`	Functions used by the CameraTracker node
`nukescripts.captureViewer`	This module contains classes for performing a capture of the viewer.
`nukescripts.cattery`	This module is in charge of discovery and populating the cattery toolbar.
`nukescripts.clientserver`
`nukescripts.create`
`nukescripts.crop`
`nukescripts.drop`
`nukescripts.edit`
`nukescripts.execute`
`nukescripts.flags`
`nukescripts.flip`
`nukescripts.flipbooking`
`nukescripts.fnFlipbookRenderer`
`nukescripts.frame`
`nukescripts.framecycler`
`nukescripts.framerangepanel`
`nukescripts.geomath`
`nukescripts.geosnap3d`
`nukescripts.group`
`nukescripts.hardwareinfo`
`nukescripts.importexport`
`nukescripts.info`
`nukescripts.localisationprefs`	Code for handling changes in the localization default in the preferences and applying that as knob defaults on Read nodes.
`nukescripts.misc`
`nukescripts.modelbuilder`	Functions used by the ModelBuilder node
`nukescripts.nodepresets`
`nukescripts.nodes`
`nukescripts.nukeprofiler`
`nukescripts.opengl`
`nukescripts.openurl`
`nukescripts.panel_test`
`nukescripts.panels`
`nukescripts.plugin_menu`
`nukescripts.precomp`
`nukescripts.psd`
`nukescripts.pyAppUtils`
`nukescripts.pyQtAppUtils`
`nukescripts.pyQtExamples`
`nukescripts.pyWxAppUtils`
`nukescripts.pythonhighlighter`
`nukescripts.reads`
`nukescripts.readviewscheck`	Check for multiple views in files when a read node is created, by looking for a VIEW_NAMES entry in the node's metadata.
`nukescripts.renderdialog`
`nukescripts.renderman`
`nukescripts.renderpanel`
`nukescripts.rollingAutoSave`
`nukescripts.run_framecycler`
`nukescripts.script`
`nukescripts.scripteditorknob`
`nukescripts.searchreplace`
`nukescripts.select`
`nukescripts.snap3d`
`nukescripts.stereo`
`nukescripts.toolbars`
`nukescripts.toolsets`
`nukescripts.trackerlinkingdialog`
`nukescripts.udim`
`nukescripts.unrealreader`	Functions used by the UnrealReader node
`nukescripts.usdhighlighter`
`nukescripts.utils`
`nukescripts.version`
`nukescripts.viewsettingsprefs`
`nukescripts.widgetgroup`