vispy 0.15.0__cp313-cp313-win_amd64.whl

vispy/app/base.py

@@ -0,0 +1,294 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) Vispy Development Team. All Rights Reserved.
+# Distributed under the (new) BSD License. See LICENSE.txt for more info.
+
+from ..util import SimpleBunch
+import time
+from timeit import default_timer
+
+
+class BaseApplicationBackend(object):
+    """BaseApplicationBackend()
+
+    Abstract class that provides an interface between backends and Application.
+    Each backend must implement a subclass of ApplicationBackend, and
+    implement all its _vispy_xxx methods.
+    """
+
+    def _vispy_get_backend_name(self):
+        raise NotImplementedError()
+
+    def _vispy_process_events(self):
+        raise NotImplementedError()
+
+    def _vispy_run(self):
+        raise NotImplementedError()
+
+    def _vispy_reuse(self):
+        # Does nothing by default.
+        pass
+
+    def _vispy_quit(self):
+        raise NotImplementedError()
+
+    def _vispy_get_native_app(self):
+        # Should return the native application object
+        return self
+
+    # is called by inputhook.py for pauses
+    # to remove CPU stress
+    # this is virtual so that some backends which have specialize
+    # functionality to deal with user input / latency can use those methods
+    def _vispy_sleep(self, duration_sec):
+        time.sleep(duration_sec)
+
+
+class BaseCanvasBackend(object):
+    """BaseCanvasBackend(vispy_canvas, capability, context_type)
+
+    Abstract class that provides an interface between backends and Canvas.
+    Each backend must implement a subclass of CanvasBackend, and
+    implement all its _vispy_xxx methods. Also, a backend must
+    make sure to generate the following events: 'initialize', 'resize',
+    'draw', 'mouse_press', 'mouse_release', 'mouse_move',
+    'mouse_wheel', 'key_press', 'key_release'. When a backend detects
+    that the canvas should be closed, the backend should call
+    'self._vispy_canvas.close', because the close event is handled within
+    the canvas itself.
+    """
+
+    def __init__(self, vispy_canvas):
+        # Note: it is the responsibility of the subclass to call
+        # the __init__ of the mro - we don't call super().__init__() here.
+
+        from .canvas import Canvas  # Avoid circular import
+        assert isinstance(vispy_canvas, Canvas)
+        self._vispy_canvas = vispy_canvas
+        self._last_time = 0
+
+        # We set the _backend attribute of the vispy_canvas to self,
+        # because at the end of the __init__ of the CanvasBackend
+        # implementation there might be a call to show or draw. By
+        # setting it here, we ensure that the Canvas is "ready to go".
+        vispy_canvas._backend = self
+
+        # Data used in the construction of new mouse events
+        self._vispy_mouse_data = {
+            'buttons': [],
+            'press_event': None,
+            'last_event': None,
+            'last_mouse_press': None,
+        }
+
+    def _process_backend_kwargs(self, kwargs):
+        """Simple utility to retrieve kwargs in predetermined order.
+        Also checks whether the values of the backend arguments do not
+        violate the backend capabilities.
+        """
+        # Verify given argument with capability of the backend
+        app = self._vispy_canvas.app
+        capability = app.backend_module.capability
+        if kwargs['context'].shared.name:  # name already assigned: shared
+            if not capability['context']:
+                raise RuntimeError('Cannot share context with this backend')
+        for key in [key for (key, val) in capability.items() if not val]:
+            if key in ['context', 'multi_window', 'scroll']:
+                continue
+            invert = key in ['resizable', 'decorate']
+            if bool(kwargs[key]) - invert:
+                raise RuntimeError('Config %s is not supported by backend %s'
+                                   % (key, app.backend_name))
+
+        # Return items in sequence
+        out = SimpleBunch()
+        keys = ['title', 'size', 'position', 'show', 'vsync', 'resizable',
+                'decorate', 'fullscreen', 'parent', 'context', 'always_on_top',
+                ]
+        for key in keys:
+            out[key] = kwargs[key]
+        return out
+
+    def _vispy_set_current(self):
+        # Make this the current context
+        raise NotImplementedError()
+
+    def _vispy_swap_buffers(self):
+        # Swap front and back buffer
+        raise NotImplementedError()
+
+    def _vispy_set_title(self, title):
+        # Set the window title. Has no effect for widgets
+        raise NotImplementedError()
+
+    def _vispy_set_size(self, w, h):
+        # Set size of the widget or window
+        raise NotImplementedError()
+
+    def _vispy_set_position(self, x, y):
+        # Set location of the widget or window. May have no effect for widgets
+        raise NotImplementedError()
+
+    def _vispy_set_visible(self, visible):
+        # Show or hide the window or widget
+        raise NotImplementedError()
+
+    def _vispy_set_fullscreen(self, fullscreen):
+        # Set fullscreen mode
+        raise NotImplementedError()
+
+    def _vispy_update(self):
+        # Invoke a redraw
+        raise NotImplementedError()
+
+    def _vispy_close(self):
+        # Force the window or widget to shut down
+        raise NotImplementedError()
+
+    def _vispy_get_size(self):
+        # Should return widget size
+        raise NotImplementedError()
+
+    def _vispy_get_physical_size(self):
+        # Should return physical widget size (actual number of screen pixels).
+        # This may differ from _vispy_get_size on backends that expose HiDPI
+        # screens. If not overriden, return the logical sizeself.
+        return self._vispy_get_size()
+
+    def _vispy_get_position(self):
+        # Should return widget position
+        raise NotImplementedError()
+
+    def _vispy_get_fullscreen(self):
+        # Should return bool for fullscreen status
+        raise NotImplementedError()
+
+    def _vispy_get_geometry(self):
+        # Should return widget (x, y, w, h)
+        x, y = self._vispy_get_position()
+        w, h = self._vispy_get_size()
+        return x, y, w, h
+
+    def _vispy_get_native_canvas(self):
+        # Should return the native widget object
+        # Most backends would not need to implement this
+        return self
+
+    def _vispy_get_fb_bind_location(self):
+        # Should return the default FrameBuffer bind location
+        # Most backends would not need to implement this
+        return 0
+
+    def _vispy_mouse_press(self, **kwargs):
+        # default method for delivering mouse press events to the canvas
+        kwargs.update(self._vispy_mouse_data)
+        ev = self._vispy_canvas.events.mouse_press(**kwargs)
+        if self._vispy_mouse_data['press_event'] is None:
+            self._vispy_mouse_data['press_event'] = ev
+
+        self._vispy_mouse_data['buttons'].append(ev.button)
+        self._vispy_mouse_data['last_event'] = ev
+
+        if not getattr(self, '_double_click_supported', False):
+            # double-click events are not supported by this backend, so we
+            # detect them manually
+            self._vispy_detect_double_click(ev)
+
+        return ev
+
+    def _vispy_mouse_move(self, **kwargs):
+        if default_timer() - self._last_time < .01:
+            return
+        self._last_time = default_timer()
+
+        # default method for delivering mouse move events to the canvas
+        kwargs.update(self._vispy_mouse_data)
+
+        # Break the chain of prior mouse events if no buttons are pressed
+        # (this means that during a mouse drag, we have full access to every
+        # move event generated since the drag started)
+        if self._vispy_mouse_data['press_event'] is None:
+            last_event = self._vispy_mouse_data['last_event']
+            if last_event is not None:
+                last_event._forget_last_event()
+        else:
+            kwargs['button'] = self._vispy_mouse_data['press_event'].button
+
+        ev = self._vispy_canvas.events.mouse_move(**kwargs)
+        self._vispy_mouse_data['last_event'] = ev
+        return ev
+
+    def _vispy_mouse_release(self, **kwargs):
+        # default method for delivering mouse release events to the canvas
+        kwargs.update(self._vispy_mouse_data)
+
+        ev = self._vispy_canvas.events.mouse_release(**kwargs)
+        if (self._vispy_mouse_data['press_event']
+                and self._vispy_mouse_data['press_event'].button == ev.button):
+            self._vispy_mouse_data['press_event'] = None
+
+        if ev.button in self._vispy_mouse_data['buttons']:
+            self._vispy_mouse_data['buttons'].remove(ev.button)
+        self._vispy_mouse_data['last_event'] = ev
+
+        return ev
+
+    def _vispy_mouse_double_click(self, **kwargs):
+        # default method for delivering double-click events to the canvas
+        kwargs.update(self._vispy_mouse_data)
+
+        ev = self._vispy_canvas.events.mouse_double_click(**kwargs)
+        self._vispy_mouse_data['last_event'] = ev
+        return ev
+
+    def _vispy_detect_double_click(self, ev, **kwargs):
+        # Called on every mouse_press or mouse_release, and calls
+        # _vispy_mouse_double_click if a double-click is calculated.
+        # Should be overridden with an empty function on backends which
+        # natively support double-clicking.
+
+        dt_max = 0.3  # time in seconds for a double-click detection
+
+        lastev = self._vispy_mouse_data['last_mouse_press']
+
+        if lastev is None:
+            self._vispy_mouse_data['last_mouse_press'] = ev
+            return
+
+        assert lastev.type == 'mouse_press'
+        assert ev.type == 'mouse_press'
+
+        # For a double-click to be detected, the button should be the same,
+        # the position should be the same, and the two mouse-presses should
+        # be within dt_max.
+        if ((ev.time - lastev.time <= dt_max) &
+            (lastev.pos[0] - ev.pos[0] == 0) &
+            (lastev.pos[1] - ev.pos[1] == 0) &
+                (lastev.button == ev.button)):
+            self._vispy_mouse_double_click(**kwargs)
+
+        self._vispy_mouse_data['last_mouse_press'] = ev
+
+
+class BaseTimerBackend(object):
+    """BaseTimerBackend(vispy_timer)
+
+    Abstract class that provides an interface between backends and Timer.
+    Each backend must implement a subclass of TimerBackend, and
+    implement all its _vispy_xxx methods.
+    """
+
+    def __init__(self, vispy_timer):
+        # Note: it is the responsibility of the subclass to call
+        # the __init__ of the mro - we don't call super().__init__() here.
+        self._vispy_timer = vispy_timer
+
+    def _vispy_start(self, interval):
+        raise NotImplementedError
+
+    def _vispy_stop(self):
+        raise NotImplementedError
+
+    def _vispy_get_native_timer(self):
+        # Should return the native timer object
+        # Most backends would not need to implement this
+        return self