Class: ReportSceneController

Defined in: report/ReportSceneController.ts:412

Owns the coordinated semantics that make a portable report scene different from an ordinary viewer: one displayed map and one explicit report view target. It never writes the pane-era selected layer or surface fields.

Constructors

Constructor

new ReportSceneController(
   viewer, 
   manifest, 
   options?
): ReportSceneController;

Defined in: report/ReportSceneController.ts:435

Parameters

viewer

NeuroSurfaceViewer

manifest

SurfViewSceneManifest

options?

ReportSceneControllerOptions = {}

Returns

ReportSceneController

Properties

options

readonly options: ReportSceneControllerOptions;

Defined in: report/ReportSceneController.ts:413

---

viewer

readonly viewer: NeuroSurfaceViewer;

Defined in: report/ReportSceneController.ts:436

---

manifest

readonly manifest: SurfViewSceneManifest;

Defined in: report/ReportSceneController.ts:437

Methods

getState()

getState(): ReportSceneControllerState;

Defined in: report/ReportSceneController.ts:509

Returns

ReportSceneControllerState

---

getAvailableLayerIds()

getAvailableLayerIds(): readonly string[];

Defined in: report/ReportSceneController.ts:539

Returns

readonly string[]

---

getViewTarget()

getViewTarget(): 
  | AnatomicalViewTargetRef
  | null;

Defined in: report/ReportSceneController.ts:548

Returns

| AnatomicalViewTargetRef | null

---

setDisplayedLayer()

setDisplayedLayer(layerId): ControlCommandResult;

Defined in: report/ReportSceneController.ts:567

Parameters

layerId

string

Returns

ControlCommandResult

---

updateReference()

updateReference(layerId, update): ControlCommandResult;

Defined in: report/ReportSceneController.ts:606

Update the reference across all report geometries as one command.

Parameters

layerId

string

update

visible?

boolean

opacity?

number

Returns

ControlCommandResult

---

setAnatomicalView()

setAnatomicalView(
   view, 
   target, 
   options?
): ControlCommandResult;

Defined in: report/ReportSceneController.ts:631

Parameters

view

AnatomicalView

target

AnatomicalViewTargetRef

options?

fit?

boolean

hemisphereGap?

number

Returns

ControlCommandResult

---

setFitInsets()

setFitInsets(insets): void;

Defined in: report/ReportSceneController.ts:703

Replace the overlay insets and refit the current framing.

Parameters

insets

ReportFitInsets

Returns

void

---

getBrainView()

getBrainView(): ReportBrainView | null;

Defined in: report/ReportSceneController.ts:709

Current whole-brain view, or null after free rotation or a split-layout view.

Returns

ReportBrainView | null

---

getLayout()

getLayout(): ReportLayout;

Defined in: report/ReportSceneController.ts:713

Returns

ReportLayout

---

setBrainView()

setBrainView(view, options?): ControlCommandResult;

Defined in: report/ReportSceneController.ts:718

Pose the report pair as one brain and frame it (anatomical layout only).

Parameters

view

ReportBrainView

options?

fit?

boolean

hemisphereGap?

number

Returns

ControlCommandResult

---

fitView()

fitView(): ControlCommandResult;

Defined in: report/ReportSceneController.ts:805

Returns

ControlCommandResult

---

resetView()

resetView(): ControlCommandResult;

Defined in: report/ReportSceneController.ts:827

Returns

ControlCommandResult

---

refreshGeometry()

refreshGeometry(): ControlCommandResult;

Defined in: report/ReportSceneController.ts:867

Re-place the report surfaces after their vertex positions changed in place (for example a switch between inflated and pial embeddings). A named view is re-posed and refitted with its original angle; after free rotation the surfaces keep their orientation and the reader's camera is left alone.

Returns

ControlCommandResult

---

resizeFit()

resizeFit(): void;

Defined in: report/ReportSceneController.ts:892

Returns

void

---

isDisposed()

isDisposed(): boolean;

Defined in: report/ReportSceneController.ts:899

Returns

boolean

---

dispose()

dispose(): void;

Defined in: report/ReportSceneController.ts:903

Returns

void