Skip to content

Interface: NeuroSurfaceViewerConfig ​

Defined in: NeuroSurfaceViewer.ts:104

Properties ​

ambientLightColor? ​

ts
optional ambientLightColor?: number;

Defined in: NeuroSurfaceViewer.ts:105


directionalLightColor? ​

ts
optional directionalLightColor?: number;

Defined in: NeuroSurfaceViewer.ts:106


directionalLightIntensity? ​

ts
optional directionalLightIntensity?: number;

Defined in: NeuroSurfaceViewer.ts:107


rotationSpeed? ​

ts
optional rotationSpeed?: number;

Defined in: NeuroSurfaceViewer.ts:108


initialZoom? ​

ts
optional initialZoom?: number;

Defined in: NeuroSurfaceViewer.ts:109


ssaoRadius? ​

ts
optional ssaoRadius?: number;

Defined in: NeuroSurfaceViewer.ts:110


ssaoKernelSize? ​

ts
optional ssaoKernelSize?: number;

Defined in: NeuroSurfaceViewer.ts:111


rimStrength? ​

ts
optional rimStrength?: number;

Defined in: NeuroSurfaceViewer.ts:112


metalness? ​

ts
optional metalness?: number;

Defined in: NeuroSurfaceViewer.ts:114

PBR metalness for standard/physical surface materials; Phong surfaces ignore it.


roughness? ​

ts
optional roughness?: number;

Defined in: NeuroSurfaceViewer.ts:115


useShaders? ​

ts
optional useShaders?: boolean;

Defined in: NeuroSurfaceViewer.ts:116


showControls? ​

ts
optional showControls?: boolean;

Defined in: NeuroSurfaceViewer.ts:118

Deprecated ​

Pane UI is no longer part of the viewer runtime.


useControls? ​

ts
optional useControls?: boolean;

Defined in: NeuroSurfaceViewer.ts:120

Deprecated ​

Use the report mount controls or a ViewerPlugin.


controlType? ​

ts
optional controlType?: "surface" | "trackball";

Defined in: NeuroSurfaceViewer.ts:121


backgroundColor? ​

ts
optional backgroundColor?: number;

Defined in: NeuroSurfaceViewer.ts:122


preset? ​

ts
optional preset?: SurfViewStylePresetName;

Defined in: NeuroSurfaceViewer.ts:123


linkHemispheres? ​

ts
optional linkHemispheres?: boolean;

Defined in: NeuroSurfaceViewer.ts:124


hoverCrosshair? ​

ts
optional hoverCrosshair?: boolean;

Defined in: NeuroSurfaceViewer.ts:125


hoverCrosshairColor? ​

ts
optional hoverCrosshairColor?: number;

Defined in: NeuroSurfaceViewer.ts:126


hoverCrosshairSize? ​

ts
optional hoverCrosshairSize?: number;

Defined in: NeuroSurfaceViewer.ts:127


clickToAddAnnotation? ​

ts
optional clickToAddAnnotation?: boolean;

Defined in: NeuroSurfaceViewer.ts:128


allowCDNFallback? ​

ts
optional allowCDNFallback?: boolean;

Defined in: NeuroSurfaceViewer.ts:130

Deprecated ​

Runtime CDN loading is disabled and will be removed in v3.


useGPUPicking? ​

ts
optional useGPUPicking?: boolean;

Defined in: NeuroSurfaceViewer.ts:132

Use GPU-based picking for faster vertex selection on large meshes


headlight? ​

ts
optional headlight?: boolean;

Defined in: NeuroSurfaceViewer.ts:139

Hold the key and fill lights fixed relative to the camera (default true), so whichever side of the cortex faces the viewer is key-lit. false restores the world-fixed rig of earlier releases: key light at the preset's directionalPosition, fill at (-1, -0.5, -1).

Released under the MIT License.