zooui.objects.scene.qzui module

QWidget for displaying the ZUI.

class zooui.objects.scene.qzui.QZUI(parent=None, framerate=20, zoom_sensitivity=50, config=None, autosave_config=None)

Bases: QWidget

Constructor :

QZUI(parent, framerate, zoom_sensitivity)

Parameters :

parent : Optional[QtWidgets.QWidget] framerate : int zoom_sensitivity : int

QZUI(parent, framerate, zoom_sensitivity) –> None

QZUI widgets that are used for rendering the ZUI. This class defines all the methods to retrieve events, Mouse, Keyboard, etc.

Constructor :

QZUI(parent, framerate, zoom_sensitivity, config, autosave_config)

Parameters :

parent : Optional[QtWidgets.QWidget] framerate : int zoom_sensitivity : int config : Optional[Dict[str, Any]] autosave_config : Optional[Dict[str, Any]]

QZUI(parent, framerate, zoom_sensitivity, config, autosave_config) –> None

Create a new QZUI QWidget with the given parent widget. Initializes the widget with specified framerate and zoom sensitivity.

error

link error variable to QtCore.Signal()

ocr_region_selected

OCR region selected signal, emitted with the captured QImage

set_ocr_mode(enabled)

is_ocr_mode()

_do_ocr_capture(x1, y1, x2, y2)

__zoom(num_steps)

Method :

__zoom(num_steps)

Parameters :

num_steps : float

__zoom(num_steps) –> None

Increase the z velocity of the appropriate object by an amount proportional to num_steps.

__centre()

Method :

__centre()

Parameters :

None

__centre() –> None

Aim the appropriate object such that the point under the cursor will move to the centre of the screen.

set_home_point()

Method :

set_home_point()

Parameters :

None

set_home_point() –> None

Save the current view position and zoom level as the home point.

go_to_home_point()

Method :

go_to_home_point()

Parameters :

None

go_to_home_point() –> None

Restore the view to the saved home point position and zoom level.

paintEvent(event)

Method :

paintEvent(event)

Parameters :

event : QtGui.QPaintEvent

paintEvent(event) –> None

Method that allows you to perform custom painting on a widget.

It is part of the event handling system, and you typically override it in a subclass of a QWidget (or any subclass like QLabel, QFrame, etc.) to draw graphics using the QPainter class.

timerEvent(event)

Method :

timerEvent(event)

Parameters :

event : QtCore.QTimerEvent

timerEvent(event) –> None

Handle timer events to update the scene rendering.

wheelEvent(event)

Method :

wheelEvent(event)

Parameters :

event : QtGui.QWheelEvent

wheelEvent(event) –> None

Handle mouse wheel events for zooming or shape elongation.

Arrow elongation: Ctrl+wheel on selected arrow SVG Square elongation: Ctrl/Shift/Alt+wheel on selected square SVG 720° scroll = 2x factor change (1° = 1/360 factor change)

mousePressEvent(event)

Method :

mousePressEvent(event)

Parameters :

event : QtGui.QMouseEvent

mousePressEvent(event) –> None

Handle mouse press events for object selection.

mouseMoveEvent(event)

Method :

mouseMoveEvent(event)

Parameters :

event : QtGui.QMouseEvent

mouseMoveEvent(event) –> None

Handle mouse move events for dragging objects.

mouseReleaseEvent(event)

Method :

mouseReleaseEvent(event)

Parameters :

event : QtGui.QMouseEvent

mouseReleaseEvent(event) –> None

Handle mouse release events.

keyPressEvent(event)

Method :

keyPressEvent(event)

Parameters :

event : QtGui.QKeyEvent

keyPressEvent(event) –> None

Handle key press events for navigation and control.

keyReleaseEvent(event)

Method :

keyReleaseEvent(event)

Parameters :

event : QtGui.QKeyEvent

keyReleaseEvent(event) –> None

Handle key release events.

_dispatch_pdf_page_nav(key, modifiers)

Dispatch page navigation keys to the active PdfMediaObject, if any.

resizeEvent(event)

Method :

resizeEvent(event)

Parameters :

event : QtGui.QResizeEvent

resizeEvent(event) –> None

Handle resize events to update the viewport size.

_run_pending_animation()

Run the deferred zoom-in animation once the widget is sized.

focusOutEvent(event)

Method :

focusOutEvent(event)

Parameters :

event : QtGui.QFocusEvent

focusOutEvent(event) –> None

Handle focus out events to reset keyboard modifiers and rectangle drawing state. This prevents rectangle drawing from persisting when widget loses focus (e.g., during save dialog).

property __active_object

Property:

__active_object

Parameters :

None

__active_object –> Any

Return the currently active object (either selected object or scene).

__get_framerate()

Method :

__get_framerate()

Parameters :

None

__get_framerate() –> int

Return the rendering framerate.

__set_framerate(framerate)

Method :

__set_framerate(framerate)

Parameters :

framerate : int

__set_framerate(framerate) –> None

Set the rendering framerate.

property framerate

Method:

__get_framerate()

Parameters :

None

__get_framerate() –> int

Return the rendering framerate.

__get_scene()

Method :

__get_scene()

Parameters :

None

__get_scene() –> Scene.Scene

Return the scene currently being viewed.

__set_scene(scene)

Method :

__set_scene(scene)

Parameters :

scene : Scene.Scene

__set_scene(scene) –> None

Set the scene to be viewed.

property scene

Method:

__get_scene()

Parameters :

None

__get_scene() –> Scene.Scene

Return the scene currently being viewed.

staticMetaObject = PySide6.QtCore.QMetaObject("QZUI" inherits "QWidget": Methods:   #33 type=Signal, signature=error(QString), parameters=QString   #34 type=Signal, signature=ocr_region_selected(QImage), parameters=QImage )