BorgVR Guide

Illustrated guide

The BorgVR interface

From the first dataset to a saved result: this tour explains the control bar and the main tools using real app screenshots.

The screenshots show BorgVR 3.5 for macOS with its English interface and the built-in C60 and Visible Human examples. Each tool capture contains only the objects, measurements, or edits relevant to that example. The German version uses separate screenshots captured with the German app interface. iPhone, iPad, and Vision Pro arrange these tasks differently; their platform guides explain the corresponding gestures and windows.

1. Open a dataset

BorgVR start screen with Open Dataset, Import/Export, Settings, and Info
The start screen separates opening existing BorgVR data from importing other formats.
  1. Open Dataset / Datensatz öffnen: Opens the selector for built-in, local, and server-provided BorgVR datasets. Try the built-in C60 dataset first.
  2. Import / Export: Converts source data to BorgVR format or exports existing data. This is not the normal Open dialog.
  3. Settings / Einstellungen: Configures data sources, rendering, import, and automatic saving. The import/export buttons in the settings header transfer the entire configuration as a .borgvrsettings file.

2. Distinguish rendering from interaction

C60 rendering with the rendering modes above the seven interaction modes
The upper selector controls how the volume looks. The color-coded row below controls what interaction with the image changes.

Transfer Function, Transfer Function + Lighting, and Isovalue are rendering modes: they determine how the image is calculated. Model, Clipping, Transfer, Draw, Place, Measure, and Edit Volume are interaction modes: they determine what dragging or clicking does. Selecting an interaction mode does not automatically open its tool window.

Start with Model: drag to rotate the volume with an arcball, use the arrow keys to translate it in the image plane, and use a zoom gesture to change its size. Keyboard commands require focus on the rendering area.

3. Read the control bar

Detail of the grouped actions, individual reset buttons, interaction modes, and tool buttons
A detail from the same app capture. Each small reset arrow sits directly above its interaction mode.
Top icon groups
The X closes the dataset. On the right are SharePlay, the paired dataset-state save/restore buttons, recording, information/performance, and detach/hide controls. Additional actions depend on the session and settings.
Colors
Blue identifies Model, cyan Clipping, purple Transfer, orange Draw/Place, green Measure, and red volume editing. Color connects each mode to its targeted reset and tool. A highlighted tool button indicates an open window.
Open tools
Lighting and Editor open visualization tools. Objects belongs to Draw and Place, Measurements to Measure, and Brush to Edit Volume. The overlapping-rectangles icon on a panel detaches it into a separate window.

Reset only what you intend

The small arrows reset only their corresponding area and ask for confirmation. Model resets rotation, translation, and scale; Clipping removes the cuts; Transfer resets the current transfer function or isovalue. Draw and Place clear all objects, Measure clears all measurements, and Edit clears the active edit state. Draw and Place use the same object list.

4. Look inside with clipping planes

Two clipping planes expose internal structures in the built-in Visible Human dataset, without objects or measurements
Visible Human with two clipping planes: the flat cut faces reveal internal structures. No voxels were erased for this example; clipping changes only the visible region.
  1. Open the built-in Visible Human dataset and choose Transfer Function + Lighting. First use Model mode to rotate it into a suitable view.
  2. Switch to Clipping. Horizontal and vertical dragging move the view-aligned clipping planes. A zoom gesture moves the plane along the viewing direction.
  3. Return to Model to look at the exposed cut faces. The clipping planes remain fixed relative to the volume. Unlike brush editing, this requires no edit-state variant.

A small snap zone around zero makes it easier to unclip an axis. Move a plane back into this zone; only after moving beyond it does the opposite plane begin cutting. The small reset arrow above Clipping removes all cuts after confirmation, without deleting objects, measurements, or edits.

5. Adjust transfer function and lighting

Lighting preview sphere on the left and RGBA transfer-function editor at the bottom right
Lighting and the transfer function can be open together. The preview sphere shows the lighting, not the dataset.
  1. Select Transfer Function + Lighting and open Editor. The curve maps data values to color and opacity. R, G, and B select color components; A selects alpha/opacity. These letters do not select data channels.
  2. For multichannel data, also select the data channel. Each has its own transfer function. The C60 example has one channel, so this additional selector is not shown here.
  3. Open Lighting / Beleuchtung. Drag the preview sphere to change the light direction. The three color controls set ambient, diffuse, and specular light.
Light controls have no effect?Plain Transfer Function mode does not calculate lighting. Switch to Transfer Function + Lighting or Isovalue; the lighting editor warns about this distinction.

6. Inspect an isosurface

Isovalue rendering with its slider below the volume and the extraction icon beside the rendering-mode selector
C60 at isovalue 0.75: the higher threshold reveals an open, ring-like structure. Objects and measurements have been removed for this capture. The editor shows an isovalue slider instead of TF curves.

Choose Isovalue / Isowert and move the slider to reveal a different surface. On macOS, an additional export icon appears to the right of the rendering selector. It extracts the surface at the current value to an OBJ file; alternatively, press X with the rendering area focused. Extraction provides progress and cancellation.

7. Draw and place objects

Objects panel showing a named sphere and a stroke in the same list
Spheres, strokes, and placed polygon objects share the Objects list.
  1. Open Objects / Objekte. Use Active Object / Aktives Objekt to choose the built-in sphere or a known imported object asset.
  2. Select Place / Platzieren and click the rendering. Project onto Volume / Auf Volumen projizieren uses the visible volume depth for placement.
  3. Select Draw / Zeichnen and drag over the image to create a stroke. The screenshot contains both a sphere named Ring structure and a stroke.
  4. Select entries in the list to edit their names, color, and radius. The list supports multiple selection. Spheres can additionally display a direction.

Files / Dateien and Load / Laden load saved annotation collections, not new polygon assets. Save / Speichern writes the collection as a .marker file. Object import in the Import/Export dialog instead creates a new .mesh asset from OBJ or STL.

8. Measure lengths, areas, and volumes

Measurements window with a three-point path, its physical length, and individual point controls
Length is the sum of all segments. C60 is a molecular example, so the units here are picometers.
  1. Open Measurements / Messungen, select length, area, or volume, and activate Measure / Messen interaction mode.
  2. Place points in the rendering. A length needs at least two points and may contain multiple segments. An area needs three non-collinear points; further points project onto their plane. A volume needs at least four points that do not all lie in one plane.
  3. Areas and volumes use the points' convex hull. New Measurement / Neue Messung starts a separate entry. Point buttons select individual points; Delete Point removes that point, while Delete Measurement removes the selected entry.

BorgVR calculates using physical voxel spacing and chooses length, area, and volume units independently. Reliable physical dimensions depend on correct spacing in the dataset. Load and Save use .measurement files.

9. Edit a volume without changing the original

Before editing: the unchanged Visible Human with a separate demonstration edit state and a 3.92 cm brush radius
Before: Visible Human is unchanged and clipping is disabled. A separate edit state has been created for the example; no objects or measurements are present.
After editing: the spherical Erase brush has removed volume data at the forehead and temple of Visible Human
After, with the same view and transfer function: the spherical brush has removed regions at the forehead and temple. The cavities are part of the edited volume, not markers or measurements. The original remains unchanged.

Select Edit Volume and open Brush. Create a separate edit state with Plus, select Erase, set the radius, and drag over the volume. Here, Project onto Volume is enabled, so the brush starts at the visible surface. Use Restore to bring back original values locally; the small red reset arrow discards all edits in the active state after confirmation.

  • Erase / Löschen sets values inside the spherical brush to zero. Restore / Wiederherstellen brings back the original values. The radius is displayed in a physical unit appropriate to the dataset.
  • Plus creates a new edit state; the copy button duplicates the current one. Rename and Delete apply to the selected state. The original dataset file remains unchanged.
  • For multichannel volumes, the Brush panel lets you choose which data channels to edit. The screenshot shows a single-channel dataset.
  • A red dot on Edit means brick updates are still pending. Background work prioritizes fine resolution before coarse levels. The dot does not necessarily indicate network transfer.

Reopening an edit state may display Preparing Edit State. Cancel opens the dataset with edits still pending and continues the work in the background; it does not discard those edits. This is especially useful with remote data.

10. Save the right result

Dataset state
The tray with a downward arrow in the top bar saves transfer functions, objects, measurements, and view parameters under the dataset name. Its upward-arrow neighbor restores them. Existing files are not overwritten without confirmation.
Individual tools
Load/Save controls inside a tool manage transfer-function, object, or measurement files specifically. Use these to share measurements separately, for example.
Edited dataset
Edits are stored separately from the original. Export Edited Dataset / Bearbeiteten Datensatz exportieren in the Brush panel writes a standalone new .data file with the edits applied and a new dataset ID. This is different from Save Dataset State.
CollaborateSharePlay synchronizes shared visualization parameters, objects, measurements, and the shared edit state. Synchronize View can detach the local camera without separating those other data. See the platform guides for joining, dataset origins, and host changes.