Feat(options): Complete ConfigOptions

Finish options for [email protected]

Author: AnthonyAndroulakis

examples/mesh_layers.ipynb

@@ -44,7 +44,7 @@
    "outputs": [],
    "source": [
     "nv = NiiVue(\n",
-    "    show_3d_crosshair=True, back_color=(1, 1, 1, 1), mesh_x_ray=0.3, is_colorbar=True\n",
+    "    show_3d_crosshair=True, back_color=(1, 1, 1, 1), mesh_xray=0.3, is_colorbar=True\n",
     ")\n",
     "\n",
     "mesh_layer = {\n",

examples/prototypes/meshes_(GIfTI, FreeSurfer, MZ3, OBJ, STL, legacy VTK).ipynb

@@ -40,7 +40,7 @@
    "source": [
     "# based on https://github.com/niivue/ipyniivue/blob/main/original_gallery.md#meshes-gifti-freesurfer-mz3-obj-stl-legacy-vtk\n",
     "nv = NiiVue(\n",
-    "    show_3d_crosshair=True, back_color=(1, 1, 1, 1), mesh_x_ray=0.3, is_colorbar=True\n",
+    "    show_3d_crosshair=True, back_color=(1, 1, 1, 1), mesh_xray=0.3, is_colorbar=True\n",
     ")\n",
     "\n",
     "nv.load_meshes(\n",
@@ -59,7 +59,11 @@
    ]
   }
  ],
- "metadata": {},
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
  "nbformat": 4,
  "nbformat_minor": 4
 }

scripts/generate_config_options.py

@@ -6,6 +6,7 @@
 from ipyniivue.constants import (
     _SNAKE_TO_CAMEL_OVERRIDES,
     DragMode,
+    DragModePrimary,
     MultiplanarType,
     ShowRender,
     SliceType,
@@ -61,7 +62,13 @@ def generate_config_options(options: dict[str, typing.Any]):
         '"""Defines a class for NiiVue configuration options."""',
         "",
         "import traitlets as t",
-        "from .constants import DragMode, MultiplanarType, ShowRender, SliceType",
+        "from ipyniivue.constants import (",
+        "    DragMode,",
+        "    DragModePrimary,",
+        "    MultiplanarType,",
+        "    ShowRender,",
+        "    SliceType,",
+        ")",
         "",
         '__all__ = ["ConfigOptions", "CAMEL_TO_SNAKE", "SNAKE_TO_CAMEL"]',
         "",
@@ -135,16 +142,22 @@ def generate_config_options(options: dict[str, typing.Any]):
     DEFAULT_OPTIONS = {
         "textHeight": 0.06,
         "colorbarHeight": 0.05,
-        "crosshairWidth": 1,
-        "crosshairGap": 0,
-        "rulerWidth": 4,
+        "colorbarWidth": -1.0,
+        "showColorbarBorder": True,
+        "crosshairWidth": 1.0,
+        "crosshairWidthUnit": "voxels",
+        "crosshairGap": 0.0,
+        "rulerWidth": 4.0,
         "show3Dcrosshair": False,
-        "backColor": (0, 0, 0, 1),
-        "crosshairColor": (1, 0, 0, 1),
-        "fontColor": (0.5, 0.5, 0.5, 1),
-        "selectionBoxColor": (1, 1, 1, 0.5),
-        "clipPlaneColor": (0.7, 0, 0.7, 0.5),
-        "rulerColor": (1, 0, 0, 0.8),
+        "backColor": (0.0, 0.0, 0.0, 1.0),
+        "crosshairColor": (1.0, 0.0, 0.0, 1.0),
+        "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),
+        "clipThick": 2.0,
+        "clipVolumeLow": (0.0, 0.0, 0.0),
+        "clipVolumeHigh": (1.0, 1.0, 1.0),
+        "rulerColor": (1.0, 0.0, 0.0, 0.8),
         "colorbarMargin": 0.05,
         "trustCalMinMax": True,
         "clipPlaneHotKey": "KeyC",
@@ -154,24 +167,29 @@ def generate_config_options(options: dict[str, typing.Any]):
         "keyDebounceTime": 50,
         "isNearestInterpolation": False,
         "isResizeCanvas": True,
-        "isAtlasOutline": False,
         "atlasOutline": 0.0,
         "isRuler": False,
         "isColorbar": False,
         "isOrientCube": False,
+        "tileMargin": 0.0,
         "multiplanarPadPixels": 0,
         "multiplanarForceRender": False,
+        "multiplanarEqualSize": False,
         "multiplanarShowRender": ShowRender.AUTO,
         "isRadiologicalConvention": False,
         "meshThicknessOn2D": float("inf"),
         "dragMode": DragMode.CONTRAST,
+        "dragModePrimary": DragModePrimary.CROSSHAIR,
         "yoke3Dto2DZoom": False,
         "isDepthPickMesh": False,
         "isCornerOrientationText": False,
+        "isOrientationTextVisible": True,
+        "heroImageFraction": 0,
+        "heroSliceType": SliceType.RENDER,
         "sagittalNoseLeft": False,
         "isSliceMM": False,
         "isV1SliceShader": False,
-        "isHighResolutionCapable": True,
+        "forceDevicePixelRatio": 0.0,
         "logLevel": "info",
         "loadingText": "loading ...",
         "isForceMouseClickToVoxelCenters": False,
@@ -194,12 +212,32 @@ def generate_config_options(options: dict[str, typing.Any]):
         "renderOverlayBlend": 1.0,
         "sliceMosaicString": "",
         "centerMosaic": False,
-        "gradientAmount": 0.0,
-        "gradientOpacity": 0.0,
-        "forceDevicePixelRatio": 0,
+        "penSize": 1.0,
+        "interactive": True,
         "clickToSegment": False,
+        "clickToSegmentRadius": 3.0,
+        "clickToSegmentBright": True,
         "clickToSegmentAutoIntensity": False,
+        "clickToSegmentIntensityMax": float("nan"),
+        "clickToSegmentIntensityMin": float("nan"),
+        "clickToSegmentPercent": 0.0,
+        "clickToSegmentMaxDistanceMM": float("inf"),
         "clickToSegmentIs2D": False,
+        "selectionBoxLineThickness": 4.0,
+        "selectionBoxIsOutline": False,
+        "scrollRequiresFocus": False,
+        "showMeasureUnits": True,
+        "measureTextJustify": "center",
+        "measureTextColor": (1.0, 0.0, 0.0, 1.0),
+        "measureLineColor": (1.0, 0.0, 0.0, 1.0),
+        "measureTextHeight": 0.03,
+        "isAlphaClipDark": False,
+        "gradientOrder": 1,
+        "gradientOpacity": 0.0,
+        "renderSilhouette": 0.0,
+        "gradientAmount": 0.0,
+        "invertScrollDirection": False,
+        "is2DSliceShader": False,
     }
     code = generate_config_options(DEFAULT_OPTIONS)
     loc = pathlib.Path(__file__).parent / "../src/ipyniivue/config_options.py"