Skip to content

Interface: ParcelPuzzleViewOptions ​

Defined in: puzzle/ParcelPuzzleView.ts:19

Extends ​

Properties ​

separation? ​

ts
optional separation?: number;

Defined in: puzzle/ParcelPuzzle.ts:10

Fractional expansion of parcel centers about the whole mesh center. Default 0.04.

Inherited from ​

ParcelPuzzleOptions.separation


relief? ​

ts
optional relief?: number;

Defined in: puzzle/ParcelPuzzle.ts:12

Local curvature/thickness scale along each parcel's mean normal: 0.15–1. Default 1.

Inherited from ​

ParcelPuzzleOptions.relief


hoverLift? ​

ts
optional hoverLift?: number;

Defined in: puzzle/ParcelPuzzle.ts:14

Hover displacement in mesh units. Default 4% of the mesh radius.

Inherited from ​

ParcelPuzzleOptions.hoverLift


selectionLift? ​

ts
optional selectionLift?: number;

Defined in: puzzle/ParcelPuzzle.ts:16

Extra clearance in front of the assembled brain on selection. Default 12% of radius.

Inherited from ​

ParcelPuzzleOptions.selectionLift


color? ​

ts
optional color?: (parcel) => ColorRepresentation;

Defined in: puzzle/ParcelPuzzle.ts:17

Parameters ​

parcel ​

Readonly<ParcelRecord>

Returns ​

ColorRepresentation

Inherited from ​

ParcelPuzzleOptions.color


renderDetail? ​

ts
optional renderDetail?: ParcelDetailRenderer;

Defined in: puzzle/ParcelPuzzleView.ts:20


labelText? ​

ts
optional labelText?: (parcel) => string;

Defined in: puzzle/ParcelPuzzleView.ts:22

Display label only; the original ParcelRecord and ID remain unchanged.

Parameters ​

parcel ​

Readonly<ParcelRecord>

Returns ​

string


reducedMotion? ​

ts
optional reducedMotion?: boolean;

Defined in: puzzle/ParcelPuzzleView.ts:24

Follow the system preference by default.


view? ​

ts
optional view?: "lateral" | "medial" | "oblique";

Defined in: puzzle/ParcelPuzzleView.ts:25


background? ​

ts
optional background?: number;

Defined in: puzzle/ParcelPuzzleView.ts:30

Clear colour of the puzzle stage as 0xRRGGBB. Defaults to 0xf0f3f4. Also sets --sv-parcel-puzzle-background on the puzzle element so the chrome matches the canvas.


previewBackground? ​

ts
optional previewBackground?: number;

Defined in: puzzle/ParcelPuzzleView.ts:35

Clear colour of the selected-piece preview as 0xRRGGBB. Defaults to 0xedf1f2. Also sets --sv-parcel-puzzle-preview-background on the puzzle element.


thickness? ​

ts
optional thickness?: number;

Defined in: puzzle/buildParcelPuzzle.ts:16

Display thickness in mesh coordinate units, not an anatomical thickness estimate.

Inherited from ​

ParcelPuzzleOptions.thickness


backgroundLabel? ​

ts
optional backgroundLabel?: number;

Defined in: puzzle/buildParcelPuzzle.ts:18

Vertices with this label are omitted. Defaults to 0.

Inherited from ​

ParcelPuzzleOptions.backgroundLabel

Released under the MIT License.