Nuke Python API Reference
15.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
Threading
Render Farm Integration (Concept)
Performance Profiling
Installing Plug-ins
Sample Scripts
API Reference
nuke
nuke.activeGroup
nuke.activeViewer
nuke.addAfterBackgroundFrameRender
nuke.addAfterBackgroundRender
nuke.addAfterFrameRender
nuke.addAfterRecording
nuke.addAfterRender
nuke.addAfterReplay
nuke.addAutoSaveDeleteFilter
nuke.addAutoSaveFilter
nuke.addAutoSaveRestoreFilter
nuke.addAutolabel
nuke.addBeforeBackgroundRender
nuke.addBeforeFrameRender
nuke.addBeforeRecording
nuke.addBeforeRender
nuke.addBeforeReplay
nuke.addDefaultColorspaceMapper
nuke.addFavoriteDir
nuke.addFilenameFilter
nuke.addFormat
nuke.addKnobChanged
nuke.addNodePresetExcludePaths
nuke.addOnCreate
nuke.addOnDestroy
nuke.addOnScriptClose
nuke.addOnScriptLoad
nuke.addOnScriptSave
nuke.addOnUserCreate
nuke.addRenderProgress
nuke.addSequenceFileExtension
nuke.addToolsetExcludePaths
nuke.addUpdateUI
nuke.addValidateFilename
nuke.addView
nuke.afterBackgroundFrameRender
nuke.afterBackgroundRender
nuke.afterFrameRender
nuke.afterRecording
nuke.afterRender
nuke.afterReplay
nuke.alert
nuke.allNodes
nuke.animation
nuke.animationEnd
nuke.animationIncrement
nuke.animationStart
nuke.animations
nuke.applyPreset
nuke.applyUserPreset
nuke.ask
nuke.askWithCancel
nuke.autoSaveDeleteFilter
nuke.autoSaveFilter
nuke.autoSaveRestoreFilter
nuke.autolabel
nuke.autoplace
nuke.autoplaceSnap
nuke.autoplace_all
nuke.autoplace_snap_all
nuke.autoplace_snap_selected
nuke.beforeBackgroundRender
nuke.beforeFrameRender
nuke.beforeRecording
nuke.beforeRender
nuke.beforeReplay
nuke.cacheUsage
nuke.canCreateNode
nuke.cancel
nuke.center
nuke.channels
nuke.choice
nuke.clearAssetCache
nuke.clearBlinkCache
nuke.clearDiskCache
nuke.clearGeoSelection
nuke.clearRAMCache
nuke.clearTabMenuFavorites
nuke.clearTabMenuWeighting
nuke.clone
nuke.cloneSelected
nuke.collapseToGroup
nuke.collapseToLiveGroup
nuke.connectNodes
nuke.connectViewer
nuke.createLiveInput
nuke.createNode
nuke.createScenefileBrowser
nuke.createToolset
nuke.critical
nuke.debug
nuke.defaultColorspaceMapper
nuke.defaultFontPathname
nuke.defaultNodeColor
nuke.delete
nuke.deletePreset
nuke.deleteUserPreset
nuke.deleteView
nuke.dependencies
nuke.dependentNodes
nuke.display
nuke.duplicateSelectedNodes
nuke.endGroup
nuke.error
nuke.execute
nuke.executeBackgroundNuke
nuke.executeInMainThread
nuke.executeInMainThreadWithResult
nuke.executeMultiple
nuke.executing
nuke.exists
nuke.expandSelectedGroup
nuke.expr
nuke.expression
nuke.extractSelected
nuke.filename
nuke.filenameFilter
nuke.forceClone
nuke.forceLoad
nuke.fork
nuke.formats
nuke.frame
nuke.fromNode
nuke.getAllUserPresets
nuke.getClipname
nuke.getColor
nuke.getColorspaceList
nuke.getDeletedPresets
nuke.getFileNameList
nuke.getFilename
nuke.getFonts
nuke.getFramesAndViews
nuke.getGeoSelection
nuke.getInput
nuke.getNodeClassName
nuke.getNodePresetExcludePaths
nuke.getNodePresetID
nuke.getOcioColorSpaces
nuke.getPaneFor
nuke.getPresetKnobValues
nuke.getPresets
nuke.getPresetsMenu
nuke.getReadFileKnob
nuke.getRenderProgress
nuke.getToolsetExcludePaths
nuke.getUserPresetKnobValues
nuke.getUserPresets
nuke.hotkeys
nuke.inputs
nuke.invertSelection
nuke.knob
nuke.knobChanged
nuke.knobDefault
nuke.knobTooltip
nuke.lastHitGroup
nuke.layers
nuke.licenseInfo
nuke.load
nuke.loadModuleFromPath
nuke.loadToolset
nuke.localiseFiles
nuke.localizationEnabled
nuke.makeGroup
nuke.maxPerformanceInfo
nuke.menu
nuke.message
nuke.modified
nuke.nodeAtPath
nuke.nodeCopy
nuke.nodeDelete
nuke.nodePaste
nuke.nodeTypes
nuke.nodesSelected
nuke.numvalue
nuke.oculaPresent
nuke.ofxAddPluginAliasExclusion
nuke.ofxMenu
nuke.ofxPluginPath
nuke.ofxRemovePluginAliasExclusion
nuke.onCreate
nuke.onDestroy
nuke.onScriptClose
nuke.onScriptLoad
nuke.onScriptSave
nuke.onUserCreate
nuke.openPanels
nuke.pan
nuke.performanceProfileFilename
nuke.pluginAddPath
nuke.pluginAppendPath
nuke.pluginExists
nuke.pluginInstallLocation
nuke.pluginPath
nuke.plugins
nuke.recentFile
nuke.redo
nuke.registerFlipbook
nuke.removeAfterBackgroundFrameRender
nuke.removeAfterBackgroundRender
nuke.removeAfterFrameRender
nuke.removeAfterRecording
nuke.removeAfterRender
nuke.removeAfterReplay
nuke.removeAutoSaveDeleteFilter
nuke.removeAutoSaveFilter
nuke.removeAutoSaveRestoreFilter
nuke.removeAutolabel
nuke.removeBeforeBackgroundRender
nuke.removeBeforeFrameRender
nuke.removeBeforeRecording
nuke.removeBeforeRender
nuke.removeBeforeReplay
nuke.removeDefaultColorspaceMapper
nuke.removeFavoriteDir
nuke.removeFilenameFilter
nuke.removeFilenameValidate
nuke.removeKnobChanged
nuke.removeOnCreate
nuke.removeOnDestroy
nuke.removeOnScriptClose
nuke.removeOnScriptLoad
nuke.removeOnScriptSave
nuke.removeOnUserCreate
nuke.removeRenderProgress
nuke.removeUpdateUI
nuke.render
nuke.renderProgress
nuke.rescanFontFolders
nuke.resetPerformanceTimers
nuke.restoreWindowLayout
nuke.resumePathProcessing
nuke.root
nuke.runIn
nuke.sample
nuke.saveEventGraphTimers
nuke.saveToScript
nuke.saveUserPreset
nuke.saveWindowLayout
nuke.scriptClear
nuke.scriptClose
nuke.scriptExit
nuke.scriptName
nuke.scriptNew
nuke.scriptOpen
nuke.scriptReadFile
nuke.scriptReadText
nuke.scriptSave
nuke.scriptSaveAndClear
nuke.scriptSaveAs
nuke.scriptSaveToTemp
nuke.scriptSource
nuke.script_directory
nuke.selectAll
nuke.selectConnectedNodes
nuke.selectPattern
nuke.selectSimilar
nuke.selectedNode
nuke.selectedNodes
nuke.setGeoSelection
nuke.setPreset
nuke.setReadOnlyPresets
nuke.setUserPreset
nuke.show
nuke.showBookmarkChooser
nuke.showCreateViewsDialog
nuke.showDag
nuke.showInfo
nuke.showSettings
nuke.splayNodes
nuke.startEventGraphTimers
nuke.startPerformanceTimers
nuke.stopEventGraphTimers
nuke.stopPerformanceTimers
nuke.stripFrameRange
nuke.suspendPathProcessing
nuke.tabClose
nuke.tabNext
nuke.tcl
nuke.thisClass
nuke.thisGroup
nuke.thisKnob
nuke.thisNode
nuke.thisPane
nuke.thisParent
nuke.thisRoot
nuke.thisView
nuke.toNode
nuke.toggleFullscreen
nuke.toggleViewers
nuke.toolbar
nuke.tprint
nuke.undo
nuke.updateUI
nuke.usingOcio
nuke.usingPerformanceTimers
nuke.validateFilename
nuke.value
nuke.views
nuke.waitForThreadsToFinish
nuke.warning
nuke.zoom
nuke.zoomToFitSelected
nuke.AColor_Knob
nuke.AnimationCurve
nuke.AnimationKey
nuke.Array_Knob
nuke.Axis_Knob
nuke.BBox_Knob
nuke.BackdropNode
nuke.BeginTabGroup_Knob
nuke.Bitmask_Knob
nuke.Boolean_Knob
nuke.Box
nuke.Box3_Knob
nuke.CascadingEnumeration_Knob
nuke.ChannelMask_Knob
nuke.Channel_Knob
nuke.ColorChip_Knob
nuke.Color_Knob
nuke.Disable_Knob
nuke.Double_Knob
nuke.EditableEnumeration_Knob
nuke.EndTabGroup_Knob
nuke.Enumeration_Knob
nuke.EvalString_Knob
nuke.Eyedropper_Knob
nuke.File_Knob
nuke.FnPySingleton
nuke.Font_Knob
nuke.Format
nuke.Format_Knob
nuke.FrameRange
nuke.FrameRanges
nuke.FreeType_Knob
nuke.GeoSelect_Knob
nuke.GeoSelection
nuke.GeoSelectionItem
nuke.Gizmo
nuke.GlobalsEnvironment
nuke.Group
nuke.Gsv_Knob
nuke.Hash
nuke.Help_Knob
nuke.Histogram_Knob
nuke.IArray_Knob
nuke.Info
nuke.Int_Knob
nuke.Keyer_Knob
nuke.Knob
nuke.KnobType
nuke.Layer
nuke.Link_Knob
nuke.LinkableKnobInfo
nuke.LiveGroup
nuke.LookupCurves_Knob
nuke.Lut
nuke.Menu
nuke.MenuBar
nuke.MenuItem
nuke.MultiView_Knob
nuke.Multiline_Eval_String_Knob
nuke.Node
nuke.NodeConstructor
nuke.Nodes
nuke.Obsolete_Knob
nuke.OneView_Knob
nuke.OutputContext
nuke.Panel
nuke.PanelNode
nuke.ParticleChannels_Knob
nuke.Password_Knob
nuke.PathExpression_Knob
nuke.Path_Knob
nuke.Precomp
nuke.ProgressTask
nuke.Pulldown_Knob
nuke.PyCustom_Knob
nuke.PyScript_Knob
nuke.PythonCustomKnob
nuke.PythonKnob
nuke.Radio_Knob
nuke.Range_Knob
nuke.Root
nuke.RunInMainThread
nuke.Scale_Knob
nuke.SceneGraph_Knob
nuke.SceneView_Knob
nuke.Script_Knob
nuke.String_Knob
nuke.Tab_Knob
nuke.Text_Knob
nuke.ToolBar
nuke.Transform2d_Knob
nuke.UV_Knob
nuke.Undo
nuke.Unsigned_Knob
nuke.View
nuke.ViewView_Knob
nuke.Viewer
nuke.ViewerProcess
nuke.ViewerWindow
nuke.WH_Knob
nuke.XYZ_Knob
nuke.XY_Knob
nuke.CancelledError
nuke.ColorspaceLookupError
nuke.memory2
nukescripts
nuke.curveknob
nuke.curvelib
nuke.localization
nuke.nukemath
nuke.rotopaint
nuke.splinewarp
Nuke Python API Reference
»
nuke
»
nuke.forceClone
nuke.forceClone
nuke.
forceClone
(
)
→
bool
Returns
True if succeeded, False otherwise.