Class: CurvatureLayer

Defined in: src/layers/CurvatureLayer.ts:47

Layer that displays mesh curvature as a grayscale underlay.

Curvature values are mapped to grayscale using: gray = clamp(curvature / smoothness, -0.5, 0.5) * contrast + brightness

Typical usage:

• Load curvature from FreeSurfer .curv file or compute from pial surface
• Display as underlay (order: -2, below base layer) to show sulci/gyri
• Works on any surface representation (folded, inflated, flat)

Example

const curvLayer = new CurvatureLayer('curv', curvatureData, {
  brightness: 0.5,
  contrast: 0.5,
  smoothness: 0.3
});
surface.addLayer(curvLayer);

Extends

• Layer

Constructors

Constructor

new CurvatureLayer(
   id, 
   curvature, 
   config?): CurvatureLayer;

Defined in: src/layers/CurvatureLayer.ts:54

Parameters

id

string

curvature

Float32Array<ArrayBufferLike> | number[]

config?

CurvatureConfig = {}

Returns

CurvatureLayer

Overrides

Layer.constructor

Properties

id

id: string;

Defined in: src/layers.ts:103

Inherited from

Layer.id

---

visible

visible: boolean;

Defined in: src/layers.ts:104

Inherited from

Layer.visible

---

opacity

opacity: number;

Defined in: src/layers.ts:105

Inherited from

Layer.opacity

---

blendMode

blendMode: BlendMode;

Defined in: src/layers.ts:106

Inherited from

Layer.blendMode

---

order

order: number;

Defined in: src/layers.ts:107

Inherited from

Layer.order

---

needsUpdate

needsUpdate: boolean;

Defined in: src/layers.ts:108

Inherited from

Layer.needsUpdate

---

_onChangeCallback

_onChangeCallback: (() => void) | null;

Defined in: src/layers.ts:110

Callback set by the parent surface to trigger re-compositing on change.

Inherited from

Layer._onChangeCallback

Methods

setVisible()

setVisible(visible): void;

Defined in: src/layers.ts:132

Parameters

visible

boolean

Returns

void

Inherited from

Layer.setVisible

---

setOpacity()

setOpacity(opacity): void;

Defined in: src/layers.ts:139

Parameters

opacity

number

Returns

void

Inherited from

Layer.setOpacity

---

setBlendMode()

setBlendMode(mode): void;

Defined in: src/layers.ts:147

Parameters

mode

BlendMode

Returns

void

Inherited from

Layer.setBlendMode

---

registerOutlineLayer()

static registerOutlineLayer(ctor): void;

Defined in: src/layers.ts:183

Parameters

ctor

any

Returns

void

Inherited from

Layer.registerOutlineLayer

---

registerTemporalLayer()

static registerTemporalLayer(ctor): void;

Defined in: src/layers.ts:187

Parameters

ctor

any

Returns

void

Inherited from

Layer.registerTemporalLayer

---

fromConfig()

static fromConfig(config): Layer;

Defined in: src/layers.ts:199

Create a concrete Layer instance from a plain object configuration. Supports: base, rgba, data, outline.

Parameters

config

Record<string, any>

Returns

Layer

Inherited from

Layer.fromConfig

---

setCurvature()

setCurvature(curvature): void;

Defined in: src/layers/CurvatureLayer.ts:76

Set new curvature data

Parameters

curvature

Float32Array<ArrayBufferLike> | number[]

Returns

void

---

getCurvature()

getCurvature(): Float32Array;

Defined in: src/layers/CurvatureLayer.ts:87

Get current curvature data

Returns

Float32Array

---

setBrightness()

setBrightness(brightness): void;

Defined in: src/layers/CurvatureLayer.ts:94

Set brightness (base gray level)

Parameters

brightness

number

Returns

void

---

setContrast()

setContrast(contrast): void;

Defined in: src/layers/CurvatureLayer.ts:103

Set contrast (curvature influence on brightness)

Parameters

contrast

number

Returns

void

---

setSmoothness()

setSmoothness(smoothness): void;

Defined in: src/layers/CurvatureLayer.ts:112

Set smoothness (curvature scaling factor)

Parameters

smoothness

number

Returns

void

---

getDisplayParams()

getDisplayParams(): object;

Defined in: src/layers/CurvatureLayer.ts:121

Get current display parameters

Returns

object

brightness

brightness: number;

contrast

contrast: number;

smoothness

smoothness: number;

---

getRGBAData()

getRGBAData(vertexCount): Float32Array;

Defined in: src/layers/CurvatureLayer.ts:132

Generate RGBA data for compositing

Parameters

vertexCount

number

Returns

Float32Array

Overrides

Layer.getRGBAData

---

update()

update(data): void;

Defined in: src/layers/CurvatureLayer.ts:168

Update layer properties

Parameters

data

CurvatureLayerUpdateData

Returns

void

Overrides

Layer.update

---

toStateJSON()

toStateJSON(): Record<string, unknown>;

Defined in: src/layers/CurvatureLayer.ts:192

Serialize common layer state for state persistence. Override in subclasses.

Returns

Record<string, unknown>

Overrides

Layer.toStateJSON

---

dispose()

dispose(): void;

Defined in: src/layers/CurvatureLayer.ts:205

Clean up resources

Returns

void

Overrides

Layer.dispose