Welcome to NUKE Python Developer’s Guide

Contents:

• Introduction
  • Info
• Start-up Scripts
  • Evaluation Order
  • menu.py
  • init.py
• Getting Started
  • Creating Nodes and Setting Their Controls
    • Creating a Node in the User Interface
    • Creating a Node for Scripting
    • Setting Controls at Node Creation
  • Assigning Variables
  • Getting the Node Object for Existing Nodes
  • Accessing Selected Nodes in the Node Graph
  • Adding Controls to Nodes
  • Showing and Hiding a Node’s Properties Panel
  • Connecting Nodes and Setting Their Inputs
  • Setting Default Values for Controls
  • Rendering with the Write Node
  • Flipbooking with External Applications
  • Listing a Node’s Controls
  • Undoing and Redoing Actions
  • Frame Navigation
  • Setting Frame Ranges
  • Marking Frame Numbers in File Names
  • Copying an Animation Curve Between Nodes
  • Overriding the Creation of a Particular Node
  • Getting Information on the NUKE Environment You Are Running
  • Accessing Node Metadata
  • Creating Dialogs and Panels
    • Creating Modal Dialogs
    • Python Dialog Example
    • Creating Non-Modal Panels
    • Non-Modal Panel Example
  • Creating Progress Bar Dialogs
  • Clearing out the Current NUKE (.nk) Script
  • Creating Views for a Stereoscopic Project
  • Adjusting Control Values in Stereo Projects
• Nuke as a Python Module
  • Licensing
• Animation
  • Setting Keys
  • Detecting Keys
  • Examples
    • Baking Animation
• Using the Command-line
  • Running NUKE in Python Mode
  • Using Command-line Arguments
  • Modifying Existing NUKE Scripts
  • Executing Frame Ranges
• Callbacks
  • OnUserCreate
  • onCreate
  • onScriptLoad
  • onScriptSave
  • onScriptClose
  • onDestroy
  • knobChanged
  • updateUI
  • autolabel
  • beforeRender
  • beforeFrameRender
  • afterFrameRender
  • afterRender
  • afterBackgroundRender
  • afterBackgroundFrameRender
  • filenameFilter
  • validateFilename
  • autoSaveFilter
  • autoSaveRestoreFilter
  • autoSaveDeleteFilter
    • Using Autosave Callbacks to Implement a Rolling Autosave
    • Using Callbacks on Root to Add Stereo Setup
  • Default Colorspaces
• Stereo
  • Multi View Knob Values
  • Examples
    • Creating/Converting a Stereo Camera
    • Setting Up Stereo
• Roto and RotoPaint
  • Examples
    • paintTrajectory
    • trackShape
    • path Controller
    • trackCV
• Accessing Image Data
  • Using the CurveTool
  • Using the Sample Method
  • Examples
    • getMinMax
    • Using Sample
• Custom Panels
  • Simple Panel Commands
  • Simple Panel Object
  • Python Panels
    • ShapePanel
    • ShapeAndCVPanel
    • Search and Replace Panel
• Extending NUKE with PySide
  • My First PySide Window
  • Dockable PySide Widgets
  • Migrating from PyQt Applications
• Customizing the UI
  • Creating a Custom Menu
  • Creating a Custom Toolbar
  • Creating a Custom Menu Item
  • Assigning a Hotkey
  • Defining Knob Defaults
• Custom Flipbooks
  • Using Tweak Software’s RV as the Default Flipbook Application
• Metadata
  • Reading Metadata
  • Setting Metadata
  • Examples
    • createMetaDatCam
• Working with Channels and Layers
  • Reading Channels
  • Adding New Channels
  • Examples
    • autoComp
• Manipulating the Node Graph
  • Getting and Setting Node Positions
  • Controlling the Node Graph’s Pan and Zoom
  • Examples
    • A Circle Made of Dot Nodes
    • A Spiral
    • Controlling the Distance between Nodes
• Formats
  • Reading Formats
  • Adding a New Format
  • Setting Formats
• Math
  • Using matrix
  • Example
    • paintPoints
• Asset Management Systems / Pipeline Integration
  • Custom Script Save Workflow
  • Custom Script Load Workflow
  • Custom Write Node
  • Custom Read Node
  • Custom UDIM Parsing function
• Threading
  • Examples
    • MirrorNodes
• Render Farm Integration (Concept)
• Performance Profiling
  • Using Performance Timers
  • A Note on Nuke’s Architecture
  • Obtaining Performance Timings via Python
  • Other Performance Statistics
  • Writing Performance Information to an XML File
• Installing Plug-ins
  • Home Directory
  • Custom Plug-in Repository
• Sample Scripts