Class: LabeledNeuroSurface

Defined in: src/LabeledNeuroSurface.ts:14

Surface that renders categorical labels (parcellations / clusters) per vertex. Each vertex holds an integer label id; a label table provides names and colors.

Extends

• NeuroSurface

Constructors

Constructor

new LabeledNeuroSurface(
   geometry, 
   indices, 
   labels, 
   labelDefs, 
   config?): LabeledNeuroSurface;

Defined in: src/LabeledNeuroSurface.ts:19

Parameters

geometry

SurfaceGeometry

indices

Uint32Array<ArrayBufferLike> | number[] | null

labels

Uint32Array<ArrayBufferLike> | number[]

labelDefs

LabelDefinition[]

config?

SurfaceConfig = {}

Returns

LabeledNeuroSurface

Overrides

NeuroSurface.constructor

Properties

labels

labels: Uint32Array;

Defined in: src/LabeledNeuroSurface.ts:15

---

labelMap

labelMap: Map<number, {
  name: string;
  color: Color;
}>;

Defined in: src/LabeledNeuroSurface.ts:16

---

colors

colors: Float32Array;

Defined in: src/LabeledNeuroSurface.ts:17

---

geometry

geometry: SurfaceGeometry;

Defined in: src/classes.ts:263

Inherited from

NeuroSurface.geometry

---

indices

indices: Uint32Array;

Defined in: src/classes.ts:264

Inherited from

NeuroSurface.indices

---

data

data: Float32Array;

Defined in: src/classes.ts:265

Inherited from

NeuroSurface.data

---

vertexCurv

vertexCurv: Float32Array<ArrayBufferLike> | null;

Defined in: src/classes.ts:266

Inherited from

NeuroSurface.vertexCurv

---

mesh

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

Defined in: src/classes.ts:267

Inherited from

NeuroSurface.mesh

---

threshold

threshold: [number, number];

Defined in: src/classes.ts:268

Inherited from

NeuroSurface.threshold

---

irange

irange: [number, number];

Defined in: src/classes.ts:269

Inherited from

NeuroSurface.irange

---

hemisphere

hemisphere: string;

Defined in: src/classes.ts:270

Inherited from

NeuroSurface.hemisphere

---

config

config: Required<SurfaceConfig>;

Defined in: src/classes.ts:271

Inherited from

NeuroSurface.config

---

viewer?

optional viewer?: any;

Defined in: src/classes.ts:272

Inherited from

NeuroSurface.viewer

Methods

on()

on(event, listener): UnsubscribeFn;

Defined in: src/EventEmitter.ts:12

Parameters

event

string

listener

EventListener

Returns

UnsubscribeFn

Inherited from

NeuroSurface.on

---

once()

once(event, listener): UnsubscribeFn;

Defined in: src/EventEmitter.ts:23

Parameters

event

string

listener

EventListener

Returns

UnsubscribeFn

Inherited from

NeuroSurface.once

---

emit()

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

Defined in: src/EventEmitter.ts:34

Parameters

event

string

args

...any[]

Returns

void

Inherited from

NeuroSurface.emit

---

removeListener()

removeListener(event, listenerToRemove): void;

Defined in: src/EventEmitter.ts:41

Parameters

event

string

listenerToRemove

EventListener

Returns

void

Inherited from

NeuroSurface.removeListener

---

removeAllListeners()

removeAllListeners(event?): void;

Defined in: src/EventEmitter.ts:52

Parameters

event?

string

Returns

void

Inherited from

NeuroSurface.removeAllListeners

---

off()

off(event, listener): void;

Defined in: src/EventEmitter.ts:61

Parameters

event

string

listener

EventListener

Returns

void

Inherited from

NeuroSurface.off

---

getLabelName()

getLabelName(id): string | undefined;

Defined in: src/LabeledNeuroSurface.ts:39

Parameters

id

number

Returns

string | undefined

---

setLabelColor()

setLabelColor(id, color): void;

Defined in: src/LabeledNeuroSurface.ts:43

Parameters

id

number

color

ColorRepresentation

Returns

void

---

setLabels()

setLabels(labels): void;

Defined in: src/LabeledNeuroSurface.ts:51

Parameters

labels

Uint32Array<ArrayBufferLike> | number[]

Returns

void

---

addOrUpdateLabel()

addOrUpdateLabel(def): void;

Defined in: src/LabeledNeuroSurface.ts:56

Parameters

def

LabelDefinition

Returns

void

---

createMesh()

createMesh(): Mesh;

Defined in: src/LabeledNeuroSurface.ts:61

Returns

Mesh

Overrides

NeuroSurface.createMesh

---

updateColors()

updateColors(): void;

Defined in: src/LabeledNeuroSurface.ts:84

Returns

void

Overrides

NeuroSurface.updateColors

---

update()

update(property, value): void;

Defined in: src/classes.ts:317

Parameters

property

string

value

any

Returns

void

Inherited from

NeuroSurface.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

// 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

NeuroSurface.updateConfig

---

getPickMetadata()

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

Defined in: src/classes.ts:438

Parameters

_vertexIndex

number

Returns

Record<string, unknown> | null

Inherited from

NeuroSurface.getPickMetadata

---

setVisible()

setVisible(visible): void;

Defined in: src/classes.ts:445

Parameters

visible

boolean

Returns

void

Inherited from

NeuroSurface.setVisible

---

setOpacity()

setOpacity(opacity): void;

Defined in: src/classes.ts:453

Parameters

opacity

number

Returns

void

Inherited from

NeuroSurface.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

// 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

NeuroSurface.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

// 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

NeuroSurface.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

NeuroSurface.createSmoothedCopy

---

updateMesh()

updateMesh(): Mesh;

Defined in: src/classes.ts:584

Returns

Mesh

Inherited from

NeuroSurface.updateMesh

---

dispose()

dispose(): void;

Defined in: src/classes.ts:605

Returns

void

Inherited from

NeuroSurface.dispose