Class: OutlineLayer

Defined in: src/OutlineLayer.ts:22

Geometry-based layer that draws ROI boundaries as line segments. This layer does not participate in color compositing; it renders its own THREE.Line objects that are attached to the surface mesh.

Extends

• Layer

Constructors

Constructor

new OutlineLayer(id, options): OutlineLayer;

Defined in: src/OutlineLayer.ts:34

Parameters

id

string

options

OutlineLayerOptions

Returns

OutlineLayer

Overrides

Layer.constructor

Properties

roiLabels

roiLabels: Uint32Array;

Defined in: src/OutlineLayer.ts:23

---

color

color: number;

Defined in: src/OutlineLayer.ts:24

---

width

width: number;

Defined in: src/OutlineLayer.ts:25

---

halo

halo: boolean;

Defined in: src/OutlineLayer.ts:26

---

haloColor

haloColor: number;

Defined in: src/OutlineLayer.ts:27

---

haloWidth

haloWidth: number;

Defined in: src/OutlineLayer.ts:28

---

offset

offset: number;

Defined in: src/OutlineLayer.ts:29

---

roiSubset

roiSubset: number[] | null;

Defined in: src/OutlineLayer.ts:30

---

lineObject

lineObject: Object3D<Object3DEventMap> | null = null;

Defined in: src/OutlineLayer.ts:31

---

haloObject

haloObject: Object3D<Object3DEventMap> | null = null;

Defined in: src/OutlineLayer.ts:32

---

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

getRGBAData()

getRGBAData(vertexCount): Float32Array;

Defined in: src/OutlineLayer.ts:66

Outline layers do not contribute to the color composite. Return a zeroed buffer to satisfy the abstract interface.

Parameters

vertexCount

number

Returns

Float32Array

Overrides

Layer.getRGBAData

---

update()

update(update): void;

Defined in: src/OutlineLayer.ts:70

Update layer data Must be implemented by subclasses

Parameters

update

OutlineLayerUpdate

Returns

void

Overrides

Layer.update

---

toStateJSON()

toStateJSON(): Record<string, unknown>;

Defined in: src/OutlineLayer.ts:97

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

Returns

Record<string, unknown>

Overrides

Layer.toStateJSON

---

dispose()

dispose(): void;

Defined in: src/OutlineLayer.ts:110

Returns

void

Overrides

Layer.dispose

---

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