Scripting Editor

The Volvicon Python scripting editor enables you to create, execute, and debug scripts that extend Volvicon with custom filters, plugins, and workflow automation. It allows you to prototype algorithms, interact with the Scripting API, and perform batch operations, all within the Volvicon environment.

Starlit Moonlight Theme	Blue Theme

Editor Layout

• Code editor pane: Monospace, fixed-pitch view with syntax highlighting, line numbers, and no soft wrapping.
• Output console: Read-only console below the editor for stdout/stderr. Success output is shown in green; errors are shown in red with optional friendly formatting for common argument/type issues.
• Splitter: Drag to resize the editor/console ratio.
• Status and busy indicator: Status text reports actions (load, save, font changes, run results). A busy spinner shows while a script is executing.
• Find/replace panel: Collapsible panel beneath the toolbar for search operations.

Toolbar Controls

Control	Action	Shortcut
New	Start a blank script; prompts to save unsaved changes.	—
Open	Load a .py file.	—
Save	Save to the current file.	—
Save As	Save to a new .py file.	—
Undo	Undo last change.	Ctrl+Z
Redo	Redo last undone change.	Ctrl+Shift+Z
Run	Execute the current script asynchronously.	Ctrl+R
Stop	Interrupt a running script.	Ctrl+Shift+R
Find	Show the find panel.	Ctrl+F
Find & Replace	Show find/replace panel.	Ctrl+H
Clear Console	Clear console output.	—
Templates	Insert predefined code templates or open the tutorials folder.	—

Code Templates

Insert starter snippets from the Templates menu:

1. Getting Started: Create an Application, show messages, and request user confirmation.
2. Volume Operations: Inspect dimensions, origin, spacing, and import/export volumes.
3. Mask Operations: List masks/volumes, create masks, run thresholding, and import/export masks.
4. Surface Operations: Create primitives, import/export meshes, and apply smoothing/reduction/subdivision.
5. AI Segmentation: Configure TotalSegmentator, install models if needed, and run inference on a volume.
6. Project Management: List project objects, check active selections, and open/save/close projects.

A menu option opens the on-disk documentation/scripts/tutorials folder if present.

Editing Aids

• Python-aware syntax highlighting with keywords, built-ins, imports, strings, comments, numbers, classes, functions, decorators, and bracket coloring.
• Code completion driven by Volvicon API metadata; trigger with Ctrl+Space or after typing .. Selected completions insert directly into the editor.
• Call-signature tooltips highlight the active parameter while typing function calls.
• Hover tooltips for API objects/functions when metadata is available.
• Current-line highlight plus optional matching-bracket and current-word highlighting to reduce navigation errors.
• Toggle comments for the current selection or line (Ctrl+/).
• Auto-indentation for new lines; Tab/Shift+Tab indents or dedents selections. A "Format Indentation" action (Ctrl+Alt+I) cleans Python indentation for selected text or the whole file.
• Zoom In/Out (Ctrl+=/Ctrl++ and Ctrl+-) adjusts font size for both editor and console; zoom is also available from the context menu.
• Fixed 4-space tab stops for predictable alignment.

Search and Navigation

• Find/Replace panels: Accessible from toolbar or shortcuts; find is available with Ctrl+F, replace with Ctrl+H.
• Find Next: F3 or Ctrl+G repeats the last search.
• Line numbers: Always visible in the margin for quick navigation.
• Word selection: Selecting a word highlights other occurrences in view.

Execution and Console Behavior

• Scripts run asynchronously so the UI stays responsive; Stop interrupts execution.
• Console captures stdout/stderr. Successful results append in green; failures append in red with optional enriched guidance (argument count/type hints) when error formatting is enabled.
• The editor emits start/finish signals for integrations; status text reports "Script succeeded" or "Script failed".
• Clear Console resets the output view; running again appends new output.

Context Menu

Right-click in the editor to access:

• Undo, Redo
• Cut, Copy, Paste, Delete
• Toggle Comment (Ctrl+/)
• Format Indentation (Ctrl+Alt+I)
• Find, Find & Replace
• Zoom In, Zoom Out
• Select All

File Handling and Input

• Drag-and-drop a .py file onto the editor to load it.
• New/Open prompt to save unsaved work before clearing or replacing content.
• Default font is Consolas, fixed-pitch, 10pt; line wrap is disabled for code clarity.

Practical Uses

• Automate repetitive project tasks (batch segmentation, exports).
• Prototype custom filters or measurements using the Scripting API and Volvicon data structures.
• Build repeatable pipelines that combine volume, mask, surface, and AI operations within Volvicon.