nukescripts

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_move

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

branch

cache_particles_panel

calcAveragePosition

Calculate the average position of all points.

calcBounds

calcRotationVector

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.

camera_down

All new camera_down that uses the version_get/set functions.

camera_up

All new camera_up that uses the version_get/set functions.

checkAllPointCollinear

Iterates through the points the point and checks if all of them are collinear.

checkUdimValue

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

Connects the selected node to the given viewer input index, ignoring errors if no node is selected.

copy_knobs

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, normally determined by clicking into a group window or group view.

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

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.

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.

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_fully_qualified_name

get_reads

Returns file names from all Read nodes.

get_script_data

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.

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.

makeScriptEditorKnob

new3D

Checks if the node is using the new 3D system.

nodeIsInside

Returns true if node geometry is inside backdropNode otherwise returns false

node_copypaste

node_delete

parseUdimFile

Parsing a filename string in search of the udim number.

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.

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

scaleToPointsVerified

scalingMatrix

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.

set_fileknob_version

Sets version of the filename knob to the passed in version.

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

transpose

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

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

FlipbookApplication

An interface, for so far as Python supports it.

FlipbookFactory

FlipbookLUTPathRegistry

A registery of all LUT files against LUTs for each specific flipbook.

InputHighlighter

LineNumberArea

NukeProfiler

PrecompOptions

PrecompOptionsDialog

PythonHighlighter

QApplication

QDialog

QLabel

QSplitter

QVBoxLayout

QWidget

Qt

ReportTree

ScriptEditor

ScriptEditorWidgetKnob

ScriptInputArea

StringIO

Text I/O implementation using an in-memory buffer.

TableDelegate

UDIMErrorDialog

UDIMFile

UDIMOptionsDialog

UsdHighlighter

ValueLabel

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

nukescripts.nukeprofiler

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

nukescripts.renderpanel

nukescripts.rollingAutoSave

nukescripts.run_framecycler

nukescripts.script

nukescripts.scripteditorknob

nukescripts.searchreplace

nukescripts.select

nukescripts.snap3d

nukescripts.stereo

nukescripts.toolbars

nukescripts.udim

nukescripts.unrealreader

Functions used by the UnrealReader node

nukescripts.usdhighlighter

nukescripts.utils

nukescripts.version

nukescripts.viewsettingsprefs