Skip to content

SG-40163 Make FPTR menu work for Houdini version 21.0+ #90

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Closed

SG-40163 Make FPTR menu work for Houdini version 21.0+ #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4ca55d5
WIP
julien-lang Apr 16, 2025
f2b5aba
Remove some more
julien-lang Sep 10, 2025
64ddf62
Cleanup
julien-lang Sep 10, 2025
0e584a8
Black
julien-lang Sep 10, 2025
a36c222
fixup! Remove some more
julien-lang Sep 16, 2025
c4e8d2d
Refactoring # This is the 1st commit message:
julien-lang Sep 16, 2025
86022a7
Generate the dynamic menu for Houdini before the app starts
julien-lang Sep 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
257 changes: 69 additions & 188 deletions engine.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,14 +210,13 @@ def pre_app_init(self):
if not self._ui_enabled:
return

if self._houdini_version[0] >= 15:
# In houdini 15+, we can use the dynamic menus and shelf api to
# properly handle cases where a file is loaded outside of a PTR
# context. Make sure the timer that looks for current file changes
# is running.
tk_houdini = self.import_module("tk_houdini")
if self.get_setting("automatic_context_switch", True):
tk_houdini.ensure_file_change_timer_running()
# We can use the dynamic menus and shelf api to
# properly handle cases where a file is loaded outside of a PTR
# context. Make sure the timer that looks for current file changes
# is running.
tk_houdini = self.import_module("tk_houdini")
if self.get_setting("automatic_context_switch", True):
tk_houdini.ensure_file_change_timer_running()

self._menu_name = "Flow Production Tracking"
if self.get_setting("use_short_menu_name", False):
Expand Down Expand Up @@ -281,18 +280,17 @@ def _load_otls():

# setup houdini menus
menu_file = self._safe_path_join(xml_tmp_dir, "MainMenuCommon")

# as of houdini 12.5 add .xml
if self._houdini_version > (12, 5, 0):
menu_file = menu_file + ".xml"
menu_file = menu_file + ".xml"

# keep the reference to the menu handler for convenience so
# that we can access it from the menu scripts when they get
# ahold of the current engine.
self._menu = tk_houdini.AppCommandsMenu(self, commands)

menu = tk_houdini.MenuBuilder(self._menu_name, self.logger)
if not os.path.exists(menu_file):
# just create the xml for the menus
self._menu.create_menu(menu_file)
menu.create(menu_file)

if commands and enable_sg_shelf:

Expand Down Expand Up @@ -351,7 +349,7 @@ def _poll_for_ui_available_then_setup_shelves():
else:
_setup_shelf()

if commands and self._panels_supported():
if commands:

# Get the list of registered commands to build panels for. The
# commands returned are AppCommand objects defined in
Expand Down Expand Up @@ -386,53 +384,10 @@ def _poll_for_ui_available_then_setup_shelves():
# consistent, intended look and feel of the toolkit widgets.
# Surprisingly, calling this does not seem to have any affect on
# houdini itself, despite the global nature of the method.
#
# NOTE: Except for 16+. It's no longer safe and causes lots of styling
# problems in Houdini's UI globally.
if self._houdini_version < (16, 0, 0):
self.logger.debug("Houdini < 16 detected: applying dark look and feel.")
self._initialize_dark_look_and_feel()

# Run a series of app instance commands at startup.
self._run_app_instance_commands()

# In Houdini 18, we see substantial stability problems related to Qt in
# builds older than 18.0.348, which is the point when SideFx moved to a
# newer version of Qt and PySide2. We've reproduced problems on OSX and
# Linux, and we have reports of crashes on Windows, as well. All of these
# issues are no longer a problem in 348+, so we'll warn users on builds
# of H18 older than that.
if self._houdini_version[0] == 18 and self._houdini_version[-1] < 348:
# We need to wait until Houdini idles before showing the message.
# If we show it right now, it will pop up behind Houdini's splash
# screen, and since the dialog is modal you end up in a situation
# where Houdini does not continue to launch, and you can't see or
# dismiss the dialog to unblock it.
def run_when_idle():
hou.ui.displayMessage(
text="Houdini 18 versions older than 18.0.348 are unstable when using "
"Flow Production Tracking. Be aware that Houdini crashes may "
"occur if attempting to use Toolkit apps from your current Houdini "
"session. PTR recommends updating Houdini to 18.0.348 or newer.",
title="Flow Production Tracking",
severity=hou.severityType.Warning,
)

# Have the function unregister itself. It does this by looping over
# all the registered callbacks and finding itself by looking for a
# special attribute that is added below (just before registering it
# as an event loop callback).
for callback in hou.ui.eventLoopCallbacks():
if hasattr(callback, "tk_houdini_stability_msg"):
hou.ui.removeEventLoopCallback(callback)

# Add the special attribute that the function will look use to find
# and unregister itself when executed.
run_when_idle.tk_houdini_stability_msg = True

# Add the function as an event loop callback.
hou.ui.addEventLoopCallback(run_when_idle)

def destroy_engine(self):
"""
Engine shutdown.
Expand Down Expand Up @@ -561,48 +516,36 @@ def show_panel(self, panel_id, title, bundle, widget_class, *args, **kwargs):
pane_tab.setIsCurrentTab()
return

# panel support differs between 14/15.
if self._panels_supported():

# if it can't be located, try to create a new tab and set the
# interface.
panel_interface = None
try:
for interface in hou.pypanel.interfacesInFile(self._panels_file):
if interface.name() == panel_id:
panel_interface = interface
break
except hou.OperationFailed:
# likely due to panels file not being a valid file, missing, etc.
# hopefully not the case, but try to continue gracefully.
self.logger.warning(
"Unable to find interface for panel '%s' in file: %s"
% (panel_id, self._panels_file)
)
# if it can't be located, try to create a new tab and set the
# interface.
panel_interface = None
try:
for interface in hou.pypanel.interfacesInFile(self._panels_file):
if interface.name() == panel_id:
panel_interface = interface
break
except hou.OperationFailed:
# likely due to panels file not being a valid file, missing, etc.
# hopefully not the case, but try to continue gracefully.
self.logger.warning(
"Unable to find interface for panel '%s' in file: %s"
% (panel_id, self._panels_file)
)

if panel_interface:
# the options to create a named panel on the far right of the
# UI doesn't seem to be present in python. so hscript it is!
# Here's the docs for the hscript command:
# https://www.sidefx.com/docs/houdini14.0/commands/pane
hou.hscript("pane -S -m pythonpanel -o -n %s" % panel_id)
panel = hou.ui.curDesktop().findPaneTab(panel_id)

# different calls to set the python panel interface in Houdini
# 14/15
if self._houdini_version[0] >= 15:
panel.setActiveInterface(panel_interface)
else:
# if SESI puts in a fix for setInterface, then panels
# will work for houini 14. will just need to update
# _panels_supported() to add the proper version. and
# remove this comment.
panel.setInterface(panel_interface)

# turn off the python panel toolbar to make the tk panels look
# more integrated. should be all good so just return
panel.showToolbar(False)
return
if panel_interface:
# the options to create a named panel on the far right of the
# UI doesn't seem to be present in python. so hscript it is!
# Here's the docs for the hscript command:
# https://www.sidefx.com/docs/houdini14.0/commands/pane
hou.hscript("pane -S -m pythonpanel -o -n %s" % panel_id)
panel = hou.ui.curDesktop().findPaneTab(panel_id)

panel.setActiveInterface(panel_interface)

# turn off the python panel toolbar to make the tk panels look
# more integrated. should be all good so just return
panel.showToolbar(False)
return

# if we're here, then showing as a panel was unsuccesful or not
# supported. Just show it as a dialog.
Expand Down Expand Up @@ -749,37 +692,6 @@ def _get_otl_paths(self, otl_path):

return otl_paths

def _panels_supported(self):
"""
Returns True if panels are supported for current Houdini version.
"""

ver = hou.applicationVersion()

# first version where saving python panel in desktop was fixed
if sgtk.util.is_macos():
# We have some serious painting problems with Python panes in
# H16 that are specific to OS X. We have word out to SESI, and
# are waiting to hear back from them as to how we might be able
# to proceed. Until that is sorted out, though, we're going to
# have to disable panel support on OS X for H16. Our panel apps
# appear to function just fine in dialog mode.
#
# Update: H17 resolves some of the issues, but we still have problems
# with item delegates not rendering consistently in the Shotgun Panel's
# entity views.
if ver >= (16, 0, 0):
return False

if ver >= (15, 0, 272):
return True

return False

# NOTE: there is an outstanding bug at SESI to backport a fix to make
# setInterface work properly in houdini 14. If that goes through, we'll
# be able to make embedded panels work in houdini 14 too.

def _run_app_instance_commands(self):
"""
Runs the series of app instance commands listed in the 'run_at_startup'
Expand Down Expand Up @@ -936,31 +848,16 @@ def _create_dialog(self, title, bundle, widget, parent):
self, title, bundle, widget, parent
)

h_ver = hou.applicationVersion()

if dialog.parent():
# parenting crushes the dialog's style. This seems to work to reset
# the style to the dark look and feel in preparation for the
# re-application below. See the comment about initializing the dark
# look and feel above.
#
# We can only do this in Houdini 15.x or older. With the switch to
# Qt5/PySide2 in H16, enough has changed in Houdini's styling that
# we break its styling in a few places if we zero out the main window's
# stylesheet. We're now compensating for the problems that arise in
# the engine's style.qss.
if h_ver < (16, 0, 0):
dialog.parent().setStyleSheet("")

# This will ensure our dialogs don't fall behind Houdini's main
# window when they lose focus.
#
# NOTE: Setting the window flags in H18 on OSX causes a crash. Once
# that bug is resolved we can re-enable this. The result is that
# on H18 without the window flags set per the below, our dialogs
# will fall behind Houdini if they lose focus. This is only an issue
# for versions of H18 older than 18.0.348.
if sgtk.util.is_macos() and (h_ver[0] == 18 and h_ver >= (18, 0, 348)):

if sgtk.util.is_macos():
dialog.setWindowFlags(dialog.windowFlags() | QtCore.Qt.Tool)
else:
# no parent found, so style should be ok. this is probably,
Expand All @@ -986,14 +883,12 @@ def _create_dialog(self, title, bundle, widget, parent):
# and combine the two into a single, unified stylesheet for the dialog
# and widget.
engine_root_path = self._get_engine_root_path()
h_major_ver = hou.applicationVersion()[0]

if bundle.name in ["tk-multi-shotgunpanel", "tk-multi-publish2"]:
if bundle.name == "tk-multi-shotgunpanel":
self._apply_external_styleshet(bundle, dialog)

# Styling in H16+ is very different than in earlier versions of
# Houdini. The result is that we have to be more careful about
# Styling Houdini, we have to be more careful about
# behavior concerning stylesheets, because we might bleed into
# Houdini itself if we change qss on parent objects or make use
# of QStyles on the QApplication.
Expand All @@ -1002,39 +897,31 @@ def _create_dialog(self, title, bundle, widget, parent):
# already assigned to the widget. This means that the engine
# styling is helping patch holes in any app- or framework-level
# qss that might have already been applied.
if h_major_ver >= 16:
# We don't apply the engine's style.qss to the dialog for the panel,
# but we do for the publisher. This will make sure that the tank
# dialog's header and info slide-out widget is properly styled. The
# panel app doesn't show that stuff, so we don't need to worry about
# it.
if bundle.name == "tk-multi-publish2":
self._apply_external_styleshet(self, dialog)

qss_file = self._get_engine_qss_file()
with open(qss_file, "rt") as f:
qss_data = f.read()
qss_data = self._resolve_sg_stylesheet_tokens(qss_data)
qss_data = qss_data.replace(
"{{ENGINE_ROOT_PATH}}", engine_root_path
)
widget.setStyleSheet(widget.styleSheet() + qss_data)
widget.update()
else:
# manually re-apply any bundled stylesheet to the dialog if we are older
# than H16. In 16 we inherited styling problems and need to rely on the
# engine level qss only.
#
# If we're in 16+, we also need to apply the engine-level qss.
if h_major_ver >= 16:
# We don't apply the engine's style.qss to the dialog for the panel,
# but we do for the publisher. This will make sure that the tank
# dialog's header and info slide-out widget is properly styled. The
# panel app doesn't show that stuff, so we don't need to worry about
# it.
if bundle.name == "tk-multi-publish2":
self._apply_external_styleshet(self, dialog)
qss = dialog.styleSheet()
qss = qss.replace("{{ENGINE_ROOT_PATH}}", engine_root_path)
dialog.setStyleSheet(qss)
dialog.update()

if hou.applicationVersion()[0] < 16:
self._apply_external_styleshet(bundle, dialog)
qss_file = self._get_engine_qss_file()
with open(qss_file, "rt") as f:
qss_data = f.read()
qss_data = self._resolve_sg_stylesheet_tokens(qss_data)
qss_data = qss_data.replace("{{ENGINE_ROOT_PATH}}", engine_root_path)
widget.setStyleSheet(widget.styleSheet() + qss_data)
widget.update()
else:
# manually re-apply any bundled stylesheet to the dialog
# We inherited styling problems and need to rely on the
# engine level qss only.
self._apply_external_styleshet(self, dialog)
qss = dialog.styleSheet()
qss = qss.replace("{{ENGINE_ROOT_PATH}}", engine_root_path)
dialog.setStyleSheet(qss)
dialog.update()

# raise and activate the dialog:
dialog.raise_()
Expand All @@ -1045,11 +932,7 @@ def _create_dialog(self, title, bundle, widget, parent):
# Anything beyond 16.5.481 bundles a PySide2 version that gives us
# a usable hwnd directly. We also check to make sure this is Qt5,
# since SideFX still offers Qt4/PySide builds of modern Houdinis.
if hou.applicationVersion() >= (
16,
5,
481,
) and QtCore.__version__.startswith("5."):
if QtCore.__version__.startswith("5."):
hwnd = dialog.winId()
else:
ctypes.pythonapi.PyCObject_AsVoidPtr.restype = ctypes.c_void_p
Expand Down Expand Up @@ -1087,8 +970,7 @@ def show_modal(self, title, bundle, widget_class, *args, **kwargs):
# our dialog, those styling changes we've applied either as part
# of the app's style.qss, or tk-houdini's, everything sticks the
# way it should.
if hou.applicationVersion() >= (16, 0, 0):
dialog.parent().setStyleSheet(dialog.parent().styleSheet())
dialog.parent().setStyleSheet(dialog.parent().styleSheet())

# finally launch it, modal state
status = dialog.exec_()
Expand Down Expand Up @@ -1128,8 +1010,7 @@ def show_dialog(self, title, bundle, widget_class, *args, **kwargs):
# our dialog, those styling changes we've applied either as part
# of the app's style.qss, or tk-houdini's, everything sticks the
# way it should.
if hou.applicationVersion() >= (16, 0, 0):
dialog.parent().setStyleSheet(dialog.parent().styleSheet())
dialog.parent().setStyleSheet(dialog.parent().styleSheet())

# lastly, return the instantiated widget
return widget
Expand Down
1 change: 1 addition & 0 deletions python/tk_houdini/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
AppCommandsMenu,
AppCommandsShelf,
AppCommandsPanelHandler,
MenuBuilder,
ensure_file_change_timer_running,
get_registered_commands,
get_registered_panels,
Expand Down
Loading
Loading