fxgui 2.1.0__tar.gz

fxgui-2.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Valentin Beaumont
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fxgui-2.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include fxgui *
+global-exclude __pycache__/*

fxgui-2.1.0/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.1
+Name: fxgui
+Version: 2.1.0
+Summary: Custom Python classes and utilities tailored for Qt built UI, in VFX-oriented DCC applications.
+Author: Valentin Beaumont
+Author-email: valentin.onze@gmail.com
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: qtpy
+Requires-Dist: PySide2
+
+<p align="left">
+  <a href="https://www.python.org">
+  <img src="https://img.shields.io/badge/-Python-FFD43B?style=for-the-badge&logo=python" alt="Python"/></a>
+  <img src="https://img.shields.io/badge/-PySide-284821?style=for-the-badge&logo=qt" alt="Python"/></a>
+  <img src="https://img.shields.io/badge/-Windows-00A4EF?style=for-the-badge&logo=windows" alt="Compatible with Windows"/></a>
+  <img src="https://img.shields.io/badge/-macOS-000000?style=for-the-badge&logo=apple" alt="Compatible with macOS"/></a>
+  <img src="https://img.shields.io/badge/-Linux-E95420?style=for-the-badge&logo=linux" alt="Compatible with Linux"/></a>
+</p>
+
+<div align="center">
+
+  ![Logo](./fxgui/images/fxgui_logo_dark.svg#gh-light-mode-only)
+  ![Logo](./fxgui/images/fxgui_logo_light.svg#gh-dark-mode-only)
+
+  <h3 align="center">FXGUI</h3>
+
+  <p align="center">
+    Custom Python classes and utilities tailored for Qt built UI, in VFX-oriented DCC applications.
+    <br/>
+    <br/>
+    <br/>
+  </p>
+
+</div>
+
+
+
+<!-- TABLE OF CONTENTS -->
+## Table of Contents
+<!--ts-->
+- [Table of Contents](#table-of-contents)
+- [About](#about)
+- [Installation](#installation)
+- [Example](#example)
+- [Documentation](#documentation)
+- [Gallery](#gallery)
+- [Contact](#contact)
+<!--te-->
+
+
+
+<!-- ABOUT -->
+## About
+
+Custom Python classes and utilities tailored for Qt built UI, in VFX-oriented DCC applications.
+
+
+
+<!-- INSTALLATION -->
+## Installation
+
+``` shell
+pip install fxgui
+```
+
+> [!IMPORTANT]
+> In order to have access to the module, make sure to add `fxgui` to the `$PYTHONPATH` of the DCCs. For Houdini, you can find the [houdini_package file](./houdini_package.json).
+
+
+
+<!-- EXAMPLE -->
+## Example
+
+After installing FXGui, you can run the demo:
+
+``` shell
+python example.py
+```
+Or:
+``` python
+from fxgui import examples
+
+examples.main()
+```
+
+Here's how it would like like launched from Houdini and launched as a standalone:
+
+![Screenshot](./docs/images/qwZ0omKbe0.png)
+
+
+
+<!-- DOCUMENTATION -->
+## Documentation
+
+Please read the full documentation [here](https://healkeiser.github.io/pyside2_vfx_template/).
+
+
+
+<!-- GALLERY -->
+## Gallery
+
+|                 Splash Screen                  |                 Main Window                  |
+| :--------------------------------------------: | :------------------------------------------: |
+| ![Splash Screen](./docs/images/jxxZTVZy29.png) | ![Main Window](./docs/images/e72Hfw2ReZ.png) |
+
+
+
+<!-- CONTACT -->
+## Contact
+
+Project Link: [fxgui](https://github.com/healkeiser/fxgui)
+
+<p align='left'>
+  <a href="https://www.linkedin.com/in/valentin-beaumont">
+  <img src="https://img.shields.io/badge/-LinkedIn-0A66C2?style=for-the-badge&logo=linkedin" alt="LinkedIn"/></a>
+  <a href="https://www.behance.net/el1ven">
+  <img src="https://img.shields.io/badge/-Behance-313131?style=for-the-badge&logo=behance" alt="Behance"/></a>
+  <a href="https://twitter.com/valentinbeaumon">
+  <img src="https://img.shields.io/badge/-Twitter-E1E8ED?style=for-the-badge&logo=twitter" alt="Twitter"/></a>
+  <a href="https://www.instagram.com/val.beaumontart">
+  <img src="https://img.shields.io/badge/-Instagram-85255b?style=for-the-badge&logo=instagram" alt="Instagram"/></a>
+  <a href="https://healkeiser.gumroad.com/subscribe">
+  <img src="https://img.shields.io/badge/-Gumroad-20151f?style=for-the-badge&logo=gumroad" alt="Gumroad"/></a>
+</p>
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png)](https://www.buymeacoffee.com/healkeiser)
+

fxgui-2.1.0/README.md

@@ -0,0 +1,117 @@
+<p align="left">
+  <a href="https://www.python.org">
+  <img src="https://img.shields.io/badge/-Python-FFD43B?style=for-the-badge&logo=python" alt="Python"/></a>
+  <img src="https://img.shields.io/badge/-PySide-284821?style=for-the-badge&logo=qt" alt="Python"/></a>
+  <img src="https://img.shields.io/badge/-Windows-00A4EF?style=for-the-badge&logo=windows" alt="Compatible with Windows"/></a>
+  <img src="https://img.shields.io/badge/-macOS-000000?style=for-the-badge&logo=apple" alt="Compatible with macOS"/></a>
+  <img src="https://img.shields.io/badge/-Linux-E95420?style=for-the-badge&logo=linux" alt="Compatible with Linux"/></a>
+</p>
+
+<div align="center">
+
+  ![Logo](./fxgui/images/fxgui_logo_dark.svg#gh-light-mode-only)
+  ![Logo](./fxgui/images/fxgui_logo_light.svg#gh-dark-mode-only)
+
+  <h3 align="center">FXGUI</h3>
+
+  <p align="center">
+    Custom Python classes and utilities tailored for Qt built UI, in VFX-oriented DCC applications.
+    <br/>
+    <br/>
+    <br/>
+  </p>
+
+</div>
+
+
+
+<!-- TABLE OF CONTENTS -->
+## Table of Contents
+<!--ts-->
+- [Table of Contents](#table-of-contents)
+- [About](#about)
+- [Installation](#installation)
+- [Example](#example)
+- [Documentation](#documentation)
+- [Gallery](#gallery)
+- [Contact](#contact)
+<!--te-->
+
+
+
+<!-- ABOUT -->
+## About
+
+Custom Python classes and utilities tailored for Qt built UI, in VFX-oriented DCC applications.
+
+
+
+<!-- INSTALLATION -->
+## Installation
+
+``` shell
+pip install fxgui
+```
+
+> [!IMPORTANT]
+> In order to have access to the module, make sure to add `fxgui` to the `$PYTHONPATH` of the DCCs. For Houdini, you can find the [houdini_package file](./houdini_package.json).
+
+
+
+<!-- EXAMPLE -->
+## Example
+
+After installing FXGui, you can run the demo:
+
+``` shell
+python example.py
+```
+Or:
+``` python
+from fxgui import examples
+
+examples.main()
+```
+
+Here's how it would like like launched from Houdini and launched as a standalone:
+
+![Screenshot](./docs/images/qwZ0omKbe0.png)
+
+
+
+<!-- DOCUMENTATION -->
+## Documentation
+
+Please read the full documentation [here](https://healkeiser.github.io/pyside2_vfx_template/).
+
+
+
+<!-- GALLERY -->
+## Gallery
+
+|                 Splash Screen                  |                 Main Window                  |
+| :--------------------------------------------: | :------------------------------------------: |
+| ![Splash Screen](./docs/images/jxxZTVZy29.png) | ![Main Window](./docs/images/e72Hfw2ReZ.png) |
+
+
+
+<!-- CONTACT -->
+## Contact
+
+Project Link: [fxgui](https://github.com/healkeiser/fxgui)
+
+<p align='left'>
+  <a href="https://www.linkedin.com/in/valentin-beaumont">
+  <img src="https://img.shields.io/badge/-LinkedIn-0A66C2?style=for-the-badge&logo=linkedin" alt="LinkedIn"/></a>
+  <a href="https://www.behance.net/el1ven">
+  <img src="https://img.shields.io/badge/-Behance-313131?style=for-the-badge&logo=behance" alt="Behance"/></a>
+  <a href="https://twitter.com/valentinbeaumon">
+  <img src="https://img.shields.io/badge/-Twitter-E1E8ED?style=for-the-badge&logo=twitter" alt="Twitter"/></a>
+  <a href="https://www.instagram.com/val.beaumontart">
+  <img src="https://img.shields.io/badge/-Instagram-85255b?style=for-the-badge&logo=instagram" alt="Instagram"/></a>
+  <a href="https://healkeiser.gumroad.com/subscribe">
+  <img src="https://img.shields.io/badge/-Gumroad-20151f?style=for-the-badge&logo=gumroad" alt="Gumroad"/></a>
+</p>
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png)](https://www.buymeacoffee.com/healkeiser)
+

fxgui-2.1.0/fxgui/__init__.py

@@ -0,0 +1,8 @@
+# Built-in
+import os
+
+# Internal
+from fxgui import fxdcc, fxicons, fxstyle, fxutils, fxwidgets
+
+os.environ["QT_API"] = "pyside2"
+__all__ = [fxdcc, fxicons, fxstyle, fxutils, fxwidgets]

fxgui-2.1.0/fxgui/examples.py

@@ -0,0 +1,207 @@
+"""Examples on how to use the `fxgui` module."""
+
+# Built-in
+import os
+
+os.environ["QT_API"] = "pyside2"
+
+# Third-party
+from qtpy.QtWidgets import *
+from qtpy.QtUiTools import *
+from qtpy.QtCore import *
+from qtpy.QtGui import *
+
+# Internal
+try:
+    from fxgui import fxwidgets, fxutils, fxdcc, fxstyle
+except ModuleNotFoundError:
+    import fxwidgets, fxutils, fxdcc, fxstyle
+
+
+###### CODE ####################################################################
+
+
+_ui_file = os.path.join(os.path.dirname(__file__), "ui", "test.ui")
+_pixmap = os.path.join(os.path.dirname(__file__), "images", "splash.png")
+
+
+def show_window_houdini():
+    """An example VFXWindow instance launched from inside Houdini."""
+
+    houdini_window = fxdcc.get_dcc_main_window()
+    window = fxwidgets.VFXWindow(parent=houdini_window, ui_file=_ui_file, parent_package=fxdcc.HOUDINI)
+    window.show()
+
+
+def show_floating_dialog_houdini():
+    """An example VFXFloatingDialog launched from inside Houdini."""
+
+    import hou
+
+    houdini_window = fxdcc.get_dcc_main_window()
+    floating_dialog = fxwidgets.VFXFloatingDialog(parent=houdini_window)
+
+    # Set icon
+    icon = hou.qt.Icon("MISC_python")
+    pixmap = fxutils.convert_qicon_to_qpixmap(icon, QSize(10, 100))
+    floating_dialog.set_dialog_icon(pixmap)
+
+    # Add button to the `button_box`
+    floating_dialog.button_box.addButton("Test", QDialogButtonBox.ActionRole)
+
+    # Add combo box
+    combo_box = QComboBox(floating_dialog)
+    combo_box.addItems(["Item 1", "Item 2", "Item 3"])
+    floating_dialog.main_layout.addWidget(combo_box)
+
+    # Show under the cursor
+    floating_dialog.show_under_cursor()
+
+
+def show_splashscreen(time: float = 5.0):
+    """Show the splashscreen.
+
+    Args:
+        time (float): The time in seconds to show the splashscreen.
+    """
+
+    application = fxwidgets.VFXApplication()
+    splashscreen = fxwidgets.VFXSplashScreen(image_path=_pixmap, show_progress_bar=True, fade_in=False)
+    splashscreen.show()
+    splashscreen.progress_bar.setValue(75)
+    QTimer.singleShot(time * 1000, splashscreen.close)
+    QTimer.singleShot(time * 1000, application.quit)
+    application.exec_()
+
+
+def show_window():
+    """Show the window."""
+
+    # Initialize the QApplication
+    application = fxwidgets.VFXApplication()
+
+    # Replace default icons on the application
+    style = fxstyle.VFXProxyStyle()
+    application.setStyle(style)
+    window = fxwidgets.VFXWindow(ui_file=_ui_file)
+
+    # Buttons in `test.ui` example
+    window.ui.button_success.clicked.connect(
+        lambda: window.statusBar().showMessage("Success message", fxwidgets.SUCCESS)
+    )
+    window.ui.button_info.clicked.connect(
+        lambda: window.statusBar().showMessage("Info message", fxwidgets.INFO),
+    )
+    window.ui.button_warning.clicked.connect(
+        lambda: window.statusBar().showMessage("Warning message", fxwidgets.WARNING)
+    )
+    window.ui.button_error.clicked.connect(
+        lambda: window.statusBar().showMessage("Error message", fxwidgets.ERROR),
+    )
+    window.ui.button_critical.clicked.connect(
+        lambda: window.statusBar().showMessage("Critical message", fxwidgets.CRITICAL)
+    )
+
+    window.show()
+    application.exec_()
+
+
+def show_floating_dialogue():
+
+    dialogue = fxwidgets.VFXFloatingDialog(parent_package=fxdcc.STANDALONE)
+    dialogue.show_under_cursor()
+
+
+def main(show_delayed: bool = False):
+    """Main example function.
+
+    Args:
+        show_delayed (bool): Whether to show the window after 3 seconds or not.
+    """
+
+    # Initialize the QApplication
+    application = fxwidgets.VFXApplication()
+    application.setStyle(fxstyle.VFXProxyStyle())
+
+    # Initialize window now for splashscreen
+    window = fxwidgets.VFXWindow(ui_file=_ui_file, parent_package=fxdcc.STANDALONE)  # 4ab5cc
+    window.set_status_line_colors(color_a="#cc00cc", color_b="#4ab5cc")
+    application.processEvents()
+
+    # Splashscreen
+    splashscreen = fxwidgets.VFXSplashScreen(image_path=_pixmap, fade_in=False, show_progress_bar=True)
+    application.processEvents()
+
+    splashscreen.show()
+    application.processEvents()
+
+    # Fake loading process
+    for i in range(101):
+        splashscreen.progress_bar.setValue(i)
+        QTimer.singleShot(i, application.processEvents)
+
+    if show_delayed:
+        # Delay the call to splash.finish by 5 seconds
+        QTimer.singleShot(3 * 1000, lambda: splashscreen.finish(window))
+        application.processEvents()
+    else:
+        # Link the window loading to the splashcreen visibility
+        splashscreen.finish(window)
+        application.processEvents()
+
+    # Window
+    if show_delayed:
+        # Delay the call to _window.show by 3 seconds
+        QTimer.singleShot(3 * 1000 + 200, window.show)
+    else:
+        window.show()
+
+    window.statusBar().showMessage("Window initialized", fxwidgets.INFO)
+    window.hide_toolbar()
+
+    application.processEvents()
+
+    # Buttons in `test.ui` example
+    window.ui.button_success.clicked.connect(
+        lambda: window.statusBar().showMessage("Success message", fxwidgets.SUCCESS)
+    )
+    window.ui.button_info.clicked.connect(
+        lambda: window.statusBar().showMessage("Info message", fxwidgets.INFO),
+    )
+    window.ui.button_warning.clicked.connect(
+        lambda: window.statusBar().showMessage("Warning message", fxwidgets.WARNING)
+    )
+    window.ui.button_error.clicked.connect(
+        lambda: window.statusBar().showMessage("Error message", fxwidgets.ERROR),
+    )
+    window.ui.button_critical.clicked.connect(
+        lambda: window.statusBar().showMessage("Critical message", fxwidgets.CRITICAL)
+    )
+
+    fxutils.set_formatted_tooltip(window.ui.button_success, "Success", "This is a success message.")
+
+    # Refresh toolbar button
+    def refresh():
+        # Store original icon
+        original_icon = window.refresh_action.icon()
+
+        # Display statusbar message and change icon
+        window.set_statusbar_message("Refreshing...", fxwidgets.INFO)
+        ok_pixmap = QStyle.StandardPixmap.SP_DialogOkButton
+        ok_icon = window.style().standardIcon(ok_pixmap)
+        window.refresh_action.setIcon(ok_icon)
+
+        # Restore original icon after 2 seconds
+        def restore_icon():
+            window.refresh_action.setIcon(original_icon)
+            window.refresh_action.setEnabled(True)
+
+        QTimer.singleShot(1000, restore_icon)
+
+    window.refresh_action.triggered.connect(refresh)
+
+    application.exec_()
+
+
+if __name__ == "__main__":
+    main()

fxgui-2.1.0/fxgui/fxdcc.py

@@ -0,0 +1,100 @@
+"""Utility functions related to DCC packages."""
+
+# Built-in
+import shiboken2
+import importlib
+from typing import Optional, Any
+
+# Third-party
+from qtpy import QtWidgets
+
+# Metadata
+__author__ = "Valentin Beaumont"
+__email__ = "valentin.onze@gmail.com"
+
+
+###### CODE ####################################################################
+
+# Constants
+STANDALONE = 0
+HOUDINI = 1
+MAYA = 2
+NUKE = 3
+
+
+def get_dcc_main_window() -> Optional[Any]:
+    """Import the current DCC main window.
+
+    Returns:
+        Optional[Any]: The return value of the first successful function call, or `None` if no calls are successful.
+
+    Notes:
+        This function is DCC agnostic and will return the main window based on the success of the DCC module import.
+    """
+
+    dccs = [
+        ("maya.OpenMayaUI", get_maya_main_window),
+        ("nuke", get_nuke_main_window),
+        ("hou", get_houdini_main_window),
+    ]
+
+    for module_name, function in dccs:
+        try:
+            importlib.import_module(module_name)
+            return function()
+        except ImportError:
+            continue
+
+    return None
+
+
+def get_houdini_main_window() -> QtWidgets.QWidget:
+    """Get the Houdini main window.
+
+    Returns:
+        qtpy.QtWidgets.QWidget: `QWidget` Houdini main window.
+    """
+
+    import hou
+
+    return hou.qt.mainWindow()  # type:ignore
+
+
+def get_houdini_stylesheet() -> str:
+    """Get the Houdini stylesheet.
+
+    Returns:
+        str: The Houdini stylesheet.
+    """
+
+    import hou
+
+    return hou.qt.styleSheet()  # type:ignore
+
+
+def get_maya_main_window() -> QtWidgets.QWidget:
+    """Get the Maya main window.
+
+    Returns:
+        qtpy.QtWidgets.QWidget: `TmainWindow` Maya main window.
+    """
+
+    import maya.OpenMayaUI
+
+    window = apiUI.MQtUtil.mainWindow()  # type:ignore
+    if window is not None:
+        return shiboken2.wrapInstance(int(window), QtWidgets.QWidget)
+
+
+def get_nuke_main_window() -> QtWidgets.QMainWindow:
+    """Get the Nuke main window.
+
+    Returns:
+        qtpy.QtWidgets.QMainWindow: `DockMainWindow` Nuke main window.
+    """
+
+    import nuke
+
+    for widget in QtWidgets.QApplication.topLevelWidgets():
+        if widget.inherits("QMainWindow") and widget.metaObject().className() == "Foundry::UI::DockMainWindow":
+            return widget