events.py

- Bug Fix in events.py
- Deprecated event.change

Mouse Events are integarted using the existing events system

Author: tushar5526

p5/sketch/Skia2DRenderer/base.py

@@ -1,12 +1,13 @@
 import builtins
+from calendar import c
 from p5.core import p5
 
 import contextlib, glfw, skia
 from OpenGL import GL
 from time import time
 
 from ..events import handler_names
-from .handlers import mouse_callback_handler
+from .handlers import *
 
 
 def _dummy(*args, **kwargs):
@@ -57,6 +58,9 @@ def __init__(self, setup_method, draw_method, handlers=dict(), frame_rate=60):
             self.handlers[handler_name] = handlers.get(handler_name, _dummy)
 
         self.handler_queue = []
+        
+        # Modifiers used for managing the Input system
+        self.modifiers = list()
 
     @property
     def size(self):
@@ -126,6 +130,10 @@ def main_loop(self):
                 if self.redraw:
                     self.redraw = False
             self.poll_events()
+            while len(self.handler_queue) != 0:
+                function, event = self.handler_queue.pop(0)
+                event._update_builtins()
+                function(event)
 
     def start(self):
         self.window = self.glfw_window()
@@ -161,10 +169,15 @@ def poll_events(self):
 
     # Callbacks and handlers
     def assign_callbacks(self):
-        glfw.set_cursor_pos_callback(self.window, mouse_callback_handler)
         glfw.set_framebuffer_size_callback(self.window, self.frame_buffer_resize_callback_handler)
-        glfw.set_mouse_button_callback(self.window, self.mouse_button_callback_handler)
-
+        
+        glfw.set_key_callback(self.window, on_key_press)
+        glfw.set_char_callback(self.window, on_key_char)
+        glfw.set_mouse_button_callback(self.window, on_mouse_button)
+        glfw.set_scroll_callback(self.window, on_mouse_scroll)
+        glfw.set_cursor_pos_callback(self.window, on_mouse_motion)
+        glfw.set_window_close_callback(self.window, on_close)
+        
 
 
     def frame_buffer_resize_callback_handler(self, window, width, height):
@@ -187,22 +200,9 @@ def frame_buffer_resize_callback_handler(self, window, width, height):
         # Tell the program, we have resized the frame buffer
         # Restart the rendering again
         self.resized = True
-
-    # For testing will be removed later
-    def mouse_button_callback_handler(self, window, button, action, mods):
-        # If a mouse button is pressed
-        if action == glfw.PRESS:
-
-            # Changing the values manually, at the end we will have an event handler
-            # similar to vispy
-            if button == glfw.MOUSE_BUTTON_LEFT:
-                self.redraw = True
-            if button == glfw.MOUSE_BUTTON_RIGHT:
-                self.looping = True
-
-        # If a mouse button is released
-        if action == glfw.RELEASE:
-            # set environment variables
-            pass
+    
+    def _enqueue_event(self, handler_name, event):
+        event._update_builtins()
+        self.handler_queue.append((self.handlers[handler_name], event))
 
 

p5/sketch/Skia2DRenderer/handlers.py

@@ -1,4 +1,8 @@
 import builtins
+from os import environ
+import glfw
+from p5.core import p5
+from p5.sketch.events import MouseEvent
 
 """
 This file contains the handlers needed for glfw event handling
@@ -7,10 +11,57 @@
 # TODO : Make a raw_event class and populate it with data about current events
 # TODO : Design of raw_event should follow that of Vispy's raw event beacuse events.py is highly based on it  
 
-def mouse_callback_handler(window, xpos, ypos):
-    builtins.mouse_x = xpos
-    builtins.mouse_y = ypos
+BUTTONMAP = {glfw.MOUSE_BUTTON_LEFT: 1,
+                glfw.MOUSE_BUTTON_RIGHT: 2,
+                glfw.MOUSE_BUTTON_MIDDLE: 3
+                }
+
+class PseudoMouseEvent:
+    """
+    This class is a helper class to reuse the events module which is very Vispy oriented
+    """
+    def __init__(self, pos, delta, modifiers, button, buttons):
+        """Initialize the pseduoMouseEventClass to work with exisiting event system
+
+        Args:
+            pos (tuple): Position of the cursor
+            delta (tuple): Change in position of the cursor from the last frame
+            modifiers (list): Modifiers active during the event
+            button (int): Mouse Button that was pressed
+            buttons (list): Mouse Buttons that were pressed during the event
+        """
+        self.pos = pos
+        self.delta = delta
+        self.modifiers = modifiers
+        self.button = button
+        self.buttons = buttons
+
+def on_close(window):
+    pass
+
+def on_mouse_button(window, button, action, mod):
+    pos = glfw.get_cursor_pos(window)
+    
+    if button < 3:
+        button = BUTTONMAP.get(button, 0)
 
+    # TODO: Check if it is possible to detect multiple mouse button clicks in GLFW and populate buttons accordingly
+    # TODO: Implement delta, if needed
+    event = PseudoMouseEvent(pos, (0,0), p5.sketch.modifiers, button, [])
+    mev = MouseEvent(event, active = (action == glfw.PRESS))
 
+    p5.sketch._enqueue_event('mouse_pressed', mev)
+    
+def on_mouse_scroll(window, x_off, y_off):
+    pass
+
+def on_mouse_motion(window, x, y):
+    builtins.mouse_x = x
+    builtins.mouse_y = y
+
+
+def on_key_press(window, key, scancode, action, mod):
+    pass
 
-    
+def on_key_char(window, text):
+    pass

p5/sketch/events.py

@@ -48,13 +48,12 @@ def __init__(self, buttons):
             MouseButtonEnum.RIGHT: 'RIGHT',
             MouseButtonEnum.MIDDLE: 'MIDDLE',
         }
-
         self._buttons = buttons
         self._button_names = [button_names[bt] for bt in self._buttons]
 
     @property
     def buttons(self):
-        self._button_names
+        return self._button_names
 
     def __eq__(self, other):
         button_map = {
@@ -191,7 +190,6 @@ class KeyEvent(Event):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-
         if self._raw.key is not None:
             self.key = Key(self._raw.key.name, self._raw.text)
         else:
@@ -235,19 +233,19 @@ class MouseEvent(Event):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-
         x, y = self._raw.pos
         x = max(min(builtins.width, x), 0)
         y = max(min(builtins.height, builtins.height - y), 0)
         dx, dy = self._raw.delta
 
-        if (self._raw.press_event is not None) and (
-                self._raw.last_event is not None):
-            px, py = self._raw.press_event.pos
-            cx, cy = self._raw.last_event.pos
-            self.change = Position(cx - px, cy - py)
-        else:
-            self.change = Position(0, 0)
+        # This is not needed as per #347
+        # if (self._raw.press_event is not None) and (
+        #         self._raw.last_event is not None):
+        #     px, py = self._raw.press_event.pos
+        #     cx, cy = self._raw.last_event.pos
+        #     self.change = Position(cx - px, cy - py)
+        # else:
+        #     self.change = Position(0, 0)
 
         self.x = max(min(builtins.width, x), 0)
         self.y = max(min(builtins.height, builtins.height - y), 0)
@@ -256,15 +254,15 @@ def __init__(self, *args, **kwargs):
         self.scroll = Position(int(dx), int(dy))
 
         self.count = self.scroll.y
-        self.button = MouseButton(self._raw.buttons)
-
+        self.button = MouseButton(self._raw.buttons + [self._raw.button])
+        
     def _update_builtins(self):
         builtins.pmouse_x = builtins.mouse_x
         builtins.pmouse_y = builtins.mouse_y
         builtins.mouse_x = self.x
         builtins.mouse_y = self.y
         builtins.mouse_is_pressed = self._active
-        builtins.mouse_is_dragging = (self.change == (0, 0))
+        # builtins.mouse_is_dragging = (self.change != (0, 0))
         builtins.mouse_button = self.button if self.pressed else None
 
     def __repr__(self):

test.py

@@ -7,14 +7,22 @@ def setup():
     p5.sketch.canvas.clear(skia.ColorWHITE)
     size(1000, 700)
     p5.renderer.render_rectangle(200, 300, 50, 50)
-    print("frame count", frame_count)
+    # print("frame count", frame_count)
     no_loop()
 
 def draw():
-    p5.renderer.render_circle(20,20, 30)
-    p5.renderer.render_circle(mouse_x, mouse_y, 30)
-    print("frame count", frame_count)
-
+    p5.renderer.render_circle(20,20, 80)
+    # print(mouse_x, mouse_y)
+    p5.renderer.render_circle(mouse_x, mouse_y, 80)
+    # print("frame count", frame_count)
 
+def mouse_pressed(event):
+    if mouse_button == 'LEFT':
+        redraw()
+    elif mouse_button == 'RIGHT':
+        loop()
+    elif mouse_button == 'MIDDLE':
+        print("middle button is pressed")
+        
 if __name__ == '__main__':
     run(renderer='skia',  frame_rate=60)