BorgVR Guide

iPhone & iPad

BorgVR Mobile

Explore multi-channel volume data with touch, draw, place objects, measure, and collaborate through SharePlay.

Mandelbulb volume

Edit volume

Dataset export is disabled during SharePlay. While an export is running, edits and edit-state changes are blocked, including through MCP. If SharePlay starts during an export, that export is cancelled before the shared edit state is installed.

If saved edit states exist, BorgVR asks which one to use before opening a dataset normally. Original stays unchanged. The last personal state is preselected; the trash button deletes one state after confirmation. The Brush panel lets you select, create, duplicate, and rename states.

Pending volume updates in the selected edit state are completed automatically before opening. BorgVR shows progress when needed; no additional choice is required. Export and preparation share the same exact bottom-up rebuilding service with Metal acceleration when available and a CPU fallback.

SharePlay uses a separate shared edit state initialized from the host's selected state. Joining receives its complete mask without overwriting personal states. State selection is locked during a session. Erase/restore cursors and brush operations are shared. Leaving restores the previous personal selection; the shared work remains available as a separate SharePlay state.

Edit states are stored beside the .data file in its .data.edits companion folder; only built-in datasets use private app storage. Remote datasets use the local dataset directory. Discard All Edits restores only the active state to the original after confirmation; other saved states are preserved. During SharePlay, this clears the shared state for all participants.

Select the red eraser in the mode bar. The separate red Brush button below opens and closes the Brush sheet; changing modes does not open it automatically. There, choose Erase or Restore, adjust the radius, and optionally enable Project onto Volume. Tap or drag in the rendering view; a pinch gesture changes the brush radius in edit mode. Without projection, a vertical two-finger gesture moves the brush depth plane.

A small red dot in the top-right corner of the Edit Volume button indicates pending background brick updates. It disappears once calculation and saving have finished.

Export Edited Dataset opens a dialog for the name and description. During calculation it displays progress; Cancel stops the export and removes incomplete export files. Afterwards, choose the save location. The name and description are stored in the new dataset. Export preserves the source compression and copies unchanged bricks without decompressing or recompressing them.

Erase sets every channel inside the sphere to zero; Restore brings back the original values. The original file is preserved. Edits are saved locally and reapplied on reopening, and are shared within a separate state during SharePlay. Export Edited Dataset saves the current state as a new .data file with its own ID.

Opening a dataset

Progressive Loading controls whether the normal Open dialog downloads everything first or starts rendering immediately. Keep a Local Copy separately controls persistence during streaming. Remote datasets announced through SharePlay open progressively even when the pre-download option is selected. Normal opening tries the selected server before alternate origins; passwords are stored locally in the Keychain.

Deleting in the dataset selector removes the local .data file and all its edit variants in .data.edits after confirmation. Separate annotation and view files remain. Data and Edit States explains downloading, backups, variant management, export, and the differences between closing, resetting, and deleting.

The main menu offers four routes: open a dataset, import source data, change settings, or view app information. Layout follows the available width, adapting to iPhone, iPad, and foldable devices such as iPhone Duo. Wide layouts show settings categories and content side by side.

  1. Choose a local BorgVR file or open the catalog of a configured server.
  2. Remote datasets can load progressively and may optionally be retained as a local copy.
  3. If a stored source cannot be reached, BorgVR searches other known origins for the same dataset ID.
Compact interfaceOn small displays, the dataset list and rendering controls can be collapsed. Rendering modes use icons when their full labels do not fit.

Touch interaction

The interaction selector determines what gestures in the rendering area modify.

Model
Drag rotates the volume with an arcball interaction. Pinch zooms. Two-finger gestures translate the volume.
Clipping
Gestures move or rotate the clipping plane instead of the volume.
Transfer
Direct dragging shapes the active transfer-function curve; the complete editor remains available through Editor.
Drawing
Dragging creates a spatial stroke. With Project onto Volume, BorgVR uses depth from the previous raycasting frame and smooths depth along the stroke.
Placement
A tap places the active sphere or imported polygon object, while dragging moves a selection. Placement can project onto the visible volume surface.
Measurement
A tap places or selects points for length, area, and volume measurements. Measurement points can also optionally project onto the volume surface.

Rendering controls

The dataset name is dark red and italic while its data source still depends on the server. Complete local caching restores regular type and black text in light appearance; both colors are lighter in dark appearance. Without a local copy, the title remains red and italic. An image already on screen does not mean all bricks are local.

The top controls select rendering and interaction modes. On narrow layouts, recognizable symbols replace labels that would not fit. Transfer-function, isovalue, and lighting editors appear as bottom sheets; pressing the same button closes an open sheet.

  • Multi-channel datasets have up to four separate transfer functions. Select the data channel in the editor and edit its RGBA curves.
  • The lighting editor changes light direction and ambient, diffuse, and specular colors and previews the result on a sphere.
  • Separate buttons open Objects and Measurements. Highlighting indicates which tool window or sheet is already open.
  • The close button returns to dataset selection.
  • Info shows metadata, dataset ID, and up to three alternate origins, including password and private-sharing indicators.
  • Log and brick visualization are diagnostic features and appear only after being enabled in Settings.
  • If the local HTTPS web server is active and contains the dataset, the link button copies a directly shareable WebGPU URL.

Managing objects and measurements

The Objects window contains the active object asset plus every sphere, stroke, and placed mesh instance. Imported .mesh files automatically appear beside the built-in sphere. The list supports multiple selection, applying shared edits to all selected entries.

The Measurements window creates paths with any number of segments, planar convex areas, and convex volumes. Measurement points can be moved or removed, and BorgVR displays results in an automatically selected physical unit.

Load and Save use .marker and .measurement files respectively. Local files and server catalogs appear in the selectors; multiple files without their own UUID remain separate entries. Saving refreshes the list immediately.

Dataset state

The two state buttons save or load transfer functions, objects, measurements, transform, rendering mode, isovalue, lighting, clipping, and visibility under the current dataset name. Existing files are overwritten only after confirmation.

SharePlay

The SharePlay button starts or detects a shared session. On joining, the device receives the current dataset and state. If the dataset cannot yet be found, BorgVR displays a waiting state and automatically tries new participant origins.

With Synchronize View enabled, the local camera follows the common view shared by iPhone, iPad, and Mac participants. Disable it to work independently; rendering mode, transfer functions, isovalue, lighting, clipping, objects, and measurements remain shared. Enabling it again immediately adopts the common view.

Participants exchange known origins that are allowed to be shared. A device with a complete local copy can offer the host dataset through a temporary ad-hoc server. While no origin is reachable, the waiting view displays the server currently being tried and restarts loading after new catalog or origin announcements.

When a client closes the dataset, BorgVR asks for confirmation and can leave SharePlay. When the host closes it, clients enter a locked waiting state with an option to leave SharePlay.

Import and settings

Simplifying the user interface

Under Settings → User Interface, choose visible rendering and interaction modes. At least one mode of each kind remains enabled; a selector with only one mode disappears. RGB/RGBA rendering is unaffected. Hide the reset row and the panel-button row, or hide individual panel buttons. Diagnostic controls are configured here as well. Preferences stay local and are included in settings export and import. This simplifies the UI rather than restricting SharePlay or automation access. On visionOS, Muse and PSVR retain their independent tool modes.

If SharePlay activates a locally hidden rendering mode, it temporarily appears selected and disabled in the selector, even when only one local mode is allowed. The extra entry disappears when a locally allowed mode becomes active again; preferences remain unchanged. On macOS and iOS, TF/isovalue, object, measurement, and brush panel buttons require their associated interaction modes; the object button remains available for either drawing or placement. Lighting stays independent. On visionOS, panel buttons remain independent of hand modes so Muse and PSVR can still use them.

Import converts supported DICOM, NRRD/NHDR, PVM, and QVIS data. Brick size, overlap, border handling, and compression only affect newly created BorgVR files.

  • Background plus automatic loading and saving of transfer functions, objects, measurements, and dataset state
  • Static or dynamic oversampling
  • Remote servers with connection test and sharing rule
  • Loading timeout, progressive loading, and local copy
  • Local dataset, ad-hoc, and WebGPU servers plus the independent MCP server
  • LOD, atlas, and hash-table parameters
  • SharePlay display name and update checks
  • Clear dataset-origin cache