Nuke Python API Reference
17.1
Introduction
Start-up Scripts
Getting Started
Nuke as a Python Module
Animation
Using the Command-line
Callbacks
Stereo
3D
Roto and RotoPaint
Accessing Image Data
Custom Panels
Extending NUKE with PySide
Customizing the UI
Custom Flipbooks
Metadata
Working with Channels and Layers
Manipulating the Node Graph
Formats
Math
Asset Management Systems / Pipeline Integration
OpenAssetIO Integration
Graph Scope Variables / Multi-shot Set-up
Threading
Render Farm Integration (Concept)
Performance Profiling
Installing Plug-ins
Sample Scripts
API Reference
nuke
nuke.curveknob
nuke.curvelib
nuke.gsv
nuke.localization
nuke.memory2
nuke.nukemath
nuke.rotopaint
nuke.splinewarp
nukescripts
nukescripts.addDropDataCallback
nukescripts.addSnapFunc
nukescripts.allNodes
nukescripts.allNodesWithGeoSelectKnob
nukescripts.allign_nodes
nukescripts.animation_loop
nukescripts.animation_negate
nukescripts.animation_reverse
nukescripts.anySelectedPoint
nukescripts.anySelectedVertexInfo
nukescripts.autoBackdrop
nukescripts.autocrop
nukescripts.averageNormal
nukescripts.average_normal
nukescripts.branch
nukescripts.cache_particles_panel
nukescripts.calcAveragePosition
nukescripts.calcBounds
nukescripts.calcRotationVector
nukescripts.calc_average_position
nukescripts.calc_bounds
nukescripts.calc_rotation_vector
nukescripts.callSnapFunc
nukescripts.cameraClass
nukescripts.cameraProjectionMatrix
nukescripts.checkAllPointCollinear
nukescripts.checkUdimValue
nukescripts.check_all_point_collinear
nukescripts.classic3D
nukescripts.clearAllCaches
nukescripts.clear_selection_recursive
nukescripts.color_nodes
nukescripts.connect_selected_to_viewer
nukescripts.copy_knobs
nukescripts.copy_stage
nukescripts.createCamera
nukescripts.createNodeLocal
nukescripts.createReadNode
nukescripts.create_camera_here
nukescripts.create_curve
nukescripts.create_read
nukescripts.create_viewsplitjoin
nukescripts.cut_paste_file
nukescripts.declone
nukescripts.degrees
nukescripts.dropData
nukescripts.ensure_frame_range
nukescripts.executeDeferred
nukescripts.executeInMainThread
nukescripts.executeInMainThreadWithResult
nukescripts.execute_panel
nukescripts.export_nodes_as_script
nukescripts.extract
nukescripts.findMaxVersionForFileName
nukescripts.findNextName
nukescripts.findNextNodeName
nukescripts.flipbook
nukescripts.framecycler_this
nukescripts.fuzzyIsZero
nukescripts.fuzzyVector3Add
nukescripts.fuzzy_is_zero
nukescripts.fuzzy_vector3_add
nukescripts.geo_to_selection
nukescripts.getAxisKnobPrefix
nukescripts.getLUTPath
nukescripts.getSelection
nukescripts.get_axis_pivot_rotate_knob
nukescripts.get_axis_pivot_translate_knob
nukescripts.get_axis_rotate_knob
nukescripts.get_axis_scaling_knob
nukescripts.get_axis_translate_knob
nukescripts.get_axis_uniform_scaling_knob
nukescripts.get_fully_qualified_name
nukescripts.get_node_transform_matrix
nukescripts.get_prim_world_rotation_zxy
nukescripts.get_reads
nukescripts.get_rotate_enabled
nukescripts.get_scale_enabled
nukescripts.get_script_data
nukescripts.get_selected_prim_path
nukescripts.get_stage_from_active_viewer
nukescripts.get_translate_enabled
nukescripts.get_vertex_selection
nukescripts.get_world_point_on_bbox
nukescripts.getallnodeinfo
nukescripts.goofy_title
nukescripts.goto_frame
nukescripts.groupmake
nukescripts.humanReadable
nukescripts.import_boujou
nukescripts.import_script
nukescripts.infoviewer
nukescripts.isAudioFilename
nukescripts.isDeepFilename
nukescripts.isSupported3DFilename
nukescripts.isUnsupported3DFilename
nukescripts.leastSignificantAxis
nukescripts.least_significant_axis
nukescripts.load_all_plugins
nukescripts.makeBlinkscriptEditorKnob
nukescripts.makeParticleBlinkscriptEditorKnob
nukescripts.makeScriptEditorKnob
nukescripts.need_stage_copy
nukescripts.nodeIsInside
nukescripts.node_copypaste
nukescripts.node_delete
nukescripts.on_snap_knob
nukescripts.parseUdimFile
nukescripts.pivot_to_bbox
nukescripts.pivot_to_selection
nukescripts.planeRotation
nukescripts.plane_rotation
nukescripts.precomp_copyToGroup
nukescripts.precomp_open
nukescripts.precomp_render
nukescripts.precomp_selected
nukescripts.print_callback_info
nukescripts.projectPoint
nukescripts.projectPoints
nukescripts.projectSelectedPoints
nukescripts.radians
nukescripts.register
nukescripts.registerLUTPath
nukescripts.remove_inputs
nukescripts.render_panel
nukescripts.replaceHashes
nukescripts.rotateMatrixXYZ
nukescripts.rotateMatrixZXY
nukescripts.rotatePivotSelectionToPoints
nukescripts.rotatePivotToPoints
nukescripts.rotatePivotToPointsVerified
nukescripts.rotateToPointsVerified
nukescripts.rotate_geo_to_points_verified
nukescripts.rotate_matrix_xyz
nukescripts.rotate_matrix_zxy
nukescripts.rotate_pivot_to_angles_verified
nukescripts.rotate_pivot_to_points_verified
nukescripts.scaleToPointsVerified
nukescripts.scale_geo_to_points_verified
nukescripts.scalingMatrix
nukescripts.scaling_matrix
nukescripts.script_and_write_nodes_version_up
nukescripts.script_command
nukescripts.script_data
nukescripts.script_directory
nukescripts.script_version_up
nukescripts.search_replace
nukescripts.select_by_name
nukescripts.select_similar
nukescripts.selectedPoints
nukescripts.selectedVertexInfos
nukescripts.selected_vertex_infos
nukescripts.set_fileknob_version
nukescripts.setupPyOpenGL
nukescripts.should_animate
nukescripts.showExecuteDialog
nukescripts.showRenderDialog
nukescripts.showReportDialog
nukescripts.showname
nukescripts.splitInSequence
nukescripts.start
nukescripts.swapAB
nukescripts.timeline_write_version_set
nukescripts.toggle
nukescripts.transformMatrix
nukescripts.translateMatrix
nukescripts.translatePivotSelectionToPoints
nukescripts.translatePivotToPoints
nukescripts.translatePivotToPointsVerified
nukescripts.translateRotatePivot
nukescripts.translateRotatePivotSelectionToPoints
nukescripts.translateRotatePivotToPoints
nukescripts.translateRotatePivotToPointsVerified
nukescripts.translateRotateScaleSelectionToPoints
nukescripts.translateRotateScaleThisNodeToPoints
nukescripts.translateRotateScaleToPoints
nukescripts.translateRotateScaleToPointsVerified
nukescripts.translateRotateSelectionToPoints
nukescripts.translateRotateThisNodeToPoints
nukescripts.translateRotateToPoints
nukescripts.translateRotateToPointsVerified
nukescripts.translateSelectionToPoints
nukescripts.translateThisNodeToPoints
nukescripts.translateToPoints
nukescripts.translateToPointsVerified
nukescripts.translate_geo_to_points_verified
nukescripts.translate_matrix
nukescripts.translate_pivot_to_points_verified
nukescripts.translate_pivot_to_world_pos_verified
nukescripts.translate_rotate_pivot
nukescripts.transpose
nukescripts.transpose_matrix3
nukescripts.udimStr
nukescripts.udim_group
nukescripts.udim_import
nukescripts.update_plugin_menu
nukescripts.uv2udim
nukescripts.verifyNodeOrder
nukescripts.verifyNodeToSnap
nukescripts.verifyVertexSelection
nukescripts.verify_node_order
nukescripts.verify_node_to_snap
nukescripts.verify_vertex_selection_for_rotation
nukescripts.verify_vertex_selection_not_empty
nukescripts.version_down
nukescripts.version_get
nukescripts.version_latest
nukescripts.version_set
nukescripts.version_up
nukescripts.BlinkscriptEditorTab
nukescripts.BlinkscriptEditorWidgetKnob
nukescripts.FlipbookApplication
nukescripts.FlipbookFactory
nukescripts.FlipbookLUTPathRegistry
nukescripts.GeoVertexInfo
nukescripts.GeoVertexSelection
nukescripts.InputHighlighter
nukescripts.Iterable
nukescripts.KnobFlagClearer
nukescripts.LineNumberArea
nukescripts.NukeProfiler
nukescripts.ParticleBlinkscriptEditorTab
nukescripts.ParticleBlinkscriptEditorWidgetKnob
nukescripts.Path
nukescripts.PrecompOptions
nukescripts.PrecompOptionsDialog
nukescripts.PythonPanel
nukescripts.QApplication
nukescripts.QDialog
nukescripts.QLabel
nukescripts.QPlainTextEdit
nukescripts.QSplitter
nukescripts.QVBoxLayout
nukescripts.QWidget
nukescripts.Qt
nukescripts.ReportTree
nukescripts.ScriptEditor
nukescripts.ScriptEditorWidgetKnob
nukescripts.ScriptInputArea
nukescripts.StringIO
nukescripts.TableDelegate
nukescripts.TracebackType
nukescripts.UDIMErrorDialog
nukescripts.UDIMFile
nukescripts.UDIMOptionsDialog
nukescripts.ValueLabel
nukescripts.VersionConflictDialog
nukescripts.VersionHelper
nukescripts.Versions
nukescripts.VertexInfo
nukescripts.VertexSelection
nukescripts.ViewerProcess
nukescripts.all_plugins
nukescripts.animation
nukescripts.applymaterial
nukescripts.autobackdrop
nukescripts.blinkscripteditor
nukescripts.bookmarks
nukescripts.cache
nukescripts.camera
nukescripts.camerapresets
nukescripts.cameratracker
nukescripts.captureViewer
nukescripts.cattery
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
nukescripts.misc
nukescripts.modelbuilder
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.pyQtExamples.flipbookingExample
nukescripts.pyQtExamples.pyQtRender
nukescripts.pyQtExamples.pyQtRender2
nukescripts.pyWxAppUtils
nukescripts.pythonhighlighter
nukescripts.reads
nukescripts.readviewscheck
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
nukescripts.usdhighlighter
nukescripts.utils
nukescripts.version
nukescripts.viewsettingsprefs
nukescripts.widgetgroup
Nuke Python API Reference
nukescripts
nukescripts.pyQtExamples
nukescripts.pyQtExamples
flipbookingExample
pyQtRender
pyQtRender2