VFXWindow

Qt Window class for designing tools to be compatible between multiple VFX programs.

The main purpose of the class is to integrate into the program UI, but it also contains helpful features such as safely dealing with callbacks and automatically saving the window position.

The intended usage is to make your window class inherit VFXWindow - which is an instance of QMainWindow. By calling cls.show(), it will launch the correct window type based on what program is loaded, and what settings were previously saved.

This is perfectly stable, but there is still plenty that needs improvement. Maya, Nuke, 3DS Max, Houdini, Blender, Substance Designer, Unreal and Fusion are currently supported, though any help to extend those would be appreciated, as well as support for any other applications.

Installation

pip install vfxwindow

Basic Example:

class MyWindow(VFXWindow):
    WindowID = 'unique_window_id'
    WindowName = 'My Window'

    def __init__(self, parent=None, **kwargs):
        super(MyWindow, self).__init__(parent, **kwargs)
        # Setup window here

        # Setup callbacks, but wait until the program is ready
        self.deferred(self.newScene)

    def newScene(self, *args):
        """Example: Delete and reapply callbacks after loading a new scene."""
        self.removeCallbacks('sceneNewCallbacks')
        if self.maya:
            self.addCallbackScene('kAfterNew', self.newScene, group='sceneNewCallbacks')
        elif self.nuke:
            self.addCallbackOnCreate(self.newScene, nodeClass='Root', group='sceneNewCallbacks')

if __name__ == '__main__':
    MyWindow.show()

Compatibility

Maya (2011-2016, tested lightly on 2016) - standard, docked (pymel.core.dockControl), standalone, callbacks
Maya (2017+, tested on 2017-2019) - standard, docked (pymel.core.workspaceControl), standalone, callbacks
Nuke (tested on 9-12) - standard, docked (nukescripts.panels), callbacks
Substance Designer (tested on 2019.3) - standard, docked (unable to save/load position)
3D Studio Max (2018+, tested on 2020) - standard
Houdini (tested on 16) - standard
Blender (tested on 2.80) - standard, callbacks
Unreal (4.19+, tested on 4.23) - standard
Fusion (tested on 9) - standard
Standalone (Qt4, Qt5, tested on 2.7, 3.4+) - standard

Generic Features

Automatically save/restore window position
Move window to screen if out of bounds (windows only)
Keep track of callbacks to remove groups if required, and clean up on window close
Keep track of signals to remove groups if required
Display a popup message that forces control
Set palette to that of another program
Auto close if opening a duplicate window
Close down all windows at once
Create dialog windows automatically attached to the application (and return data)

Maya Features

Dock window using workspaceControl
Save/restore position of workspaceControl window (floating+docked)
Easy access to callbacks

Nuke Features

Dock window as a panel
Save/restore location of panel (docked only)
Easy access to callbacks

Blender Features

Easy access to callbacks

Substance Features

Dock window into panels

Non-Python Applications

Certain Windows applications have dispatch based COM interface, which will allow a link between Python and the application. See photoshop-scripting-python for an example on how to connect to an application.

Currently there is no way of launching VFXWindow from inside these applications.

Special Thanks

Blue Zoo - I've been building this up while working there
Lior Ben Horin: Simple_MayaDockingClass.py - used for main Maya docking code
Fredrik Averpil: pyvfx-boilerplate - helped with palettes, Nuke, and pre-2017 Maya

sgodanas/vfxwindow