utils ¶

def add_shortcut(
    self,
    name_or_key: Any,
    parent_or_handler: Any,
    /,
    handler: Callable[[], None] | str = "",
    key: QKeySequence | None = None,
    description: str | None = None
) -> None:
    if isinstance(name_or_key, str) and isinstance(parent_or_handler, (QObject | str)):
        name, parent, handler = name_or_key, parent_or_handler, handler
    else:
        name, parent, = f"shortcut_{self.__legacy_counter_shortcuts}", cast(QObject, self), 
        handler, key = parent_or_handler, QKeySequence(name_or_key)
        description = f"Shortcut {self.__legacy_counter_shortcuts}"
        self.__legacy_counter_shortcuts += 1

    self.shortcuts.append(PluginShortcut(name, parent, handler, key, description))

def add_shortcuts(self) -> None:
    ...

def first_load(self) -> bool:
    if not self._first_load_done:
        self.setup_ui()

        self.setup_shortcuts()

        self.set_qobject_names()

        self.on_first_load.emit()  # type: ignore

        self._first_load_done = True

        return True

    return False

def get_node(self, node: vs.VideoNode) -> vs.VideoNode | VideoOutputNode:
    raise NotImplementedError

def get_notches(self) -> Notches:
    from .custom import Notches
    return Notches()

def get_separator(self, horizontal: bool = False) -> QFrame:
    separator = QFrame(self)
    separator.setFrameShape(QFrame.Shape.HLine if horizontal else QFrame.Shape.VLine)
    separator.setFrameShadow(QFrame.Shadow.Sunken)
    return separator

def init_notches(self, main: MainWindow = ...) -> None:
    self.notches_changed.connect(main.timeline.update_notches)

def init_outputs(self) -> None:
    assert self.main.outputs

    self.outputs.clear()

def on_current_frame_changed(self, frame: Frame) -> None:
    raise NotImplementedError

def on_current_output_changed(self, index: int, prev_index: int) -> None:
    ...

def reset(self) -> None:
    self.init_outputs()

    self.on_current_frame_changed(self.main.current_output.last_showed_frame)

def set_qobject_names(self) -> None:
    if not hasattr(self, '__slots__'):
        return

    slots = list(self.__slots__)

    if isinstance(self, AbstractToolbar) and 'main' in slots:
        slots.remove('main')

    for attr_name in slots:
        attr = getattr(self, attr_name)
        if not isinstance(attr, QObject):
            continue
        attr.setObjectName(type(self).__name__ + '.' + attr_name)

def setup_shortcuts(self) -> None:
    self.main.shortcuts.sections_plugins[self._config.namespace].setup_shortcuts()

def setup_ui(self) -> None:
    self.vlayout = VBoxLayout(self)
    self.hlayout = HBoxLayout(self.vlayout)

def add_shortcut(
    self,
    name_or_key: Any,
    parent_or_handler: Any,
    /,
    handler: Callable[[], None] | str = "",
    key: QKeySequence | None = None,
    description: str | None = None
) -> None:
    if isinstance(name_or_key, str) and isinstance(parent_or_handler, (QObject | str)):
        name, parent, handler = name_or_key, parent_or_handler, handler
    else:
        name, parent, = f"shortcut_{self.__legacy_counter_shortcuts}", cast(QObject, self), 
        handler, key = parent_or_handler, QKeySequence(name_or_key)
        description = f"Shortcut {self.__legacy_counter_shortcuts}"
        self.__legacy_counter_shortcuts += 1

    self.shortcuts.append(PluginShortcut(name, parent, handler, key, description))

def add_shortcuts(self) -> None:
    ...

def afterReload(self) -> None:
    self.underReload = False
    self.verticalScrollBar().setValue(self.last_positions[0])
    self.horizontalScrollBar().setValue(self.last_positions[1])
    self.setTransformationAnchor(QGraphicsView.ViewportAnchor.AnchorUnderMouse)

def auto_fit_button_clicked(self, checked: bool) -> None:
    self.autofit = checked

def beforeReload(self) -> None:
    self.underReload = True
    self.setTransformationAnchor(QGraphicsView.ViewportAnchor.AnchorViewCenter)
    self.last_positions = (self.verticalScrollBar().value(), self.horizontalScrollBar().value())

def bind_to(self, other_view: GraphicsView, *, mutual: bool = True) -> None:
    self.main.bound_graphics_views[other_view].add(self)

    if mutual:
        self.main.bound_graphics_views[self].add(other_view)

def event(self, event: QEvent) -> bool:
    if self.underReload:
        event.ignore()
        return False

    if isinstance(event, QNativeGestureEvent):
        typ = event.gestureType()
        if typ == Qt.NativeGestureType.BeginNativeGesture:
            self.zoomValue = 0.0
        elif typ == Qt.NativeGestureType.ZoomNativeGesture:
            self.zoomValue += event.value()
        if typ == Qt.NativeGestureType.EndNativeGesture:
            self.wheelScrolled.emit(-1 if self.zoomValue < 0 else 1)

    return super().event(event)

def first_load(self) -> bool:
    if not self._first_load_done:
        self.setup_ui()

        self.setup_shortcuts()

        self.set_qobject_names()

        self.on_first_load.emit()  # type: ignore

        self._first_load_done = True

        return True

    return False

def get_node(self, node: vs.VideoNode) -> vs.VideoNode | VideoOutputNode:
    raise NotImplementedError

def get_notches(self) -> Notches:
    from .custom import Notches
    return Notches()

def get_separator(self, horizontal: bool = False) -> QFrame:
    separator = QFrame(self)
    separator.setFrameShape(QFrame.Shape.HLine if horizontal else QFrame.Shape.VLine)
    separator.setFrameShadow(QFrame.Shadow.Sunken)
    return separator

def init_notches(self, main: MainWindow = ...) -> None:
    self.notches_changed.connect(main.timeline.update_notches)

def init_outputs(self) -> None:
    assert self.main.outputs

    self.outputs.clear()

def mouseMoveEvent(self, event: QMouseEvent) -> None:
    if self.underReload or self.autofit:
        return event.ignore()

    super().mouseMoveEvent(event)

    if self.hasMouseTracking():
        self.mouseMoved.emit(event)

    self.dragEvent.emit(DragEventType.move)

def mousePressEvent(self, event: QMouseEvent) -> None:
    if self.underReload or self.autofit:
        return event.ignore()

    if event.button() == Qt.MouseButton.LeftButton:
        self.drag_mode = self.dragMode()
        self.setDragMode(QGraphicsView.DragMode.ScrollHandDrag)

    super().mousePressEvent(event)

    self.mousePressed.emit(event)
    self.dragEvent.emit(DragEventType.start)

def mouseReleaseEvent(self, event: QMouseEvent) -> None:
    if self.underReload or self.autofit:
        return event.ignore()

    super().mouseReleaseEvent(event)

    if event.button() == Qt.MouseButton.LeftButton:
        self.setDragMode(self.drag_mode)

    self.mouseReleased.emit(event)
    self.dragEvent.emit(DragEventType.stop)

def on_current_frame_changed(self, frame: Frame) -> None:
    self.outputs.current.render_frame(frame, None, None, self.current_scene)

def on_current_output_changed(self, index: int, prev_index: int) -> None:
    ...

def on_wheel_scrolled(self, steps: int) -> None:
    new_index = self.zoom_combobox.currentIndex() + steps

    if new_index < 0:
        new_index = 0
    elif new_index >= len(self.main.settings.zoom_levels):
        new_index = len(self.main.settings.zoom_levels) - 1

    self.zoom_combobox.setCurrentIndex(new_index)

def propagate_move_event(self, _: Any = None) -> None:
    scrollbarW, scrollbarH = self.horizontalScrollBar(), self.verticalScrollBar()

    if not any({scrollbarW.isVisible(), scrollbarH.isVisible()}):
        return

    widthMax, heightMax = scrollbarW.maximum(), scrollbarH.maximum()

    for view in self.main.bound_graphics_views[self] - {self}:
        if view.isVisible():
            wBar, hBar = view.horizontalScrollBar(), view.verticalScrollBar()

            if widthMax:
                wBar.setValue(int(scrollbarW.value() * wBar.maximum() / widthMax))

            if heightMax:
                hBar.setValue(int(scrollbarH.value() * hBar.maximum() / heightMax))

def reset(self) -> None:
    self.init_outputs()

    self.on_current_frame_changed(self.main.current_output.last_showed_frame)

def resizeEvent(self, event: QResizeEvent) -> None:
    super().resizeEvent(event)
    self.setZoom(None)

def setZoom(self, value: float | None) -> None:
    for view in self.main.bound_graphics_views[self]:
        view._setZoom(value)

def set_qobject_names(self) -> None:
    if not hasattr(self, '__slots__'):
        return

    slots = list(self.__slots__)

    if isinstance(self, AbstractToolbar) and 'main' in slots:
        slots.remove('main')

    for attr_name in slots:
        attr = getattr(self, attr_name)
        if not isinstance(attr, QObject):
            continue
        attr.setObjectName(type(self).__name__ + '.' + attr_name)

def setup_shortcuts(self) -> None:
    self.main.shortcuts.sections_plugins[self._config.namespace].setup_shortcuts()

def setup_ui(self) -> None:
    self.vlayout = VBoxLayout(self)
    self.hlayout = HBoxLayout(self.vlayout)

def setup_view(self) -> None:
    for item in self.graphics_scene.graphics_items:
        item.hide()

    self.current_scene.show()
    self.graphics_scene.setSceneRect(QRectF(self.current_scene.pixmap().rect()))

def wheelEvent(self, event: QWheelEvent) -> None:
    if self.underReload or self.autofit:
        return event.ignore()

    assert self.app

    modifier = event.modifiers()
    mouse = event.buttons()

    self.propagate_move_event()

    if modifier == Qt.KeyboardModifier.ControlModifier or mouse in {
        Qt.MouseButton.RightButton, Qt.MouseButton.MiddleButton
    }:
        angleDelta = event.angleDelta().y()

        # check if wheel wasn't rotated the other way since last rotation
        if self.angleRemainder * angleDelta < 0:
            self.angleRemainder = 0

        self.angleRemainder += angleDelta

        if abs(self.angleRemainder) >= self.WHEEL_STEP:
            self.wheelScrolled.emit(self.angleRemainder // self.WHEEL_STEP)
            self.angleRemainder %= self.WHEEL_STEP
        return
    elif modifier == Qt.KeyboardModifier.NoModifier:
        self.verticalScrollBar().setValue(self.verticalScrollBar().value() - event.angleDelta().y())
        self.horizontalScrollBar().setValue(self.horizontalScrollBar().value() - event.angleDelta().x())
        return
    elif modifier == Qt.KeyboardModifier.ShiftModifier:
        self.verticalScrollBar().setValue(self.verticalScrollBar().value() - event.angleDelta().x())
        self.horizontalScrollBar().setValue(self.horizontalScrollBar().value() - event.angleDelta().y())
        return

    event.ignore()

def afterReload(self) -> None:
    self.underReload = False
    self.verticalScrollBar().setValue(self.last_positions[0])
    self.horizontalScrollBar().setValue(self.last_positions[1])
    self.setTransformationAnchor(QGraphicsView.ViewportAnchor.AnchorUnderMouse)

def auto_fit_button_clicked(self, checked: bool) -> None:
    self.autofit = checked

def beforeReload(self) -> None:
    self.underReload = True
    self.setTransformationAnchor(QGraphicsView.ViewportAnchor.AnchorViewCenter)
    self.last_positions = (self.verticalScrollBar().value(), self.horizontalScrollBar().value())

def bind_to(self, other_view: GraphicsView, *, mutual: bool = True) -> None:
    self.main.bound_graphics_views[other_view].add(self)

    if mutual:
        self.main.bound_graphics_views[self].add(other_view)

def event(self, event: QEvent) -> bool:
    if self.underReload:
        event.ignore()
        return False

    if isinstance(event, QNativeGestureEvent):
        typ = event.gestureType()
        if typ == Qt.NativeGestureType.BeginNativeGesture:
            self.zoomValue = 0.0
        elif typ == Qt.NativeGestureType.ZoomNativeGesture:
            self.zoomValue += event.value()
        if typ == Qt.NativeGestureType.EndNativeGesture:
            self.wheelScrolled.emit(-1 if self.zoomValue < 0 else 1)

    return super().event(event)

def first_load(self) -> None:
    self.graphics_scene.init_scenes()
    self.setup_view()

def mouseMoveEvent(self, event: QMouseEvent) -> None:
    if self.underReload or self.autofit:
        return event.ignore()

    super().mouseMoveEvent(event)

    if self.hasMouseTracking():
        self.mouseMoved.emit(event)

    self.dragEvent.emit(DragEventType.move)

def mousePressEvent(self, event: QMouseEvent) -> None:
    if self.underReload or self.autofit:
        return event.ignore()

    if event.button() == Qt.MouseButton.LeftButton:
        self.drag_mode = self.dragMode()
        self.setDragMode(QGraphicsView.DragMode.ScrollHandDrag)

    super().mousePressEvent(event)

    self.mousePressed.emit(event)
    self.dragEvent.emit(DragEventType.start)

def mouseReleaseEvent(self, event: QMouseEvent) -> None:
    if self.underReload or self.autofit:
        return event.ignore()

    super().mouseReleaseEvent(event)

    if event.button() == Qt.MouseButton.LeftButton:
        self.setDragMode(self.drag_mode)

    self.mouseReleased.emit(event)
    self.dragEvent.emit(DragEventType.stop)

def on_wheel_scrolled(self, steps: int) -> None:
    new_index = self.zoom_combobox.currentIndex() + steps

    if new_index < 0:
        new_index = 0
    elif new_index >= len(self.main.settings.zoom_levels):
        new_index = len(self.main.settings.zoom_levels) - 1

    self.zoom_combobox.setCurrentIndex(new_index)

def propagate_move_event(self, _: Any = None) -> None:
    scrollbarW, scrollbarH = self.horizontalScrollBar(), self.verticalScrollBar()

    if not any({scrollbarW.isVisible(), scrollbarH.isVisible()}):
        return

    widthMax, heightMax = scrollbarW.maximum(), scrollbarH.maximum()

    for view in self.main.bound_graphics_views[self] - {self}:
        if view.isVisible():
            wBar, hBar = view.horizontalScrollBar(), view.verticalScrollBar()

            if widthMax:
                wBar.setValue(int(scrollbarW.value() * wBar.maximum() / widthMax))

            if heightMax:
                hBar.setValue(int(scrollbarH.value() * hBar.maximum() / heightMax))

def resizeEvent(self, event: QResizeEvent) -> None:
    super().resizeEvent(event)
    self.setZoom(None)