Nexus/2023/scripts/animation_tools/studiolibrary/studioqt/utils.py

# Copyright 2020 by Kurt Rathjen. All Rights Reserved.
#
# This library is free software: you can redistribute it and/or modify it 
# under the terms of the GNU Lesser General Public License as published by 
# the Free Software Foundation, either version 3 of the License, or 
# (at your option) any later version. This library is distributed in the 
# hope that it will be useful, but WITHOUT ANY WARRANTY; without even the 
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
# See the GNU Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public
# License along with this library. If not, see <http://www.gnu.org/licenses/>.

import os
import sys
import inspect
import logging
import contextlib

from studiovendor.Qt import QtGui
from studiovendor.Qt import QtCore
from studiovendor.Qt import QtCompat
from studiovendor.Qt import QtWidgets

import studioqt


__all__ = [
    "app",
    "fadeIn",
    "fadeOut",
    "loadUi",
    "installFonts",
    "isAltModifier",
    "isShiftModifier",
    "isControlModifier",
]

logger = logging.getLogger(__name__)


@contextlib.contextmanager
def app():
    """
    
    .. code-block:: python
        import studioqt

        with studioqt.app():
            widget = QWidget(None)
            widget.show()

    :rtype: None
    """
    app_ = None

    isAppRunning = bool(QtWidgets.QApplication.instance())
    if not isAppRunning:
        app_ = QtWidgets.QApplication(sys.argv)

    yield None

    if not isAppRunning:
        sys.exit(app_.exec_())


def uiPath(cls):
    """
    Return the ui path for the given widget class.
    
    :type cls: type
    :rtype: str
    """
    name = cls.__name__
    path = inspect.getfile(cls)
    dirname = os.path.dirname(path)

    path = dirname + "/resource/ui/" + name + ".ui"

    if not os.path.exists(path):
        path = dirname + "/ui/" + name + ".ui"

    if not os.path.exists(path):
        path = dirname + "/" + name + ".ui"

    return path


def loadUi(widget, path=None, cls=None):
    """
    .. code-block:: python
        import studioqt

        class Widget(QtWidgets.QWidget):
            def __init__(self)
                super(Widget, self).__init__()
                studioqt.loadUi(self)

        with studioqt.app():
            widget = Widget()
            widget.show()

    :type widget: QWidget or QDialog
    :type path: str
    :type cls: object
    :rtype: None
    """
    if cls:
        path = uiPath(cls)
    elif not path:
        path = uiPath(widget.__class__)

    cwd = os.getcwd()
    try:
        os.chdir(os.path.dirname(path))
        widget.ui = QtCompat.loadUi(path, widget)
    finally:
        os.chdir(cwd)


def isModifier():
    """
    Return True if either the alt key or control key is down.
    
    :rtype: bool 
    """
    return isAltModifier() or isControlModifier()


def isAltModifier():
    """
    Return True if the alt key is down.

    :rtype: bool
    """
    modifiers = QtWidgets.QApplication.keyboardModifiers()
    return modifiers == QtCore.Qt.AltModifier


def isControlModifier():
    """
    Return True if the control key is down.
    
    :rtype: bool
    """
    modifiers = QtWidgets.QApplication.keyboardModifiers()
    return modifiers == QtCore.Qt.ControlModifier


def isShiftModifier():
    """
    Return True if the shift key is down.

    :rtype: bool
    """
    modifiers = QtWidgets.QApplication.keyboardModifiers()
    return modifiers == QtCore.Qt.ShiftModifier


def fadeIn(widget, duration=200, onFinished=None):
    """
    Fade in the given widget using the opacity effect.

    :type widget: QtWidget.QWidgets
    :type duration: int 
    :type onFinished: func
    :rtype: QtCore.QPropertyAnimation 
    """
    widget._fadeInEffect_ = QtWidgets.QGraphicsOpacityEffect()
    widget.setGraphicsEffect(widget._fadeInEffect_)
    animation = QtCore.QPropertyAnimation(widget._fadeInEffect_, b"opacity")
    animation.setDuration(duration)
    animation.setStartValue(0.0)
    animation.setEndValue(1.0)
    animation.setEasingCurve(QtCore.QEasingCurve.InOutCubic)
    animation.start()

    if onFinished:
        animation.finished.connect(onFinished)

    widget._fadeIn_ = animation

    return animation


def fadeOut(widget, duration=200, onFinished=None):
    """
    Fade out the given widget using the opacity effect.
    
    :type widget: QtWidget.QWidgets
    :type duration: int
    :type onFinished: func
    :rtype: QtCore.QPropertyAnimation 
    """
    widget._fadeOutEffect_ = QtWidgets.QGraphicsOpacityEffect()
    widget.setGraphicsEffect(widget._fadeOutEffect_)
    animation = QtCore.QPropertyAnimation(widget._fadeOutEffect_, b"opacity")
    animation.setDuration(duration)
    animation.setStartValue(1.0)
    animation.setEndValue(0.0)
    animation.setEasingCurve(QtCore.QEasingCurve.InOutCubic)
    animation.start()

    if onFinished:
        animation.finished.connect(onFinished)

    widget._fadeOut_ = animation

    return animation


def installFonts(path):
    """
    Install all the fonts in the given directory path.
    
    :type path: str
    """
    path = os.path.abspath(path)
    fontDatabase = QtGui.QFontDatabase()

    for filename in os.listdir(path):

        if filename.endswith(".ttf"):

            filename = os.path.join(path, filename)
            result = fontDatabase.addApplicationFont(filename)

            if result > 0:
                logger.debug("Added font %s", filename)
            else:
                logger.debug("Cannot add font %s", filename)