inclusion the ability to select widget x,y coordinates, update function is working

Author: jposada202020

adafruit_displayio_layout/widgets/cartesian.py

@@ -24,13 +24,13 @@
 # pylint: disable=too-many-lines, too-many-instance-attributes, too-many-arguments
 # pylint: disable=too-many-locals, too-many-statements
 
-
 import math
 import displayio
 import board
 import terminalio
 from adafruit_displayio_layout.widgets.widget import Widget
 from adafruit_displayio_layout.widgets import _blit_rotate_scale
+import vectorio
 
 try:
     import bitmaptools
@@ -41,53 +41,74 @@
 class Cartesian(Widget):
     """A cartesian widget.  The origin is set using ``x`` and ``y``.
 
-    :param int x: pixel position TODO
-    :param int y: pixel position TODO
+    :param int x: x position of the plane origin
+    :param int y: y position of the plane origin
+
+    :param int display_color: background color to use defaults to black (0x000000)
+    :param int width: requested width, in pixels defaults to screen width
+    :param int height: requested height, in pixels defaults to screen height
+
+    :param int axes_color: axes lines color defaults to white (0xFFFFFF)
+    :param int axes_stroke: axes lines thickness in pixels defaults to 2
+
+    :param int major_tick_stroke: tick lines thickness in pixels dafaults to 1
+    :param int major_tick_lenght: tick lines lenght in pixels defaults to 5
 
-    :param int width: requested width, in pixels TODO
-    :param int height: requested height, in pixels TODO
+    :param int tick_label_font: tick label text font
+    :param int tick_label_color: tick label text color
+
+    :param int pointer_radius: pointer radius in pixels defaults to 1
+    :param int pointer_color: pointer color defaults to white (0xFFFFFF)
 
     """
 
     def __init__(
         self,
+        x: int = 10,
+        y: int = board.DISPLAY.height - 10,
         display_color=0x000000,
         width: int = board.DISPLAY.width,
         height: int = board.DISPLAY.height,
-        axes_color=0xFFFFFF,
-        axes_stroke=2,
-        tick_color=0xFFFFFF,
-        major_tick_stroke=1,
-        major_tick_length=10,
+        axes_color: int = 0xFFFFFF,
+        axes_stroke: int = 2,
+        tick_color: int = 0xFFFFFF,
+        major_tick_stroke: int = 1,
+        major_tick_length: int = 5,
         tick_label_font=terminalio.FONT,
-        tick_label_color=0xFFFFFF,
+        tick_label_color: int = 0xFFFFFF,
+        pointer_radius: int = 1,
+        pointer_color: int = 0xFFFFFF,
         **kwargs,
-    ):
+    ) -> None:
 
         super().__init__(**kwargs, max_size=3)
+        self._origin_x = x
+        self._origin_y = y
 
         self._margin = 10
 
         self._display_color = display_color
-        self._display_width = width
-        self._display_height = height
+        self._widget_width = width
+        self._widget_height = height
 
         self._axes_line_color = axes_color
         self._axes_line_thickness = axes_stroke
 
         self._tick_color = tick_color
         self._tick_line_thickness = major_tick_stroke
         self._tick_line_height = major_tick_length
+
+        self._pointer_radius = pointer_radius
+        self._pointer_color = pointer_color
+
         self._font = tick_label_font
         self._font_color = tick_label_color
 
         self._font_width = self._get_font_height(self._font, 1)[0]
         self._font_height = self._get_font_height(self._font, 1)[1]
 
-        self._usable_width = self._display_width - self._font_width - 2 * self._margin
-        self._usable_height = (
-            self._display_height - self._font_height - 2 * self._margin
-        )
+        self._usable_width = self._widget_width - 2 * self._margin
+        self._usable_height = self._widget_height - 2 * self._margin
         self._tickx_separation = 2 * self._font_width + 2
 
         self._tick_bitmap = displayio.Bitmap(
@@ -106,11 +127,11 @@ def __init__(
         self._axesy_bitmap.fill(2)
 
         self._screen_bitmap = displayio.Bitmap(
-            self._usable_width, self._usable_height, 6
+            self._usable_width, self._usable_height, 3
         )
 
         self._screen_palette = displayio.Palette(6)
-        self._screen_palette[0] = 0x000000
+        self._screen_palette.make_transparent(0)
         self._screen_palette[1] = self._tick_color
         self._screen_palette[2] = self._axes_line_color
         self._screen_palette[3] = 0x00FFFF
@@ -120,12 +141,14 @@ def __init__(
         self._screen_tilegrid = displayio.TileGrid(
             self._screen_bitmap,
             pixel_shader=self._screen_palette,
-            x=self._margin + self._font_width,
-            y=self._margin,
+            x=self._origin_x,
+            y=self._origin_y,
         )
 
         self._draw_axes()
         self._draw_ticks()
+        self._draw_pointers()
+        self.append(self._pointer_vector_shape)
         self.append(self._screen_tilegrid)
 
     @staticmethod
@@ -141,7 +164,7 @@ def _get_font_height(font, scale):
     def _draw_axes(self):
         bitmaptools.rotozoom(
             self._screen_bitmap,
-            ox=self._margin - 1,
+            ox=self._margin,
             oy=self._usable_height,
             source_bitmap=self._axesx_bitmap,
             px=self._axesx_bitmap.width,
@@ -151,7 +174,7 @@ def _draw_axes(self):
 
         bitmaptools.rotozoom(
             self._screen_bitmap,
-            ox=int(self._usable_width - self._margin / 2),
+            ox=int(self._usable_width + self._margin),
             oy=self._usable_height,
             source_bitmap=self._axesy_bitmap,
             px=self._axesy_bitmap.width,
@@ -203,3 +226,28 @@ def _draw_ticks(self):
                     py=int(self._tick_bitmap.height / 2),
                     angle=(90 * math.pi / 180),  # in radians
                 )
+
+    def _draw_pointers(self):
+        self._pointer = vectorio.Circle(3)
+
+        self._circle_palette = displayio.Palette(2)
+        self._circle_palette.make_transparent(0)
+        self._circle_palette[1] = 0xFFFFFF
+
+        self._pointer_vector_shape = vectorio.VectorShape(
+            shape=self._pointer,
+            pixel_shader=self._circle_palette,
+            x=0,
+            y=0,
+        )
+
+    def update_pointer(self, x: int, y: int):
+        """updater_pointer function
+        helper function to update pointer in the plane
+        :param x: x coordinate in the local plane
+        :param y: y coordinate in the local plane
+        :return: None
+        rtype: None
+        """
+        self._pointer_vector_shape.x = self._origin_x + x + self._margin
+        self._pointer_vector_shape.y = self._origin_y + self._usable_height + y

examples/displayio_layout_cartesian_simpletest.py

@@ -6,6 +6,7 @@
 This is a basic demonstration of a Cartesian widget.
 """
 
+import time
 import board
 import displayio
 import terminalio
@@ -21,13 +22,15 @@
 
 # Create a Dial widget
 my_plane = Cartesian(
-    width=display.width,  # display width
-    height=display.height,  # display height
+    x=150,  # x position for the plane
+    y=100,  # y plane position
+    width=100,  # display width
+    height=100,  # display height
     axes_color=0xFFFFFF,  # axes line color
     axes_stroke=2,  # axes lines width in pixels
     tick_color=0xFFFFFF,  # ticks color
     major_tick_stroke=1,  # ticks width in pixels
-    major_tick_length=10,  # ticks length in pixels
+    major_tick_length=5,  # ticks length in pixels
     tick_label_color=0xFFFFFF,  # ticks line color
     tick_label_font=tick_font,  # the font used for the tick labels
 )
@@ -36,5 +39,10 @@
 my_group.append(my_plane)
 display.show(my_group)  # add high level Group to the display
 
+posx = 0
+posy = 0
+
 while True:
-    pass
+    my_plane.update_pointer(posx, posy)
+    display.show(my_group)
+    time.sleep(0.5)