Update options

- add PenType enum
- semi-auto-update other options

Author: AnthonyAndroulakis

docs/source/enums.rst

@@ -18,6 +18,11 @@ Enums
    :undoc-members:
    :show-inheritance:
 
+.. autoclass:: PenType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 .. autoclass:: ShowRender
    :members:
    :undoc-members:

scripts/generate_config_options.py

@@ -7,6 +7,7 @@
     _SNAKE_TO_CAMEL_OVERRIDES,
     DragMode,
     MultiplanarType,
+    PenType,
     ShowRender,
     SliceType,
 )
@@ -65,6 +66,7 @@ def generate_config_options(options: dict[str, typing.Any]):
         "from ipyniivue.constants import (",
         "    DragMode,",
         "    MultiplanarType,",
+        "    PenType,",
         "    ShowRender,",
         "    SliceType,",
         ")",
@@ -156,6 +158,7 @@ def generate_config_options(options: dict[str, typing.Any]):
         "fontColor": (0.5, 0.5, 0.5, 1.0),
         "selectionBoxColor": (1.0, 1.0, 1.0, 0.5),
         "clipPlaneColor": (0.7, 0.0, 0.7, 0.5),
+        "paqdUniforms": (0.3, 0.5, 0.5, 1.0),
         "clipThick": 2.0,
         "clipVolumeLow": (0.0, 0.0, 0.0),
         "clipVolumeHigh": (1.0, 1.0, 1.0),
@@ -183,11 +186,15 @@ def generate_config_options(options: dict[str, typing.Any]):
         "meshThicknessOn2D": float("inf"),
         "dragMode": DragMode.CONTRAST,
         "dragModePrimary": DragMode.CROSSHAIR,
+        # "mouseEventConfig": undefined, # not supported for
+        # now because right click on jupyter notebook is buggy
+        # "touchEventConfig": undefined,
         "yoke3Dto2DZoom": False,
         "isDepthPickMesh": False,
         "isCornerOrientationText": False,
         "isOrientationTextVisible": True,
-        "heroImageFraction": 0,
+        "showAllOrientationMarkers": False,
+        "heroImageFraction": 0.0,
         "heroSliceType": SliceType.RENDER,
         "sagittalNoseLeft": False,
         "isSliceMM": False,
@@ -199,6 +206,7 @@ def generate_config_options(options: dict[str, typing.Any]):
         "dragAndDropEnabled": True,
         "drawingEnabled": False,
         "penValue": 1.0,
+        "penType": PenType.PEN,
         "floodFillNeighbors": 6,
         "isFilledPen": False,
         "thumbnail": "",

src/ipyniivue/__init__.py

@@ -6,6 +6,7 @@
     ColormapType,
     DragMode,
     MultiplanarType,
+    PenType,
     ShowRender,
     SliceType,
 )

src/ipyniivue/config_options.py

@@ -8,6 +8,7 @@
 from ipyniivue.constants import (
     DragMode,
     MultiplanarType,
+    PenType,
     ShowRender,
     SliceType,
 )
@@ -36,6 +37,7 @@ class ConfigOptions(t.HasTraits):
     font_color = t.Tuple((0.5, 0.5, 0.5, 1.0)).tag(sync=False)
     selection_box_color = t.Tuple((1.0, 1.0, 1.0, 0.5)).tag(sync=False)
     clip_plane_color = t.Tuple((0.7, 0.0, 0.7, 0.5)).tag(sync=False)
+    paqd_uniforms = t.Tuple((0.3, 0.5, 0.5, 1.0)).tag(sync=False)
     clip_thick = t.Float(2.0).tag(sync=False)
     clip_volume_low = t.Tuple((0.0, 0.0, 0.0)).tag(sync=False)
     clip_volume_high = t.Tuple((1.0, 1.0, 1.0)).tag(sync=False)
@@ -71,7 +73,8 @@ class ConfigOptions(t.HasTraits):
     is_depth_pick_mesh = t.Bool(False).tag(sync=False)
     is_corner_orientation_text = t.Bool(False).tag(sync=False)
     is_orientation_text_visible = t.Bool(True).tag(sync=False)
-    hero_image_fraction = t.Int(0).tag(sync=False)
+    show_all_orientation_markers = t.Bool(False).tag(sync=False)
+    hero_image_fraction = t.Float(0.0).tag(sync=False)
     hero_slice_type = t.UseEnum(SliceType, default_value=SliceType.RENDER).tag(
         sync=False
     )
@@ -85,6 +88,7 @@ class ConfigOptions(t.HasTraits):
     drag_and_drop_enabled = t.Bool(True).tag(sync=False)
     drawing_enabled = t.Bool(False).tag(sync=False)
     pen_value = t.Float(1.0).tag(sync=False)
+    pen_type = t.UseEnum(PenType, default_value=PenType.PEN).tag(sync=False)
     flood_fill_neighbors = t.Int(6).tag(sync=False)
     is_filled_pen = t.Bool(False).tag(sync=False)
     thumbnail = t.Unicode("").tag(sync=False)
@@ -153,6 +157,7 @@ def __init__(self, parent=None, **kwargs):
         "font_color",
         "selection_box_color",
         "clip_plane_color",
+        "paqd_uniforms",
         "clip_thick",
         "clip_volume_low",
         "clip_volume_high",
@@ -184,6 +189,7 @@ def __init__(self, parent=None, **kwargs):
         "is_depth_pick_mesh",
         "is_corner_orientation_text",
         "is_orientation_text_visible",
+        "show_all_orientation_markers",
         "hero_image_fraction",
         "hero_slice_type",
         "sagittal_nose_left",
@@ -196,6 +202,7 @@ def __init__(self, parent=None, **kwargs):
         "drag_and_drop_enabled",
         "drawing_enabled",
         "pen_value",
+        "pen_type",
         "flood_fill_neighbors",
         "is_filled_pen",
         "thumbnail",
@@ -265,6 +272,7 @@ def _propagate_parent_change(self, change):
     "fontColor": "font_color",
     "selectionBoxColor": "selection_box_color",
     "clipPlaneColor": "clip_plane_color",
+    "paqdUniforms": "paqd_uniforms",
     "clipThick": "clip_thick",
     "clipVolumeLow": "clip_volume_low",
     "clipVolumeHigh": "clip_volume_high",
@@ -296,6 +304,7 @@ def _propagate_parent_change(self, change):
     "isDepthPickMesh": "is_depth_pick_mesh",
     "isCornerOrientationText": "is_corner_orientation_text",
     "isOrientationTextVisible": "is_orientation_text_visible",
+    "showAllOrientationMarkers": "show_all_orientation_markers",
     "heroImageFraction": "hero_image_fraction",
     "heroSliceType": "hero_slice_type",
     "sagittalNoseLeft": "sagittal_nose_left",
@@ -308,6 +317,7 @@ def _propagate_parent_change(self, change):
     "dragAndDropEnabled": "drag_and_drop_enabled",
     "drawingEnabled": "drawing_enabled",
     "penValue": "pen_value",
+    "penType": "pen_type",
     "floodFillNeighbors": "flood_fill_neighbors",
     "isFilledPen": "is_filled_pen",
     "thumbnail": "thumbnail",

src/ipyniivue/constants.py

@@ -10,6 +10,7 @@
     "ColormapType",
     "DragMode",
     "MultiplanarType",
+    "PenType",
     "ShowRender",
     "SliceType",
 ]
@@ -40,6 +41,25 @@ class SliceType(enum.Enum):
     RENDER = 4
 
 
+class PenType(enum.Enum):
+    """
+    An enumeration of pen types for drawing tools.
+
+    Members
+    -------
+    PEN : int
+        Standard pen (freehand drawing) (value 0).
+    RECTANGLE : int
+        Rectangle drawing mode (value 1).
+    ELLIPSE : int
+        Ellipse drawing mode (value 2).
+    """
+
+    PEN = 0
+    RECTANGLE = 1
+    ELLIPSE = 2
+
+
 class ShowRender(enum.Enum):
     """
     An enumeration for specifying when to show rendering in NiiVue instances.