mirror of
https://github.com/ynput/ayon-core.git
synced 2026-01-01 16:34:53 +01:00
14520c4a47
- adding `event.py` and moving to event based system - fixing registred families - fixing opening workfile and closing `untitled` project - fixing default tags creation only to project
363 lines
9.9 KiB
Python
363 lines
9.9 KiB
Python
import os
|
|
import sys
|
|
import hiero
|
|
import pyblish.api
|
|
import avalon.api as avalon
|
|
from avalon.vendor.Qt import (QtWidgets, QtGui)
|
|
import pype.api as pype
|
|
from pypeapp import Logger
|
|
|
|
|
|
log = Logger().get_logger(__name__, "nukestudio")
|
|
|
|
cached_process = None
|
|
|
|
|
|
self = sys.modules[__name__]
|
|
self._has_been_setup = False
|
|
self._has_menu = False
|
|
self._registered_gui = None
|
|
|
|
AVALON_CONFIG = os.getenv("AVALON_CONFIG", "pype")
|
|
|
|
|
|
def set_workfiles():
|
|
''' Wrapping function for workfiles launcher '''
|
|
from avalon.tools import workfiles
|
|
|
|
workdir = os.environ["AVALON_WORKDIR"]
|
|
|
|
# show workfile gui
|
|
workfiles.show(workdir)
|
|
|
|
def sync_avalon_data_to_workfile():
|
|
# import session to get project dir
|
|
S = avalon.Session
|
|
active_project_root = os.path.normpath(
|
|
os.path.join(S['AVALON_PROJECTS'], S['AVALON_PROJECT'])
|
|
)
|
|
# getting project
|
|
project = hiero.core.projects()[-1]
|
|
|
|
if "Tag Presets" in project.name():
|
|
return
|
|
|
|
log.debug("Synchronizing Pype metadata to project: {}".format(
|
|
project.name()))
|
|
|
|
# set project root with backward compatibility
|
|
try:
|
|
project.setProjectDirectory(active_project_root)
|
|
except Exception:
|
|
# old way of seting it
|
|
project.setProjectRoot(active_project_root)
|
|
|
|
# get project data from avalon db
|
|
project_data = pype.get_project()["data"]
|
|
|
|
log.debug("project_data: {}".format(project_data))
|
|
|
|
# get format and fps property from avalon db on project
|
|
width = project_data["resolutionWidth"]
|
|
height = project_data["resolutionHeight"]
|
|
pixel_aspect = project_data["pixelAspect"]
|
|
fps = project_data['fps']
|
|
format_name = project_data['code']
|
|
|
|
# create new format in hiero project
|
|
format = hiero.core.Format(width, height, pixel_aspect, format_name)
|
|
project.setOutputFormat(format)
|
|
|
|
# set fps to hiero project
|
|
project.setFramerate(fps)
|
|
|
|
# TODO: add auto colorspace set from project drop
|
|
log.info("Project property has been synchronised with Avalon db")
|
|
|
|
|
|
def launch_workfiles_app(event):
|
|
"""
|
|
Event for launching workfiles after nukestudio start
|
|
|
|
Args:
|
|
event (obj): required but unused
|
|
"""
|
|
set_workfiles()
|
|
|
|
|
|
|
|
def reload_config():
|
|
"""Attempt to reload pipeline at run-time.
|
|
|
|
CAUTION: This is primarily for development and debugging purposes.
|
|
|
|
"""
|
|
|
|
import importlib
|
|
|
|
for module in (
|
|
"avalon",
|
|
"avalon.lib",
|
|
"avalon.pipeline",
|
|
"pyblish",
|
|
"pyblish_lite",
|
|
"pypeapp",
|
|
"{}.api".format(AVALON_CONFIG),
|
|
"{}.templates".format(AVALON_CONFIG),
|
|
"{}.nukestudio.lib".format(AVALON_CONFIG),
|
|
"{}.nukestudio.menu".format(AVALON_CONFIG),
|
|
"{}.nukestudio.tags".format(AVALON_CONFIG)
|
|
):
|
|
log.info("Reloading module: {}...".format(module))
|
|
try:
|
|
module = importlib.import_module(module)
|
|
reload(module)
|
|
except Exception as e:
|
|
log.warning("Cannot reload module: {}".format(e))
|
|
importlib.reload(module)
|
|
|
|
|
|
def setup(console=False, port=None, menu=True):
|
|
"""Setup integration
|
|
|
|
Registers Pyblish for Hiero plug-ins and appends an item to the File-menu
|
|
|
|
Arguments:
|
|
console (bool): Display console with GUI
|
|
port (int, optional): Port from which to start looking for an
|
|
available port to connect with Pyblish QML, default
|
|
provided by Pyblish Integration.
|
|
menu (bool, optional): Display file menu in Hiero.
|
|
"""
|
|
|
|
if self._has_been_setup:
|
|
teardown()
|
|
|
|
add_submission()
|
|
|
|
if menu:
|
|
add_to_filemenu()
|
|
self._has_menu = True
|
|
|
|
self._has_been_setup = True
|
|
print("pyblish: Loaded successfully.")
|
|
|
|
|
|
def show():
|
|
"""Try showing the most desirable GUI
|
|
This function cycles through the currently registered
|
|
graphical user interfaces, if any, and presents it to
|
|
the user.
|
|
"""
|
|
|
|
return (_discover_gui() or _show_no_gui)()
|
|
|
|
|
|
def _discover_gui():
|
|
"""Return the most desirable of the currently registered GUIs"""
|
|
|
|
# Prefer last registered
|
|
guis = reversed(pyblish.api.registered_guis())
|
|
|
|
for gui in list(guis) + ["pyblish_lite"]:
|
|
try:
|
|
gui = __import__(gui).show
|
|
except (ImportError, AttributeError):
|
|
continue
|
|
else:
|
|
return gui
|
|
|
|
|
|
def teardown():
|
|
"""Remove integration"""
|
|
if not self._has_been_setup:
|
|
return
|
|
|
|
if self._has_menu:
|
|
remove_from_filemenu()
|
|
self._has_menu = False
|
|
|
|
self._has_been_setup = False
|
|
print("pyblish: Integration torn down successfully")
|
|
|
|
|
|
def remove_from_filemenu():
|
|
raise NotImplementedError("Implement me please.")
|
|
|
|
|
|
def add_to_filemenu():
|
|
PublishAction()
|
|
|
|
|
|
class PyblishSubmission(hiero.exporters.FnSubmission.Submission):
|
|
|
|
def __init__(self):
|
|
hiero.exporters.FnSubmission.Submission.__init__(self)
|
|
|
|
def addToQueue(self):
|
|
# Add submission to Hiero module for retrieval in plugins.
|
|
hiero.submission = self
|
|
show()
|
|
|
|
|
|
def add_submission():
|
|
registry = hiero.core.taskRegistry
|
|
registry.addSubmission("Pyblish", PyblishSubmission)
|
|
|
|
|
|
class PublishAction(QtWidgets.QAction):
|
|
"""
|
|
Action with is showing as menu item
|
|
"""
|
|
|
|
def __init__(self):
|
|
QtWidgets.QAction.__init__(self, "Publish", None)
|
|
self.triggered.connect(self.publish)
|
|
|
|
for interest in ["kShowContextMenu/kTimeline",
|
|
"kShowContextMenukBin",
|
|
"kShowContextMenu/kSpreadsheet"]:
|
|
hiero.core.events.registerInterest(interest, self.eventHandler)
|
|
|
|
self.setShortcut("Ctrl+Alt+P")
|
|
|
|
def publish(self):
|
|
# Removing "submission" attribute from hiero module, to prevent tasks
|
|
# from getting picked up when not using the "Export" dialog.
|
|
if hasattr(hiero, "submission"):
|
|
del hiero.submission
|
|
show()
|
|
|
|
def eventHandler(self, event):
|
|
# Add the Menu to the right-click menu
|
|
event.menu.addAction(self)
|
|
|
|
|
|
def _show_no_gui():
|
|
"""
|
|
Popup with information about how to register a new GUI
|
|
In the event of no GUI being registered or available,
|
|
this information dialog will appear to guide the user
|
|
through how to get set up with one.
|
|
"""
|
|
|
|
messagebox = QtWidgets.QMessageBox()
|
|
messagebox.setIcon(messagebox.Warning)
|
|
messagebox.setWindowIcon(QtGui.QIcon(os.path.join(
|
|
os.path.dirname(pyblish.__file__),
|
|
"icons",
|
|
"logo-32x32.svg"))
|
|
)
|
|
|
|
spacer = QtWidgets.QWidget()
|
|
spacer.setMinimumSize(400, 0)
|
|
spacer.setSizePolicy(QtWidgets.QSizePolicy.Minimum,
|
|
QtWidgets.QSizePolicy.Expanding)
|
|
|
|
layout = messagebox.layout()
|
|
layout.addWidget(spacer, layout.rowCount(), 0, 1, layout.columnCount())
|
|
|
|
messagebox.setWindowTitle("Uh oh")
|
|
messagebox.setText("No registered GUI found.")
|
|
|
|
if not pyblish.api.registered_guis():
|
|
messagebox.setInformativeText(
|
|
"In order to show you a GUI, one must first be registered. "
|
|
"Press \"Show details...\" below for information on how to "
|
|
"do that.")
|
|
|
|
messagebox.setDetailedText(
|
|
"Pyblish supports one or more graphical user interfaces "
|
|
"to be registered at once, the next acting as a fallback to "
|
|
"the previous."
|
|
"\n"
|
|
"\n"
|
|
"For example, to use Pyblish Lite, first install it:"
|
|
"\n"
|
|
"\n"
|
|
"$ pip install pyblish-lite"
|
|
"\n"
|
|
"\n"
|
|
"Then register it, like so:"
|
|
"\n"
|
|
"\n"
|
|
">>> import pyblish.api\n"
|
|
">>> pyblish.api.register_gui(\"pyblish_lite\")"
|
|
"\n"
|
|
"\n"
|
|
"The next time you try running this, Lite will appear."
|
|
"\n"
|
|
"See http://api.pyblish.com/register_gui.html for "
|
|
"more information.")
|
|
|
|
else:
|
|
messagebox.setInformativeText(
|
|
"None of the registered graphical user interfaces "
|
|
"could be found."
|
|
"\n"
|
|
"\n"
|
|
"Press \"Show details\" for more information.")
|
|
|
|
messagebox.setDetailedText(
|
|
"These interfaces are currently registered."
|
|
"\n"
|
|
"%s" % "\n".join(pyblish.api.registered_guis()))
|
|
|
|
messagebox.setStandardButtons(messagebox.Ok)
|
|
messagebox.exec_()
|
|
|
|
|
|
def CreateNukeWorkfile(nodes=None,
|
|
nodes_effects=None,
|
|
to_timeline=False,
|
|
**kwargs):
|
|
''' Creating nuke workfile with particular version with given nodes
|
|
Also it is creating timeline track items as precomps.
|
|
|
|
Arguments:
|
|
nodes(list of dict): each key in dict is knob order is important
|
|
to_timeline(type): will build trackItem with metadata
|
|
|
|
Returns:
|
|
bool: True if done
|
|
|
|
Raises:
|
|
Exception: with traceback
|
|
|
|
'''
|
|
import hiero.core
|
|
from avalon.nuke import imprint
|
|
from pype.nuke import (
|
|
lib as nklib
|
|
)
|
|
|
|
# check if the file exists if does then Raise "File exists!"
|
|
if os.path.exists(filepath):
|
|
raise FileExistsError("File already exists: `{}`".format(filepath))
|
|
|
|
# if no representations matching then
|
|
# Raise "no representations to be build"
|
|
if len(representations) == 0:
|
|
raise AttributeError("Missing list of `representations`")
|
|
|
|
# check nodes input
|
|
if len(nodes) == 0:
|
|
log.warning("Missing list of `nodes`")
|
|
|
|
# create temp nk file
|
|
nuke_script = hiero.core.nuke.ScriptWriter()
|
|
|
|
# create root node and save all metadata
|
|
root_node = hiero.core.nuke.RootNode()
|
|
|
|
root_path = os.environ["AVALON_PROJECTS"]
|
|
|
|
nuke_script.addNode(root_node)
|
|
|
|
# here to call pype.nuke.lib.BuildWorkfile
|
|
script_builder = nklib.BuildWorkfile(
|
|
root_node=root_node,
|
|
root_path=root_path,
|
|
nodes=nuke_script.getNodes(),
|
|
**kwargs
|
|
)
|