Class: VariantSurface

Defined in: src/VariantSurface.ts:16

A multi-layer surface that can switch between multiple geometric embeddings (e.g., pial, white, inflated) that share the same topology and data indices.

Extends

MultiLayerNeuroSurface

Constructors

Constructor

new VariantSurface(surfaceSet, config?): VariantSurface;

Defined in: src/VariantSurface.ts:21

Parameters

surfaceSet

SurfaceSet

config?

MultiLayerSurfaceConfig = {}

Returns

VariantSurface

Overrides

MultiLayerNeuroSurface.constructor

Properties

layerStack

layerStack: LayerStack;

Defined in: src/MultiLayerNeuroSurface.ts:137

Inherited from

MultiLayerNeuroSurface.layerStack

compositeBuffer

compositeBuffer: Float32Array;

Defined in: src/MultiLayerNeuroSurface.ts:138

Inherited from

MultiLayerNeuroSurface.compositeBuffer

vertexCount

vertexCount: number;

Defined in: src/MultiLayerNeuroSurface.ts:139

Inherited from

MultiLayerNeuroSurface.vertexCount

clipPlanes

readonly clipPlanes: ClipPlaneSet;

Defined in: src/MultiLayerNeuroSurface.ts:147

Clip plane set for surface clipping

Inherited from

MultiLayerNeuroSurface.clipPlanes

surfaceSet

surfaceSet: SurfaceSet;

Defined in: src/VariantSurface.ts:17

geometry

geometry: SurfaceGeometry;

Defined in: src/classes.ts:263

Inherited from

MultiLayerNeuroSurface.geometry

indices

indices: Uint32Array;

Defined in: src/classes.ts:264

Inherited from

MultiLayerNeuroSurface.indices

data

data: Float32Array;

Defined in: src/classes.ts:265

Inherited from

MultiLayerNeuroSurface.data

vertexCurv

vertexCurv: Float32Array<ArrayBufferLike> | null;

Defined in: src/classes.ts:266

Inherited from

MultiLayerNeuroSurface.vertexCurv

mesh

mesh: 
  | Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material | Material[], Object3DEventMap>
  | null;

Defined in: src/classes.ts:267

Inherited from

MultiLayerNeuroSurface.mesh

threshold

threshold: [number, number];

Defined in: src/classes.ts:268

Inherited from

MultiLayerNeuroSurface.threshold

irange

irange: [number, number];

Defined in: src/classes.ts:269

Inherited from

MultiLayerNeuroSurface.irange

hemisphere

hemisphere: string;

Defined in: src/classes.ts:270

Inherited from

MultiLayerNeuroSurface.hemisphere

config

config: Required<SurfaceConfig>;

Defined in: src/classes.ts:271

Inherited from

MultiLayerNeuroSurface.config

viewer?

optional viewer?: any;

Defined in: src/classes.ts:272

Inherited from

MultiLayerNeuroSurface.viewer

Methods

on()

on(event, listener): UnsubscribeFn;

Defined in: src/EventEmitter.ts:12

Parameters

event

string

once()

once(event, listener): UnsubscribeFn;

Defined in: src/EventEmitter.ts:23

Parameters

event

string

listener

EventListener

Returns

UnsubscribeFn

Inherited from

MultiLayerNeuroSurface.once

emit()

emit(event, ...args): void;

Defined in: src/EventEmitter.ts:34

Parameters

event

string

args

...any[]

Returns

void

Inherited from

MultiLayerNeuroSurface.emit

removeListener()

removeListener(event, listenerToRemove): void;

Defined in: src/EventEmitter.ts:41

Parameters

event

string

listenerToRemove

EventListener

Returns

void

Inherited from

MultiLayerNeuroSurface.removeListener

removeAllListeners()

removeAllListeners(event?): void;

Defined in: src/EventEmitter.ts:52

Parameters

event?

string

Returns

void

Inherited from

MultiLayerNeuroSurface.removeAllListeners

off()

off(event, listener): void;

Defined in: src/EventEmitter.ts:61

Parameters

event

string

listener

EventListener

Returns

void

Inherited from

MultiLayerNeuroSurface.off

toggleWireframe()

toggleWireframe(enabled): void;

Defined in: src/MultiLayerNeuroSurface.ts:216

Toggle a simple edge wireframe for debugging/presentation. Creates if missing.

Parameters

enabled

boolean

Returns

void

Inherited from

MultiLayerNeuroSurface.toggleWireframe

updateOutlineResolution()

updateOutlineResolution(
   width, 
   height, 
   dpr?): void;

Defined in: src/MultiLayerNeuroSurface.ts:430

Parameters

width

number

height

number

dpr?

number = 1

Returns

void

Inherited from

MultiLayerNeuroSurface.updateOutlineResolution

requestColorUpdate()

requestColorUpdate(): void;

Defined in: src/MultiLayerNeuroSurface.ts:447

Request a color update (throttled)

Returns

void

Inherited from

MultiLayerNeuroSurface.requestColorUpdate

addLayer()

addLayer(layer): void;

Defined in: src/MultiLayerNeuroSurface.ts:462

Add a layer to the surface

Parameters

layer

Layer

Returns

void

Inherited from

MultiLayerNeuroSurface.addLayer

addTwoDataLayer()

addTwoDataLayer(
   id, 
   dataX, 
   dataY, 
   colorMap?, 
   config?): TwoDataLayer;

Defined in: src/MultiLayerNeuroSurface.ts:512

Add a 2D data layer that maps two scalar fields to a 2D colormap.

This is a convenience method for creating TwoDataLayer instances.

Parameters

id

string

Layer identifier

dataX

Float32Array<ArrayBufferLike> | number[]

First scalar field (X axis of colormap)

dataY

Float32Array<ArrayBufferLike> | number[]

Second scalar field (Y axis of colormap)

colorMap?

ColorMap2D | ColorMap2DPreset

2D colormap preset name or ColorMap2D instance

config?

TwoDataLayerConfig = {}

Layer configuration options

Returns

TwoDataLayer

Example

typescript

// Visualize effect size vs. confidence
surface.addTwoDataLayer(
  'effect-confidence',
  effectSizeData,
  confidenceData,
  'confidence',
  {
    rangeX: [-2, 2],
    rangeY: [0, 1],
    thresholdY: [0, 0.05]  // Hide low-confidence values
  }
);

Inherited from

MultiLayerNeuroSurface.addTwoDataLayer

addParcelValueLayer()

addParcelValueLayer(
   id, 
   parcelData, 
   vertexLabels, 
   colorMap?, 
   config?): ParcelValueLayer;

Defined in: src/MultiLayerNeuroSurface.ts:530

Add a parcel-native value layer.

Parcel values are expanded to vertices using the provided per-vertex parcel labels.

Parameters

id

string

parcelData

ParcelData

vertexLabels

| Uint32Array<ArrayBufferLike> | Int32Array<ArrayBufferLike> | number[]

colorMap?

string = 'viridis'

config?

ParcelValueLayerConfig = {}

Returns

ParcelValueLayer

Inherited from

MultiLayerNeuroSurface.addParcelValueLayer

getTwoDataLayer()

getTwoDataLayer(id): TwoDataLayer | undefined;

Defined in: src/MultiLayerNeuroSurface.ts:545

Get a TwoDataLayer by ID (type-safe convenience method)

Parameters

id

string

Returns

TwoDataLayer | undefined

Inherited from

MultiLayerNeuroSurface.getTwoDataLayer

removeLayer()

removeLayer(id): boolean;

Defined in: src/MultiLayerNeuroSurface.ts:553

Remove a layer by ID

Parameters

id

string

Returns

boolean

Inherited from

MultiLayerNeuroSurface.removeLayer

clearLayers()

clearLayers(options?): void;

Defined in: src/MultiLayerNeuroSurface.ts:581

Remove all non-base layers (optionally including base).

Parameters

options?

ClearLayersOptions = {}

Returns

void

Inherited from

MultiLayerNeuroSurface.clearLayers

updateLayer()

updateLayer(id, updates): void;

Defined in: src/MultiLayerNeuroSurface.ts:596

Update a layer's properties

Parameters

id

string

updates

Record<string, any>

Returns

void

Inherited from

MultiLayerNeuroSurface.updateLayer

updateLayerData()

updateLayerData(
   id, 
   data, 
   indices?): void;

Defined in: src/MultiLayerNeuroSurface.ts:607

Parameters

id

string

data

Float32Array<ArrayBufferLike> | number[]

indices?

Uint32Array<ArrayBufferLike> | number[] | null

Returns

void

Inherited from

MultiLayerNeuroSurface.updateLayerData

updateLayerVisibility()

updateLayerVisibility(id, visible): void;

Defined in: src/MultiLayerNeuroSurface.ts:611

Parameters

id

string

visible

boolean

Returns

void

Inherited from

MultiLayerNeuroSurface.updateLayerVisibility

getLayer()

getLayer(id): Layer | undefined;

Defined in: src/MultiLayerNeuroSurface.ts:618

Get a layer by ID

Parameters

id

string

Returns

Layer | undefined

Inherited from

MultiLayerNeuroSurface.getLayer

setCurvature()

setCurvature(curvature, options?): void;

Defined in: src/MultiLayerNeuroSurface.ts:629

Set curvature data for display as underlay. Creates curvature layer if it doesn't exist.

Parameters

curvature

Float32Array<ArrayBufferLike> | number[]

Curvature values per vertex

options?

Display options (brightness, contrast, smoothness)

brightness?

number

contrast?

number

smoothness?

number

Returns

void

Inherited from

MultiLayerNeuroSurface.setCurvature

getCurvatureLayer()

getCurvatureLayer(): CurvatureLayer | undefined;

Defined in: src/MultiLayerNeuroSurface.ts:654

Get the curvature layer if it exists

Returns

CurvatureLayer | undefined

Inherited from

MultiLayerNeuroSurface.getCurvatureLayer

showCurvature()

showCurvature(visible): void;

Defined in: src/MultiLayerNeuroSurface.ts:664

Toggle curvature visibility. When curvature is shown, the base layer is hidden (curvature acts as the underlay). When curvature is hidden, the base layer is shown.

Parameters

visible

boolean

Returns

void

Inherited from

MultiLayerNeuroSurface.showCurvature

setClipPlane()

setClipPlane(
   axis, 
   distance, 
   enabled?, 
   flip?): void;

Defined in: src/MultiLayerNeuroSurface.ts:700

Set a clip plane by axis.

Parameters

axis

ClipAxis

Which axis to clip ('x', 'y', or 'z')

distance

number

Distance from origin along axis

enabled?

boolean = true

Whether to enable (default: true)

flip?

boolean = false

Flip clipping direction (default: false)

Returns

void

Example

// Clip at x=0 (midline sagittal cut)
surface.setClipPlane('x', 0);

// Clip right hemisphere only
surface.setClipPlane('x', 0, true, true);

Inherited from

MultiLayerNeuroSurface.setClipPlane

enableClipPlane()

enableClipPlane(axis): void;

Defined in: src/MultiLayerNeuroSurface.ts:714

Enable a clip plane.

Parameters

axis

ClipAxis

Returns

void

Inherited from

MultiLayerNeuroSurface.enableClipPlane

disableClipPlane()

disableClipPlane(axis): void;

Defined in: src/MultiLayerNeuroSurface.ts:723

Disable a clip plane.

Parameters

axis

ClipAxis

Returns

void

Inherited from

MultiLayerNeuroSurface.disableClipPlane

clearClipPlanes()

clearClipPlanes(): void;

Defined in: src/MultiLayerNeuroSurface.ts:732

Clear all clip planes (disable all).

Returns

void

Inherited from

MultiLayerNeuroSurface.clearClipPlanes

getClipPlane()

getClipPlane(axis): ClipPlane;

Defined in: src/MultiLayerNeuroSurface.ts:741

Get a clip plane by axis.

Parameters

axis

ClipAxis

Returns

ClipPlane

Inherited from

MultiLayerNeuroSurface.getClipPlane

setLayerOrder()

setLayerOrder(ids): void;

Defined in: src/MultiLayerNeuroSurface.ts:781

Set the order of layers (bottom to top)

Parameters

ids

string[]

Returns

void

Inherited from

MultiLayerNeuroSurface.setLayerOrder

updateLayers()

updateLayers(updates): void;

Defined in: src/MultiLayerNeuroSurface.ts:789

Batch update multiple layers

Parameters

updates

LayerUpdate[]

Returns

void

Inherited from

MultiLayerNeuroSurface.updateLayers

updateColors()

updateColors(): void;

Defined in: src/MultiLayerNeuroSurface.ts:965

Composite all layers and update mesh colors

Returns

void

Inherited from

MultiLayerNeuroSurface.updateColors

createMesh()

createMesh(): Mesh;

Defined in: src/MultiLayerNeuroSurface.ts:1233

Create mesh with proper material settings

Returns

Mesh

Inherited from

MultiLayerNeuroSurface.createMesh

setCompositingMode()

setCompositingMode(useGPU): void;

Defined in: src/MultiLayerNeuroSurface.ts:1280

Switch compositing mode between CPU and GPU

Parameters

useGPU

boolean

Returns

void

Inherited from

MultiLayerNeuroSurface.setCompositingMode

setWideLines()

setWideLines(useWide): void;

Defined in: src/MultiLayerNeuroSurface.ts:1338

Parameters

useWide

boolean

Returns

void

Inherited from

MultiLayerNeuroSurface.setWideLines

getCompositingMode()

getCompositingMode(): "CPU" | "GPU";

Defined in: src/MultiLayerNeuroSurface.ts:1355

Get current compositing mode

Returns

"CPU" | "GPU"

Inherited from

MultiLayerNeuroSurface.getCompositingMode

currentVariant()

currentVariant(): string;

Defined in: src/VariantSurface.ts:32

Returns

string

variantNames()

variantNames(): string[];

Defined in: src/VariantSurface.ts:36

Returns

string[]

setVariant()

setVariant(name, options?): void;

Defined in: src/VariantSurface.ts:40

Parameters

name

string

options?

VariantTransitionOptions = {}

Returns

void

dispose()

dispose(): void;

Defined in: src/VariantSurface.ts:103

Dispose of all resources

Returns

void

Overrides

MultiLayerNeuroSurface.dispose

update()

update(property, value): void;

Defined in: src/classes.ts:317

Parameters

property

string

value

any

Returns

void

Inherited from

MultiLayerNeuroSurface.update

updateConfig()

updateConfig(newConfig): void;

Defined in: src/classes.ts:342

Update surface material properties dynamically

Parameters

newConfig

Partial<SurfaceConfig>

Partial configuration object with properties to update

Returns

void

Example

javascript

// Make surface shiny and semi-transparent
surface.updateConfig({
  shininess: 150,
  specularColor: 0xffffff,
  alpha: 0.7
});

// Switch to flat shading for faceted look
surface.updateConfig({ flatShading: true });

Inherited from

MultiLayerNeuroSurface.updateConfig

getPickMetadata()

getPickMetadata(_vertexIndex): Record<string, unknown> | null;

Defined in: src/classes.ts:438

Parameters

_vertexIndex

number

Returns

Record<string, unknown> | null

Inherited from

MultiLayerNeuroSurface.getPickMetadata

setVisible()

setVisible(visible): void;

Defined in: src/classes.ts:445

Parameters

visible

boolean

Returns

void

Inherited from

MultiLayerNeuroSurface.setVisible

setOpacity()

setOpacity(opacity): void;

Defined in: src/classes.ts:453

Parameters

opacity

number

Returns

void

Inherited from

MultiLayerNeuroSurface.setOpacity

setSmoothShading()

setSmoothShading(smooth, smoothingAngle?): void;

Defined in: src/classes.ts:473

Control surface shading style (visual only, doesn't modify geometry)

Parameters

smooth

boolean

If true, uses smooth shading (interpolated normals). If false, uses flat shading (face normals)

smoothingAngle?

number

Optional angle threshold in degrees (0-180). Edges above this angle remain sharp

Returns

void

Example

javascript

// Enable smooth shading for organic surfaces
surface.setSmoothShading(true);

// Smooth shading with 30° threshold (sharp edges preserved)
surface.setSmoothShading(true, 30);

// Flat shading for faceted/crystalline look
surface.setSmoothShading(false);

Inherited from

MultiLayerNeuroSurface.setSmoothShading

applyLaplacianSmoothing()

applyLaplacianSmoothing(
   iterations?, 
   lambda?, 
   method?, 
   preserveBoundaries?): void;

Defined in: src/classes.ts:509

Apply Laplacian smoothing to the surface vertices (modifies geometry)

Parameters

iterations?

number = 1

Number of smoothing iterations (1-10). More iterations = smoother surface

lambda?

number = 0.5

Smoothing strength (0-1). 0 = no effect, 1 = maximum smoothing per iteration

method?

"laplacian" | "taubin"

Smoothing algorithm:

'laplacian': Standard smoothing, may shrink surface
'taubin': Alternates shrink/expand to preserve volume

preserveBoundaries?

boolean = true

If true, boundary edges remain fixed

Returns

void

Example

javascript

// Gentle smoothing to reduce noise
surface.applyLaplacianSmoothing(2, 0.3, 'laplacian', true);

// Aggressive smoothing while preserving volume
surface.applyLaplacianSmoothing(5, 0.5, 'taubin', true);

// Smooth including boundaries (may distort edges)
surface.applyLaplacianSmoothing(3, 0.4, 'laplacian', false);

Inherited from

MultiLayerNeuroSurface.applyLaplacianSmoothing

createSmoothedCopy()

createSmoothedCopy(
   iterations?, 
   lambda?, 
   method?): SurfaceGeometry;

Defined in: src/classes.ts:559

Create a smoothed copy of this surface

Parameters

iterations?

number = 1

Number of smoothing iterations

lambda?

number = 0.5

Smoothing factor 0-1

method?

"laplacian" | "taubin"

'laplacian' or 'taubin'

Returns

SurfaceGeometry

A new smoothed surface geometry

Inherited from

MultiLayerNeuroSurface.createSmoothedCopy

updateMesh()

updateMesh(): Mesh;

Defined in: src/classes.ts:584

Returns

Mesh

Inherited from

MultiLayerNeuroSurface.updateMesh

Class: VariantSurface ​

Extends ​

Constructors ​

Constructor ​

Parameters ​

surfaceSet ​

config? ​

Returns ​

Overrides ​

Properties ​

layerStack ​

Inherited from ​

compositeBuffer ​

Inherited from ​

vertexCount ​

Inherited from ​

clipPlanes ​

Inherited from ​

surfaceSet ​

geometry ​

Inherited from ​

indices ​

Inherited from ​

data ​

Inherited from ​

vertexCurv ​

Inherited from ​

mesh ​

Inherited from ​

threshold ​

Inherited from ​

irange ​

Inherited from ​

hemisphere ​

Inherited from ​

config ​

Inherited from ​

viewer? ​

Inherited from ​

Methods ​

on() ​

Parameters ​

event ​

listener ​

Returns ​

Inherited from ​

once() ​

Parameters ​

event ​

listener ​

Returns ​

Inherited from ​

emit() ​

Parameters ​

event ​

args ​

Returns ​

Inherited from ​

removeListener() ​

Parameters ​

event ​

listenerToRemove ​

Returns ​

Inherited from ​

removeAllListeners() ​

Parameters ​

event? ​

Returns ​

Inherited from ​

off() ​

Parameters ​

event ​

listener ​

Returns ​

Inherited from ​

toggleWireframe() ​

Parameters ​

enabled ​

Returns ​

Inherited from ​

Class: VariantSurface

Extends

Constructors

Constructor

Parameters

surfaceSet

config?

Returns

Overrides

Properties

layerStack

Inherited from

compositeBuffer

Inherited from

vertexCount

Inherited from

clipPlanes

Inherited from

surfaceSet

geometry

Inherited from

indices

Inherited from

data

Inherited from

vertexCurv

Inherited from

mesh

Inherited from

threshold

Inherited from

irange

Inherited from

hemisphere

Inherited from

config

Inherited from

viewer?

Inherited from

Methods

on()

Parameters

event

listener

Returns

Inherited from

once()

Parameters

event

listener

Returns

Inherited from

emit()

Parameters

event

args

Returns

Inherited from

removeListener()

Parameters

event

listenerToRemove

Returns

Inherited from

removeAllListeners()

Parameters

event?

Returns

Inherited from

off()

Parameters

event

listener

Returns

Inherited from

toggleWireframe()

Parameters

enabled

Returns

Inherited from