BorgVR Guide

Mac

BorgVR for macOS

The complete desktop workspace for local and remote volume data, dockable tools, markers, scripts, and collaboration.

Mandelbulb volume

Workflow

  1. Open a local BorgVR file, a recent dataset, or a remote-server catalog from the main menu.
  2. Select rendering and interaction modes in the render window. Dragging rotates the model with an arcball; trackpad or mouse gestures translate and scale it.
  3. Open only the tools you need and dock them to the render window or detach them into separate windows.

A recent dataset that is no longer reachable is checked only when opened. BorgVR then reports the error without delaying the start screen with speculative network checks.

Render window and dockable tools

The top control bar contains close, SharePlay, participants, WebGPU link, dataset info, optional log, performance graph, and docking. Rendering mode, interaction mode, reset, editor, and markers appear below.

Rendering controls
May overlay the image, dock to the window, or live in a separate window.
TF/isovalue editor
Automatically follows the rendering mode and can dock beside the rendering area.
Marker window
List, multiple selection, name, color, radius, direction display, loading, and saving.
Performance
Shows frame rate, timing history, and periods using a reduced sampling rate for diagnostics.

Interaction modes

  • Model: Arcball rotation, translation, and scaling of the volume.
  • Clipping: Manipulation of the clipping plane.
  • Transfer: Direct manipulation of the transfer-function curve in the rendering area.
  • Marker: Place, select, and drag markers. Scrolling or a vertical two-finger gesture moves the selection in depth.

Selecting a marker automatically switches to marker mode. Multiple selection allows common color, size, and direction changes.

Import, local files, and servers

The integrated converter creates BorgVR files from DICOM, NRRD/NHDR, and QVIS. The GUI server utility and command-line converter are also available for repeated or server-side conversion.

Remote servers are configured with hostname, port, and optional password. The connection test reports available datasets and transfer functions. Timeout, progressive loading, and retaining a local copy apply to all remote sources.

The Mac can run its own native dataset server and HTTPS WebGPU server. A button in the rendering window copies a dataset-specific browser link once the active dataset is available through that server.

SharePlay

Mac, iPhone, and iPad use a common view state by default. Synchronize View detaches or reattaches the Mac without removing rendering parameters and markers from the session. Reattaching adopts the current shared view.

The host announces the dataset ID, its ad-hoc address, and known shareable origins. Every participant merges these into its origin cache and may advertise a local copy in turn. This allows a reachable client to provide data when the host is behind a firewall.

Scripting

The macOS app supports GSC scripts for reproducible interaction, rendering parameters, and screenshots. Example files and command definitions are available in the repository under Scripts/.

Reproducible resultsCombine scripts, saved transfer functions, and marker files when views for publications or presentations must be recreated precisely.

Settings

The sidebar separates data sources, rendering, import, LOD, local server, SharePlay, and miscellaneous options. Common settings appear first; atlas sizes, hash tables, oversampling strategy, and other expert parameters are kept in the advanced area.

  • Automatic transfer-function loading and saving
  • Solid or gradient background
  • Static and dynamic oversampling
  • Randomized sample phase
  • Brick visualization and log button
  • Remote loading and local copies
  • Local and ad-hoc servers
  • App Store update checks